Documentation

Class

PasswordState

PasswordState()

A class that manages the password login state.
Constructor

# new PasswordState()

View Source lib/state/PasswordState.ts, line 11

Extends

Members

LocalStorage

# ls

Inherited From:

View Source lib/state/State.ts, line 23

Methods

# getRetryAfter(userID) → {number}

Gets the number of seconds until when a new password login can be attempted.
Parameters:
Name Type Description
userID string The UUID of the user.

View Source lib/state/PasswordState.ts, line 90

number

# getUserState(userID) → {LocalStorageUser}

Gets the state of the specified user.
Parameters:
Name Type Description
userID string The UUID of the user.
Overrides:

View Source lib/state/UserState.ts, line 25

LocalStorageUser

# read() → {PasswordState}

Reads the current state.
Overrides:

View Source lib/state/PasswordState.ts, line 82

PasswordState

# setRetryAfter(userID, seconds) → {PasswordState}

Sets the number of seconds until a new password login can be attempted.
Parameters:
Name Type Description
userID string The UUID of the user.
seconds string Number of seconds the passcode is valid for.

View Source lib/state/PasswordState.ts, line 99

PasswordState

# write() → {State}

Encodes and writes the data to the local storage.
Inherited From:

View Source lib/state/State.ts, line 49

State