Class StorageContext

Represents an isolated context for key/value pairs and entities. Here, a "context" is essentially type-enforced namespace for keys.

So a context with a prefix of "myFeatureStorage" would have keys like

"myFeatureStorage$itemCount"
"myFeatureStorage$someSubContext$item42"
"myFeatureStorage$someSubContext$entityMap$length"

Hierarchy

StorageContext

Implements

StorageTransportApiMask

Index

Constructors

constructor

Properties

Accessors

absoluteKeyPrefix

Methods

Constructors

constructor

new StorageContext(transport: StorageTransportApiMask, options?: StorageContextOptions, parent?: null | StorageContext): StorageContext

- Defined in core/storage-context.ts:26
Parameters
- transport: StorageTransportApiMask
- options: StorageContextOptions = ...
- parent: null | StorageContext = null
Returns StorageContext

Properties

Readonly options

options: StorageContextOptions = ...

Protected Readonly parent

parent: null | StorageContext = null

Readonly transport

transport: StorageTransportApiMask

Static absolutePrefixSeparator

absolutePrefixSeparator: string = '$'

Accessors

absoluteKeyPrefix

get absoluteKeyPrefix(): string

- Defined in core/storage-context.ts:60
Returns string

Methods

clear

clear(): Promise<void>

Implementation of StorageTransportApiMask.clear
- Defined in core/storage-context.ts:45
Returns Promise<void>

createEntity

createEntity<V>(key: string, options?: StorageContextEntityOptions<V>): StorageContextEntity<V>

- Defined in core/storage-context.ts:74
Type parameters
- V
Parameters
- key: string
- Optional options: StorageContextEntityOptions<V>
Returns StorageContextEntity<V>

createEntityArray

createEntityArray<V>(sharedOptions?: StorageContextEntityOptions<V>, sizeKey?: string): StorageContextEntityArray<V>

- Defined in core/storage-context.ts:82
Type parameters
- V
Parameters
- Optional sharedOptions: StorageContextEntityOptions<V>
- Optional sizeKey: string
Returns StorageContextEntityArray<V>

createEntityMap

createEntityMap<V>(sharedOptions?: StorageContextEntityOptions<V>): StorageContextEntityMap<V>

- Defined in core/storage-context.ts:78
Type parameters
- V
Parameters
- Optional sharedOptions: StorageContextEntityOptions<V>
Returns StorageContextEntityMap<V>

getAbsoluteKey

getAbsoluteKey(relativeKey: string): string

- Defined in core/storage-context.ts:56
Parameters
- relativeKey: string
Returns string

getItem

getItem(key: string): Promise<undefined | null | string>

Implementation of StorageTransportApiMask.getItem
- Defined in core/storage-context.ts:33
Parameters
- key: string
Returns Promise<undefined | null | string>

getKeyValuePair

getKeyValuePair(key: string): StorageContextKeyValuePair

- Defined in core/storage-context.ts:69
Parameters
- key: string
Returns StorageContextKeyValuePair

getSubContext

getSubContext(prefix: string, options?: Partial<StorageContextOptions>): StorageContext

- Defined in core/storage-context.ts:64
Parameters
- prefix: string
- options: Partial<StorageContextOptions> = {}
Returns StorageContext

keys

keys(): Promise<string[]>

Implementation of StorageTransportApiMask.keys
- Defined in core/storage-context.ts:49
Returns Promise<string[]>

removeItem

removeItem(key: string): Promise<void>

Implementation of StorageTransportApiMask.removeItem
- Defined in core/storage-context.ts:41
Parameters
- key: string
Returns Promise<void>

setItem

setItem(key: string, value: string): Promise<void>

Implementation of StorageTransportApiMask.setItem
- Defined in core/storage-context.ts:37
Parameters
- key: string
- value: string
Returns Promise<void>

Generated using TypeDoc