Documentation

Class

UserState

(abstract) UserState(key)

A class to read and write local storage contents.
Constructor

# abstract new UserState(key)

Parameters:
Name Type Description
key string The local storage key.

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

Extends

Members

LocalStorage

# ls

Inherited From:

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

Methods

# getUserState(userID) → {LocalStorageUser}

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

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

LocalStorageUser

# read() → {State}

Reads and decodes the locally stored data.
Overrides:

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

State

# write() → {State}

Encodes and writes the data to the local storage.
Overrides:

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

State