Interface PreferenceStore

Strategy to store and retrieve SDM preferences.

Hierarchy

PreferenceStore

Implemented by

Index

Methods

Methods

delete

delete(key: string, options?: { scope?: PreferenceScope | string }): Promise<void>

- Defined in lib/api/context/preferenceStore.ts:74
Delete a preference in a given scope

Parameters
- key: string
- Optional options: { scope?: PreferenceScope | string }
  - Optional scope?: PreferenceScope | string
Returns Promise<void>

get

get<V>(key: string, options?: { defaultValue?: V; scope?: PreferenceScope | string }): Promise<V | undefined>

- Defined in lib/api/context/preferenceStore.ts:56
Retrieve a preference object via its key in the given scope.

Type parameters
- V
Parameters
- key: string
- Optional options: { defaultValue?: V; scope?: PreferenceScope | string }
  - Optional defaultValue?: V
  - Optional scope?: PreferenceScope | string
Returns Promise<V | undefined>

list

list<V>(scope: PreferenceScope | string): Promise<Array<{ key: string; value: V }>>

- Defined in lib/api/context/preferenceStore.ts:69
List all preferences in a given scope

Type parameters
- V
Parameters
- scope: PreferenceScope | string
Returns Promise<Array<{ key: string; value: V }>>

put

put<V>(key: string, value: V, options?: { scope?: PreferenceScope | string; ttl?: number }): Promise<V>

- Defined in lib/api/context/preferenceStore.ts:62
Store a preference object with the specified ttl and scope.

Type parameters
- V
Parameters
- key: string
- value: V
- Optional options: { scope?: PreferenceScope | string; ttl?: number }
  - Optional scope?: PreferenceScope | string
  - Optional ttl?: number
Returns Promise<V>

Generated using TypeDoc