IStorageAdapter
Defined in: store/adapters/StorageAdapter.ts:7
Interface for a storage adapter module.
Extends
Section titled “Extends”Properties
Section titled “Properties”app:
IApplication
Defined in: plugins/Plugin.ts:10
Inherited from
Section titled “Inherited from”id:
string
Defined in: plugins/Plugin.ts:8
Inherited from
Section titled “Inherited from”options
Section titled “options”
readonlyoptions:Partial<O>
Defined in: plugins/Plugin.ts:12
Inherited from
Section titled “Inherited from”Methods
Section titled “Methods”addSignalConnection()
Section titled “addSignalConnection()”addSignalConnection(…
args):void
Defined in: plugins/Plugin.ts:20
Parameters
Section titled “Parameters”…SignalConnection[]
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”clearSignalConnections()
Section titled “clearSignalConnections()”clearSignalConnections():
void
Defined in: plugins/Plugin.ts:22
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”IPlugin.clearSignalConnections
destroy()
Section titled “destroy()”destroy():
void
Defined in: plugins/Plugin.ts:18
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”initialize()
Section titled “initialize()”initialize(
options,app):void|Promise<void>
Defined in: plugins/Plugin.ts:14
Parameters
Section titled “Parameters”options
Section titled “options”Partial<O>
Returns
Section titled “Returns”void | Promise<void>
Inherited from
Section titled “Inherited from”load()
Section titled “load()”load<
TExpectedLoadResult>(_key, …args):undefined|TExpectedLoadResult|Promise<TExpectedLoadResult>
Defined in: store/adapters/StorageAdapter.ts:28
Loads data from a specified key.
Type Parameters
Section titled “Type Parameters”TExpectedLoadResult
Section titled “TExpectedLoadResult”TExpectedLoadResult = any
Parameters
Section titled “Parameters”string
…any[]
Returns
Section titled “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()
Section titled “postInitialize()”postInitialize(
_app):void|Promise<void>
Defined in: plugins/Plugin.ts:16
Parameters
Section titled “Parameters”Returns
Section titled “Returns”void | Promise<void>
Inherited from
Section titled “Inherited from”registerCoreFunctions()
Section titled “registerCoreFunctions()”registerCoreFunctions():
void
Defined in: plugins/Plugin.ts:24
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”registerCoreSignals()
Section titled “registerCoreSignals()”registerCoreSignals():
void
Defined in: plugins/Plugin.ts:26
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”save()
Section titled “save()”save<
TExpectedSaveResult>(_key,_data, …_rest):any
Defined in: store/adapters/StorageAdapter.ts:15
Saves data under a specified key.
Type Parameters
Section titled “Type Parameters”TExpectedSaveResult
Section titled “TExpectedSaveResult”TExpectedSaveResult = any
Parameters
Section titled “Parameters”string
any
…any[]
Returns
Section titled “Returns”any
A promise that resolves when the data has been saved, or void if the save operation is synchronous.