Class

PasscodeClient

PasscodeClient()

A class to handle passcodes.
Constructor

# new PasscodeClient()

View Source lib/client/PasscodeClient.ts, line 13

Extends

Members

HttpClient

# protected client

Overrides:

View Source lib/client/Client.ts, line 20

Methods

# finalize(userID, code) → {Promise.<void>}

Validates the passcode obtained from the email.
Parameters:
Name Type Description
userID string The UUID of the user.
code string The passcode digests.
See:

View Source lib/client/PasscodeClient.ts, line 153

Promise.<void>

# getResendAfter(userID) → {number}

Returns the number of seconds the rate limiting is active for.
Parameters:
Name Type Description
userID string The UUID of the user.

View Source lib/client/PasscodeClient.ts, line 169

number

# getTTL(userID) → {number}

Returns the number of seconds the current passcode is active for.
Parameters:
Name Type Description
userID string The UUID of the user.

View Source lib/client/PasscodeClient.ts, line 161

number

# initialize(userID) → {Promise.<Passcode>}

Causes the API to send a new passcode to the user's email address.
Parameters:
Name Type Description
userID string The UUID of the user.
See:

View Source lib/client/PasscodeClient.ts, line 139

Promise.<Passcode>