Class Memento

A memento represents a storage utility. It can store and retrieve values.

Hierarchy (view full)

Memento
- GlobalState

Implements

Memento

Index

Constructors

Properties

cache isPluginGlobalData pluginId storage

Methods

get keys update

Constructors

constructor

new Memento(pluginId, isPluginGlobalData, storage): Memento
Parameters
- pluginId: string
- isPluginGlobalData: boolean
- storage: InternalStorageExt
Returns Memento
- Defined in packages/plugin-ext/src/plugin/plugin-storage.ts:28

Properties

`Private` cache

cache: KeysToAnyValues

`Private` `Readonly` isPluginGlobalData

isPluginGlobalData: boolean

`Private` `Readonly` pluginId

pluginId: string

`Private` `Readonly` storage

storage: InternalStorageExt

Methods

get

get<T>(key): undefined | T
Return a value.
Type Parameters
- T
Parameters
- key: string
  A string.
Returns undefined | T
The stored value or undefined.
Implementation of Memento.get
- Defined in packages/plugin-ext/src/plugin/plugin-storage.ts:46
get<T>(key, defaultValue): T
Return a value.
Type Parameters
- T
Parameters
- key: string
  A string.
- defaultValue: T
  A value that should be returned when there is no value (undefined) with the given key.
Returns T
The stored value or the defaultValue.
Implementation of Memento.get
- Defined in packages/plugin-ext/src/plugin/plugin-storage.ts:47

keys

keys(): string[]
Returns the stored keys.

Returns string[]
The stored keys.
Implementation of Memento.keys
- Defined in packages/plugin-ext/src/plugin/plugin-storage.ts:42

update

update(key, value): Promise<void>
Store a value. The value must be JSON-stringifyable.
Parameters
- key: string
  A string.
- value: any
  A value. MUST not contain cyclic references.
Returns Promise<void>
Implementation of Memento.update
- Defined in packages/plugin-ext/src/plugin/plugin-storage.ts:57