IStorageAdapter

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

Interface for a storage adapter module.

Extends

• IPlugin

Properties

app

app: IApplication

Defined in: plugins/Plugin.ts:10

Inherited from

IPlugin.app

---

id

id: string

Defined in: plugins/Plugin.ts:8

Inherited from

IPlugin.id

---

options

readonly options: Partial<any>

Defined in: plugins/Plugin.ts:12

Inherited from

IPlugin.options

Methods

addSignalConnection()

addSignalConnection(…args): void

Defined in: plugins/Plugin.ts:20

Parameters

args

…SignalConnection[]

Returns

void

Inherited from

IPlugin.addSignalConnection

---

clearSignalConnections()

clearSignalConnections(): void

Defined in: plugins/Plugin.ts:22

Returns

void

Inherited from

IPlugin.clearSignalConnections

---

destroy()

destroy(): void

Defined in: plugins/Plugin.ts:18

Returns

void

Inherited from

IPlugin.destroy

---

initialize()

initialize(options, app): void | Promise<void>

Defined in: plugins/Plugin.ts:14

Parameters

options

Partial<any>

app

IApplication

Returns

void | Promise<void>

Inherited from

IPlugin.initialize

---

load()

load<TExpectedLoadResult>(_key, …args): undefined | TExpectedLoadResult | Promise<TExpectedLoadResult>

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

Loads data from a specified key.

Type Parameters

• TExpectedLoadResult = any

Parameters

_key

string

args

…any[]

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.

---

postInitialize()

postInitialize(_app): void | Promise<void>

Defined in: plugins/Plugin.ts:16

Parameters

_app

IApplication

Returns

void | Promise<void>

Inherited from

IPlugin.postInitialize

---

registerCoreFunctions()

registerCoreFunctions(): void

Defined in: plugins/Plugin.ts:24

Returns

void

Inherited from

IPlugin.registerCoreFunctions

---

registerCoreSignals()

registerCoreSignals(): void

Defined in: plugins/Plugin.ts:26

Returns

void

Inherited from

IPlugin.registerCoreSignals

---

save()

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

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

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.