Update options object ts documentation

almasen · May 12, 2021 · 6da8845 · 6da8845
1 parent ca88f75
commit 6da8845
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 1 deletion.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,10 @@
 * CI workflow for automatic GitHub release generation
 * Updated some `dev-dependencies` to their newer versions as per [#5](https://github.com/almasen/n-digit-token/pull/5)
 
+### Changed
+
+* Minor documentation improvements regarding customisation options
+
 ## 2.0.3 - 2021-04-14
 
 ### Added

diff --git a/src/index.ts b/src/index.ts
@@ -224,7 +224,7 @@ const handleOptions = (secureBigIntToken: bigint, length: number, options?: Opti
  * This algorithm avoids modulo bias and runs in constant time for lengths <= 1000.
  *
  * By default the algorithm returns the token as string which may start with zeros.
- * This can be customised via the options object. Please consult the documentation if interested.
+ * This can be customised via the options object, please consult the documentation if interested.
  * @param {number} length desired token length
  * @param {Options} [options] options object (optional)
  * @param {string} [options.returnType='string'] desired return type (default=string)