Skip to content

Commit

Permalink
🤖 Merge PR DefinitelyTyped#66476 [semver]: update jsdoc comments for …
Browse files Browse the repository at this point in the history
…`inc` according to `ReleaseType` by @himanshurajora

The inc function supports multiple release types

```typescript
export type ReleaseType = 'major' | 'premajor' | 'minor' | 'preminor' | 'patch' | 'prepatch' | 'prerelease';
```

But in the comments, some of the supported types are still missing. It may lead to confusion whether or not this function provides those types, when only comments are read.
  • Loading branch information
himanshurajora authored Aug 28, 2023
1 parent 019cad1 commit 01da573
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion types/semver/functions/inc.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ declare namespace inc {
}

/**
* Return the version incremented by the release type (major, minor, patch, or prerelease), or null if it's not valid.
* Return the version incremented by the release type (major, premajor, minor, preminor, patch, prepatch, or prerelease), or null if it's not valid.
*/
declare function inc(
version: string | SemVer,
Expand Down

0 comments on commit 01da573

Please sign in to comment.