StorageAdapter

Defined in: store/adapters/StorageAdapter.ts:44

A class representing a storage adapter module.

Extends

• Plugin<T>

Extended by

• DataAdapter

Type Parameters

• T extends Application = Application

The type of the application that the module belongs to.

Implements

• IStorageAdapter

Constructors

new StorageAdapter()

new StorageAdapter<T>(id): StorageAdapter<T>

Defined in: store/adapters/StorageAdapter.ts:49

Creates a new StorageAdapter.

Parameters

id

string = 'StorageAdapter'

The ID of the adapter. Default is ‘StorageAdapter’.

Returns

StorageAdapter<T>

Overrides

Plugin.constructor

Properties

__dill_pixel_method_binding_root

__dill_pixel_method_binding_root: boolean

Defined in: plugins/Plugin.ts:39

Inherited from

Plugin.__dill_pixel_method_binding_root

---

id

readonly id: string = 'StorageAdapter'

Defined in: store/adapters/StorageAdapter.ts:49

The ID of the adapter. Default is ‘StorageAdapter’.

Implementation of

IStorageAdapter.id

Inherited from

Plugin.id

Accessors

app

Get Signature

get app(): A

Defined in: plugins/Plugin.ts:53

Returns

A

Implementation of

IStorageAdapter.app

Inherited from

Plugin.app

---

options

Get Signature

get options(): O

Defined in: plugins/Plugin.ts:44

Returns

O

Implementation of

IStorageAdapter.options

Inherited from

Plugin.options

Methods

addSignalConnection()

addSignalConnection(…args): void

Defined in: plugins/Plugin.ts:79

Add signal connections to the container.

Parameters

args

…SignalConnection[]

The signal connections to add.

Returns

void

Implementation of

IStorageAdapter.addSignalConnection

Inherited from

Plugin.addSignalConnection

---

clearSignalConnections()

clearSignalConnections(): void

Defined in: plugins/Plugin.ts:85

Returns

void

Implementation of

IStorageAdapter.clearSignalConnections

Inherited from

Plugin.clearSignalConnections

---

destroy()

destroy(): void

Defined in: plugins/Plugin.ts:57

Returns

void

Implementation of

IStorageAdapter.destroy

Inherited from

Plugin.destroy

---

initialize()

initialize(options?, _app?): void | Promise<void>

Defined in: plugins/Plugin.ts:61

Parameters

options?

Partial<any>

_app?

IApplication<DataSchema, ActionContext, Action>

Returns

void | Promise<void>

Implementation of

IStorageAdapter.initialize

Inherited from

Plugin.initialize

---

load()

load<TExpectedLoadResult>(_key): undefined | TExpectedLoadResult | Promise<TExpectedLoadResult>

Defined in: store/adapters/StorageAdapter.ts:59

Loads data from a specified key.

Type Parameters

• TExpectedLoadResult = any

Parameters

_key

string

The key from which to load the data.

Returns

undefined | TExpectedLoadResult | Promise<TExpectedLoadResult>

A promise that resolves with the loaded data, or the loaded data if the load operation is synchronous, or null if no data was found.

Implementation of

IStorageAdapter.load

---

postInitialize()

postInitialize(_app): void | Promise<void>

Defined in: plugins/Plugin.ts:68

Parameters

_app

IApplication

Returns

void | Promise<void>

Implementation of

IStorageAdapter.postInitialize

Inherited from

Plugin.postInitialize

---

save()

save<TExpectedSaveResult>(_key, _data, …_rest): any

Defined in: store/adapters/StorageAdapter.ts:73

Saves data under a specified key.

Type Parameters

• TExpectedSaveResult = any

Parameters

_key

string

_data

any

_rest

…any[]

Returns

any

A promise that resolves when the data has been saved, or void if the save operation is synchronous.

Implementation of

IStorageAdapter.save