Class HOTP`Abstract`

Hierarchy (view full)

HOTP
- TOTP

Index

Constructors

Methods

_toString generate toQRCodeURL toString verify

Constructors

constructor

new HOTP(): HOTP
Returns HOTP

Methods

`Static` `Protected` _toString

_toString(config, type, period?): string
Protected
Returns a URI representation of the config
Parameters
- config: HOTPConfig
- type: "totp" | "hotp"
- Optional period: number
Returns string

`Static` generate

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

`Static` toQRCodeURL

toQRCodeURL(config?, width?, height?): string
Returns a QR code URL that will provide a scalable QR code of the config
Parameters
- config: Partial<HOTPConfig> = {}
- width: number = 256
- height: number = 256
Returns string

`Static` toString

toString(config?): string
Returns a URI representation of the config
Parameters
- config: Partial<HOTPConfig> = {}
Returns string

`Static` verify

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