Class URI

HOTP/TOTP object/string conversion.

See

Index

Constructors

Methods

parse stringify

Constructors

constructor

new URI(): URI
Returns URI

Methods

`Static`parse

parse(
    uri: string,
    config?: {
        hmac?: (
            algorithm: string,
            key: Uint8Array,
            message: Uint8Array,
        ) => Uint8Array;
    },
): HOTP
| TOTP
Parses a Google Authenticator key URI and returns an HOTP/TOTP object.
Parameters
- uri: string
  Google Authenticator Key URI.
- Optionalconfig: {
      hmac?: (
          algorithm: string,
          key: Uint8Array,
          message: Uint8Array,
      ) => Uint8Array;
  } = {}
  Configuration options.
  - Optionalhmac?: (algorithm: string, key: Uint8Array, message: Uint8Array) => Uint8Array
    Custom HMAC function.
Returns HOTP | TOTP
HOTP/TOTP object.
- Defined in uri.js:52

`Static`stringify

stringify(otp: HOTP | TOTP): string
Converts an HOTP/TOTP object to a Google Authenticator key URI.
Parameters
- otp: HOTP | TOTP
  HOTP/TOTP object.
Returns string
Google Authenticator Key URI.
- Defined in uri.js:166