Skip to content

Commit

Permalink
Merge pull request #3 from laserpants/patch-1
Browse files Browse the repository at this point in the history
Change positive to non-negative in documentation blocks
  • Loading branch information
4kimov committed Jul 17, 2023
2 parents f44a202 + af865c7 commit d33db79
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ export default class Sqids {
* - One of the numbers passed is smaller than `minValue()` or greater than `maxValue()`
* - A partition number is incremented so much that it becomes greater than `maxValue()`
*
* @param {array.<number>} numbers Positive integers to encode into an ID
* @param {array.<number>} numbers Non-negative integers to encode into an ID
* @returns {string} Generated ID
*/
encode(numbers: number[]): string {
Expand All @@ -97,7 +97,7 @@ export default class Sqids {
/**
* Internal function that encodes an array of unsigned integers into an ID
*
* @param {array.<number>} numbers Positive integers to encode into an ID
* @param {array.<number>} numbers Non-negative integers to encode into an ID
* @param {boolean} partitioned If true, the first number is always a throwaway number (used either for blocklist or padding)
* @returns {string} Generated ID
*/
Expand Down

0 comments on commit d33db79

Please sign in to comment.