Class TOTP`Abstract`

Hierarchy (View Summary)

HOTP
- TOTP

Index

Constructors

Methods

_toString generate toQRCodeURL toString verify

Constructors

constructor

new TOTP(): TOTP
Returns TOTP
Inherited from HOTP.constructor

Methods

`Protected` `Static`_toString

_toString(
    config: HOTP.Config<Secret>,
    type: "totp" | "hotp",
    period?: number,
): string
Protected
Returns a URI representation of the config
Parameters
- config: HOTP.Config<Secret>
- type: "totp" | "hotp"
- Optionalperiod: number
Returns string
Inherited from HOTP._toString

`Static`generate

generate(config?: Partial<TOTP.Config<string | Secret>>): [string, Secret]
Generates a TOTP token using the supplied configuration values
Parameters
- config: Partial<TOTP.Config<string | Secret>> = {}
Returns [string, Secret]
Overrides HOTP.generate

`Static`toQRCodeURL

toQRCodeURL(
    config?: Partial<TOTP.Config<string | Secret>>,
    width?: number,
    height?: number,
): string
Returns a QR code URL that will provide a scalable QR code of the config
Parameters
- config: Partial<TOTP.Config<string | Secret>> = {}
- width: number = 256
- height: number = 256
Returns string
Overrides HOTP.toQRCodeURL

`Static`toString

toString(config?: Partial<TOTP.Config<string | Secret>>): string
Returns a URI representation of the config
Parameters
- config: Partial<TOTP.Config<string | Secret>> = {}
Returns string
Overrides HOTP.toString

`Static`verify

verify(
otp: string | number,
config?: Partial<TOTP.Config<string | Secret>>,
): [boolean, null | number]
Verifies a TOTP token using the supplied configuration values
Parameters
- otp: string | number
- config: Partial<TOTP.Config<string | Secret>> = {}
Returns [boolean, null | number]
Overrides HOTP.verify