StorageAdapter
Defined in: store/adapters/StorageAdapter.ts:43
A class representing a storage adapter module.
Template
Section titled “Template”The type of the application that the module belongs to.
Extends
Section titled “Extends”Plugin<O>
Extended by
Section titled “Extended by”Type Parameters
Section titled “Type Parameters”O = any
Implements
Section titled “Implements”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new StorageAdapter<
O>(id):StorageAdapter<O>
Defined in: store/adapters/StorageAdapter.ts:48
Creates a new StorageAdapter.
Parameters
Section titled “Parameters”string = 'StorageAdapter'
The ID of the adapter. Default is ‘StorageAdapter’.
Returns
Section titled “Returns”StorageAdapter<O>
Overrides
Section titled “Overrides”Properties
Section titled “Properties”
readonlyid:string='StorageAdapter'
Defined in: store/adapters/StorageAdapter.ts:48
The ID of the adapter. Default is ‘StorageAdapter’.
Implementation of
Section titled “Implementation of”Inherited from
Section titled “Inherited from”Accessors
Section titled “Accessors”Get Signature
Section titled “Get Signature”get app():
Application
Defined in: plugins/Plugin.ts:52
Returns
Section titled “Returns”Implementation of
Section titled “Implementation of”Inherited from
Section titled “Inherited from”options
Section titled “options”Get Signature
Section titled “Get Signature”get options():
O
Defined in: plugins/Plugin.ts:44
Returns
Section titled “Returns”O
Implementation of
Section titled “Implementation of”Inherited from
Section titled “Inherited from”Methods
Section titled “Methods”addSignalConnection()
Section titled “addSignalConnection()”addSignalConnection(…
args):void
Defined in: plugins/Plugin.ts:78
Add signal connections to the container.
Parameters
Section titled “Parameters”…SignalConnection[]
The signal connections to add.
Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”IStorageAdapter.addSignalConnection
Inherited from
Section titled “Inherited from”clearSignalConnections()
Section titled “clearSignalConnections()”clearSignalConnections():
void
Defined in: plugins/Plugin.ts:84
Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”IStorageAdapter.clearSignalConnections
Inherited from
Section titled “Inherited from”destroy()
Section titled “destroy()”destroy():
void
Defined in: plugins/Plugin.ts:56
Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”Inherited from
Section titled “Inherited from”initialize()
Section titled “initialize()”initialize(
options?,_app?):void|Promise<void>
Defined in: plugins/Plugin.ts:60
Parameters
Section titled “Parameters”options?
Section titled “options?”Partial<O>
Returns
Section titled “Returns”void | Promise<void>
Implementation of
Section titled “Implementation of”Inherited from
Section titled “Inherited from”load()
Section titled “load()”load<
TExpectedLoadResult>(_key):undefined|TExpectedLoadResult|Promise<TExpectedLoadResult>
Defined in: store/adapters/StorageAdapter.ts:58
Loads data from a specified key.
Type Parameters
Section titled “Type Parameters”TExpectedLoadResult
Section titled “TExpectedLoadResult”TExpectedLoadResult = any
Parameters
Section titled “Parameters”string
The key from which to load the data.
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.
Implementation of
Section titled “Implementation of”postInitialize()
Section titled “postInitialize()”postInitialize(
_app):void|Promise<void>
Defined in: plugins/Plugin.ts:67
Parameters
Section titled “Parameters”Returns
Section titled “Returns”void | Promise<void>
Implementation of
Section titled “Implementation of”IStorageAdapter.postInitialize
Inherited from
Section titled “Inherited from”save()
Section titled “save()”save<
TExpectedSaveResult>(_key,_data, …_rest):any
Defined in: store/adapters/StorageAdapter.ts:72
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.