Skip to content

Commit 791fca2

Browse files
committed
adding description for totpsecret constructor
1 parent 187cb7a commit 791fca2

File tree

1 file changed

+7
-0
lines changed
  • packages/auth/src/platform_browser/mfa/assertions

1 file changed

+7
-0
lines changed

packages/auth/src/platform_browser/mfa/assertions/totp.ts

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,13 @@
2121
* @public
2222
*/
2323
export class TotpSecret {
24+
/**
25+
* Constructor for TotpSecret.
26+
* @param secretKey - Shared secret key/seed used for enrolling in TOTP MFA and generating otps.
27+
* @param hashingAlgorithm - Hashing algorithm used.
28+
* @param codeLength - Length of the one-time passwords to be generated.
29+
* @param codeIntervalSeconds - The interval (in seconds) when the OTP codes should change.
30+
*/
2431
constructor(
2532
readonly secretKey: string,
2633
readonly hashingAlgorithm: string,

0 commit comments

Comments
 (0)