Skip to content

Commit 2711858

Browse files
fix: Update TOTP docstrings (#2245)
1 parent 844600b commit 2711858

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

src/auth/user-record.ts

+7-7
Original file line numberDiff line numberDiff line change
@@ -255,7 +255,7 @@ export class PhoneMultiFactorInfo extends MultiFactorInfo {
255255
}
256256

257257
/**
258-
* TotpInfo struct associated with a second factor
258+
* `TotpInfo` struct associated with a second factor
259259
*/
260260
export class TotpInfo {
261261

@@ -267,12 +267,12 @@ export class TotpInfo {
267267
export class TotpMultiFactorInfo extends MultiFactorInfo {
268268

269269
/**
270-
* TotpInfo struct associated with a second factor
270+
* `TotpInfo` struct associated with a second factor
271271
*/
272272
public readonly totpInfo: TotpInfo;
273273

274274
/**
275-
* Initializes the TotpMultiFactorInfo object using the server side response.
275+
* Initializes the `TotpMultiFactorInfo` object using the server side response.
276276
*
277277
* @param response - The server side response.
278278
* @constructor
@@ -299,7 +299,7 @@ export class TotpMultiFactorInfo extends MultiFactorInfo {
299299
*
300300
* @param response - The server side response.
301301
* @returns The multi-factor ID associated with the provided response. If the response is
302-
* not associated with any known multi-factor ID, null is returned.
302+
* not associated with any known multi-factor ID, `null` is returned.
303303
*
304304
* @internal
305305
*/
@@ -315,12 +315,12 @@ export class MultiFactorSettings {
315315

316316
/**
317317
* List of second factors enrolled with the current user.
318-
* Currently only phone and totp second factors are supported.
318+
* Currently only phone and TOTP second factors are supported.
319319
*/
320320
public enrolledFactors: MultiFactorInfo[];
321321

322322
/**
323-
* Initializes the MultiFactor object using the server side or JWT format response.
323+
* Initializes the `MultiFactor` object using the server side or JWT format response.
324324
*
325325
* @param response - The server side response.
326326
* @constructor
@@ -380,7 +380,7 @@ export class UserMetadata {
380380
public readonly lastRefreshTime?: string | null;
381381

382382
/**
383-
* @param response - The server side response returned from the getAccountInfo
383+
* @param response - The server side response returned from the `getAccountInfo`
384384
* endpoint.
385385
* @constructor
386386
* @internal

0 commit comments

Comments
 (0)