Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix: Update TOTP docstrings #2245

Merged
merged 2 commits into from
Jul 12, 2023
Merged

fix: Update TOTP docstrings #2245

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e5d3b8e
fix: Update TOTP docstrings
lahirumaramba Jul 12, 2023
2bd1dc6
Merge branch 'master' into lm-fix-totp-docs
lahirumaramba Jul 12, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions src/auth/user-record.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -255,7 +255,7 @@ export class PhoneMultiFactorInfo extends MultiFactorInfo {
}

/**
* TotpInfo struct associated with a second factor
* `TotpInfo` struct associated with a second factor
*/
export class TotpInfo {

Expand All @@ -267,12 +267,12 @@ export class TotpInfo {
export class TotpMultiFactorInfo extends MultiFactorInfo {

/**
* TotpInfo struct associated with a second factor
* `TotpInfo` struct associated with a second factor
*/
public readonly totpInfo: TotpInfo;

/**
* Initializes the TotpMultiFactorInfo object using the server side response.
* Initializes the `TotpMultiFactorInfo` object using the server side response.
*
* @param response - The server side response.
* @constructor
Expand All @@ -299,7 +299,7 @@ export class TotpMultiFactorInfo extends MultiFactorInfo {
*
* @param response - The server side response.
* @returns The multi-factor ID associated with the provided response. If the response is
* not associated with any known multi-factor ID, null is returned.
* not associated with any known multi-factor ID, `null` is returned.
*
* @internal
*/
Expand All @@ -315,12 +315,12 @@ export class MultiFactorSettings {

/**
* List of second factors enrolled with the current user.
* Currently only phone and totp second factors are supported.
* Currently only phone and TOTP second factors are supported.
*/
public enrolledFactors: MultiFactorInfo[];

/**
* Initializes the MultiFactor object using the server side or JWT format response.
* Initializes the `MultiFactor` object using the server side or JWT format response.
*
* @param response - The server side response.
* @constructor
Expand Down Expand Up @@ -380,7 +380,7 @@ export class UserMetadata {
public readonly lastRefreshTime?: string | null;

/**
* @param response - The server side response returned from the getAccountInfo
* @param response - The server side response returned from the `getAccountInfo`
* endpoint.
* @constructor
* @internal
Expand Down