Class UserStore

Stores data.

Hierarchy

StoreBase
- UserStore

Implements

Store

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new UserStore(category?: string): UserStore

- Defined in src/stores.ts:99
Initializes a new instance of that class.

Parameters
- Optional category: string
Returns UserStore

Properties

Optional category

category: string

file

file: string

The file that stores the data.

Static Private _USER_QUEUE

_USER_QUEUE: PQueue<PriorityQueue, DefaultAddOptions> = ego_helpers.createQueue()

Methods

get

get<TValue, TDefault>(key: any, defaultValue?: TDefault): TValue | TDefault

Implementation of Store.get

Inherited from StoreBase.get
- Defined in src/stores.ts:42
Tries to return a value from the store.

Type parameters
- TValue
- TDefault
Parameters
- key: any
- Optional defaultValue: TDefault
Returns TValue | TDefault

The read value or the default value.

Protected getValue

getValue(key: string, valueToReturn: BoxedValue<any>): void

Overrides StoreBase.getValue
- Defined in src/stores.ts:128
inheritdoc

Parameters
- key: string
- valueToReturn: BoxedValue<any>
Returns void

set

set(key: any, value: any): Promise<boolean>

Implementation of Store.set

Inherited from StoreBase.set
- Defined in src/stores.ts:65
Tries set a value in the store.

Parameters
- key: any
- value: any
Returns Promise<boolean>

The promise with the value that indicates if operation was successfull or not.

Protected setValue

setValue(key: string, value: any, succeeded: BoxedValue<boolean>): Promise<void>

Overrides StoreBase.setValue
- Defined in src/stores.ts:162
inheritdoc

Parameters
- key: string
- value: any
- succeeded: BoxedValue<boolean>
Returns Promise<void>

Generated using TypeDoc