Class StoreBase

A basic store.

Hierarchy

StoreBase
- UserStore

Implements

Store

Index

Constructors

constructor

Methods

Constructors

constructor

new StoreBase(): StoreBase

Returns StoreBase

Methods

get

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

Implementation of Store.get
- Defined in src/stores.ts:42
Tries to return a value from the store.

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

The read value or the default value.

Protected Abstract getValue

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

- Defined in src/stores.ts:60
The logic for the 'get()' method.

Parameters
- key: string
  
  The key.
- valueToReturn: BoxedValue<any>
  
  Stores the value to return.
Returns void

set

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

Implementation of Store.set
- Defined in src/stores.ts:65
Tries set a value in the store.

Parameters
- key: any
  
  The key.
- value: any
  
  The value to set.
Returns Promise<boolean>

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

Protected Abstract setValue

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

- Defined in src/stores.ts:91
The logic for the 'set()' method.

Parameters
- key: string
  
  The key.
- value: any
  
  The value to set.
- succeeded: BoxedValue<boolean>
  
  Indicates if operation was successful or not.
Returns Promise<void>

Generated using TypeDoc