Class StorageContextKeyValuePair

Represents a single key/value pair for a target context/transport. This eliminates the need for manual key string referencing for each of the standard transport methods.

Hierarchy

StorageContextKeyValuePair

Index

Constructors

constructor

Properties

context
key

Accessors

absoluteKey

Methods

Constructors

constructor

new StorageContextKeyValuePair(context: StorageContext, key: string): StorageContextKeyValuePair

- Defined in core/storage-context-key-value-pair.ts:12
Parameters
- context: StorageContext
- key: string
Returns StorageContextKeyValuePair

Properties

Readonly context

context: StorageContext

Readonly key

key: string

Accessors

absoluteKey

get absoluteKey(): string

- Defined in core/storage-context-key-value-pair.ts:18
Returns string

Methods

asEntity

asEntity<V>(options?: StorageContextEntityOptions<V>): StorageContextEntity<V>

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

clear

clear(): Promise<void>

- Defined in core/storage-context-key-value-pair.ts:26
Returns Promise<void>

load

load(defaultValue?: string): Promise<undefined | string>

- Defined in core/storage-context-key-value-pair.ts:34
Parameters
- Optional defaultValue: string
Returns Promise<undefined | string>

save

save(update: string): Promise<void>

- Defined in core/storage-context-key-value-pair.ts:30
Parameters
- update: string
Returns Promise<void>

Generated using TypeDoc