IDataAdapter
Defined in: store/adapters/DataAdapter.ts:41
Properties
Section titled “Properties”clearOnResume?
Section titled “clearOnResume?”
optionalclearOnResume:boolean
Defined in: store/adapters/DataAdapter.ts:123
onDataChange
Section titled “onDataChange”onDataChange:
Signal<(detail) =>void>
Defined in: store/adapters/DataAdapter.ts:122
Emits a signal when data changes.
Methods
Section titled “Methods”append()
Section titled “append()”append<
K>(key,value,separator?):any
Defined in: store/adapters/DataAdapter.ts:100
Appends a string to a string property.
Type Parameters
Section titled “Type Parameters”K extends string
Parameters
Section titled “Parameters”K
The key of the string property
string
The string to append
separator?
Section titled “separator?”string
The separator to use (default: ”)
Returns
Section titled “Returns”any
The new string after concatenation
clear()
Section titled “clear()”Call Signature
Section titled “Call Signature”clear():
void
Defined in: store/adapters/DataAdapter.ts:61
Clears all data from storage.
Returns
Section titled “Returns”void
Call Signature
Section titled “Call Signature”clear<
K>(key):void
Defined in: store/adapters/DataAdapter.ts:66
Clears data for a specific key from storage.
Type Parameters
Section titled “Type Parameters”K extends string | number
Parameters
Section titled “Parameters”K
The key from which to delete the data
Returns
Section titled “Returns”void
concat()
Section titled “concat()”concat<
K>(key,value):any
Defined in: store/adapters/DataAdapter.ts:86
Concatenates a value or array of values to an array property.
Type Parameters
Section titled “Type Parameters”K extends string
Parameters
Section titled “Parameters”K
The key of the array property
unknown
The value(s) to concatenate
Returns
Section titled “Returns”any
The new array after concatenation
Call Signature
Section titled “Call Signature”get():
DataSchema
Defined in: store/adapters/DataAdapter.ts:42
Returns
Section titled “Returns”Call Signature
Section titled “Call Signature”get<
K>(key):undefined|DataSchema[K]
Defined in: store/adapters/DataAdapter.ts:43
Type Parameters
Section titled “Type Parameters”K extends string | number
Parameters
Section titled “Parameters”K
Returns
Section titled “Returns”undefined | DataSchema[K]
increment()
Section titled “increment()”increment<
K>(key,amount?):any
Defined in: store/adapters/DataAdapter.ts:73
Increments a numeric property by a specified amount.
Type Parameters
Section titled “Type Parameters”K extends string
Parameters
Section titled “Parameters”K
The key of the property to increment
amount?
Section titled “amount?”number
The amount to increment by (default: 1)
Returns
Section titled “Returns”any
The new value after incrementing
Call Signature
Section titled “Call Signature”set<
K>(key,data):DataSchema
Defined in: store/adapters/DataAdapter.ts:50
Sets data for a specific key in storage.
Type Parameters
Section titled “Type Parameters”K extends string | number
Parameters
Section titled “Parameters”K
The key under which to save the data
DataSchema[K]
The data to save
Returns
Section titled “Returns”The updated data object
Call Signature
Section titled “Call Signature”set(
data,merge?):DataSchema
Defined in: store/adapters/DataAdapter.ts:57
Merges data into storage.
Parameters
Section titled “Parameters”DeepPartial<DataAdapterType>
The data object to set
merge?
Section titled “merge?”boolean
Whether to merge with existing data
Returns
Section titled “Returns”The updated data object
snapshot()
Section titled “snapshot()”Call Signature
Section titled “Call Signature”snapshot():
DataSchema
Defined in: store/adapters/DataAdapter.ts:112
Returns a snapshot of the current data.
Returns
Section titled “Returns”A snapshot of the current data
Call Signature
Section titled “Call Signature”snapshot<
K>(key?):DataSchema[K]
Defined in: store/adapters/DataAdapter.ts:118
Returns a snapshot of the current data for a specific key.
Type Parameters
Section titled “Type Parameters”K extends string | number
Parameters
Section titled “Parameters”K
The key of the data to snapshot
Returns
Section titled “Returns”DataSchema[K]
A snapshot of the current data for the specified key