@litert/otp

Appearance

Documents for @litert/otp / URL / IUrlInfoForTOTP

Interface: IUrlInfoForTOTP ​

Defined in: URL.ts:94

Extends ​

Properties ​

betterCompatibility? ​

optional betterCompatibility: boolean

Defined in: URL.ts:31

Do not escape '=' in the key/secret, to improve compatibility with some authenticator apps.

Default ​

ts
false

Inherited from ​

IUrlInfo.betterCompatibility

digest? ​

optional digest: EDigest

Defined in: URL.ts:78

The digest algorithm used to generate the OTP code.

Warning ​

Not all authenticator apps support SHA256 or SHA512.

Default ​

ts
'SHA1'

See ​

Inherited from ​

IUrlInfo.digest

digits? ​

optional digits: number

Defined in: URL.ts:56

The output width of OTP.

Default ​

ts
6

Warning ​

Not all authenticator apps support digits other than 6.

See ​

https://datatracker.ietf.org/doc/html/rfc4226#section-5

Inherited from ​

IUrlInfo.digits

issuer? ​

optional issuer: null | string

Defined in: URL.ts:66

The issuer of OTP code to display in OTP authenticator app.

Inherited from ​

IUrlInfo.issuer

key ​

key: string | Buffer<ArrayBufferLike>

Defined in: URL.ts:40

The key of OTP code.

If the key is a string, it must be BASE32-encoded.

See ​

https://datatracker.ietf.org/doc/html/rfc4226#section-5.1

Inherited from ​

IUrlInfo.key

label ​

label: string

Defined in: URL.ts:61

The label of OTP code to display in OTP authenticator app.

Inherited from ​

IUrlInfo.label

period? ​

optional period: number

Defined in: URL.ts:107

The interval of every TOTP code, in seconds.

Default ​

ts
30

Warning ​

Not all authenticator apps support period other than 30 seconds.

See ​

https://datatracker.ietf.org/doc/html/rfc6238#section-4.1

type ​

type: "totp"

Defined in: URL.ts:96

The type of OTP.

Overrides ​

IUrlInfo.type