fix: set options.window to number

epicweb-dev · Aug 2, 2023 · e83ceb3 · e83ceb3
1 parent 05a6d19
commit e83ceb3
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -193,8 +193,8 @@ will show you all this stuff, but just in case, here's that:
  * @param {number} [options.period] The number of seconds for the OTP to be valid.
  * @param {number} [options.digits] The length of the OTP.
  * @param {string} [options.algorithm] The algorithm to use.
- * @param [options.window] The number of OTPs to check before and after the
- * current OTP. Defaults to 1.
+ * @param {number} [options.window] The number of OTPs to check before and after
+ * the current OTP. Defaults to 1.
  *
  * @returns {{delta: number}|null} an object with "delta" which is the delta
  * between the current OTP and the OTP that was verified, or null if the OTP is

diff --git a/index.js b/index.js
@@ -171,8 +171,8 @@ export function getTOTPAuthUri({
  * @param {number} [options.period] The number of seconds for the OTP to be valid.
  * @param {number} [options.digits] The length of the OTP.
  * @param {string} [options.algorithm] The algorithm to use.
- * @param [options.window] The number of OTPs to check before and after the
- * current OTP. Defaults to 1.
+ * @param {number} [options.window] The number of OTPs to check before and after
+ * the current OTP. Defaults to 1.
  *
  * @returns {{delta: number}|null} an object with "delta" which is the delta
  * between the current OTP and the OTP that was verified, or null if the OTP is