Class AbstractPreferenceStore

Abstract PreferenceStore implementation to handle ttl and key scoping

Hierarchy

AbstractPreferenceStore

Implements

PreferenceStore

Index

Constructors

constructor

Properties

ctx

Methods

Constructors

Protected constructor

new AbstractPreferenceStore(ctx: HandlerContext): AbstractPreferenceStore

- Defined in lib/core/preferences/AbstractPreferenceStore.ts:36
Parameters
- ctx: HandlerContext
Returns AbstractPreferenceStore

Properties

Private Readonly ctx

ctx: HandlerContext

Methods

delete

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

- Defined in lib/core/preferences/AbstractPreferenceStore.ts:84
Parameters
- key: string
- Default value options: { scope?: PreferenceScope | string } = {}
  - Optional scope?: PreferenceScope | string
Returns Promise<void>

Protected Abstract doDelete

doDelete(key: string, namespace: string): Promise<void>

- Defined in lib/core/preferences/AbstractPreferenceStore.ts:94
Parameters
- key: string
- namespace: string
Returns Promise<void>

Protected Abstract doGet

doGet(key: string, namespace: string): Promise<Preference | undefined>

- Defined in lib/core/preferences/AbstractPreferenceStore.ts:88
Parameters
- key: string
- namespace: string
Returns Promise<Preference | undefined>

Protected Abstract doList

doList(namespace: string): Promise<Preference[]>

- Defined in lib/core/preferences/AbstractPreferenceStore.ts:92
Parameters
- namespace: string
Returns Promise<Preference[]>

Protected Abstract doPut

doPut(pref: Preference): Promise<void>

- Defined in lib/core/preferences/AbstractPreferenceStore.ts:90
Parameters
- pref: Preference
Returns Promise<void>

get

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

- Defined in lib/core/preferences/AbstractPreferenceStore.ts:41
Type parameters
- V
Parameters
- key: string
- Default value 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 }>>

Implementation of PreferenceStore.list
- Defined in lib/core/preferences/AbstractPreferenceStore.ts:68
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/core/preferences/AbstractPreferenceStore.ts:55
Type parameters
- V
Parameters
- key: string
- value: V
- Default value options: { scope?: PreferenceScope | string; ttl?: number } = {}
  - Optional scope?: PreferenceScope | string
  - Optional ttl?: number
Returns Promise<V>

Protected scope

scope(scope: PreferenceScope | string): string

- Defined in lib/core/preferences/AbstractPreferenceStore.ts:103
Parameters
- scope: PreferenceScope | string
Returns string

Protected scopeKey

scopeKey(key: string, scope?: string): string

- Defined in lib/core/preferences/AbstractPreferenceStore.ts:96
Parameters
- key: string
- Optional scope: string
Returns string

Generated using TypeDoc