Docs
API
Modules
store_src

Table of contents

Enumerations

Classes

Interfaces

Type Aliases

Variables

Type Aliases

ProxyOptions

Ƭ ProxyOptions<TData, TJSONData>: Object

Type parameters

NameType
TDataTData
TJSONDataany

Type declaration

NameType
codify(value: TData, identifier: string) => string | Promise<string>
fromJSON(jsonData: TJSONData, identifier: string) => TData | Promise<TData>
toJSON(value: TData, identifier: string) => TJSONData | Promise<TJSONData>
validate(oldValue: TData, newValue: TData, identifier: string) => void | Promise<void>

Defined in

packages/store/src/index.ts:97


StoreFlags

Ƭ StoreFlags: Object

Type declaration

NameType
readonlyboolean
validateboolean

Defined in

packages/store/src/index.ts:104


StoreProxy

Ƭ StoreProxy<TData>: Object

Type parameters

Name
TData

Type declaration

NameType
delete() => Promise<void>
get() => Promise<TData>
getWithSet(setterFn: () => TData | Promise<TData>) => Promise<TData>
set(value: TData) => Promise<void>

Defined in

packages/store/src/index.ts:90


StoreStorageAdapter

Ƭ StoreStorageAdapter<TData, TKey>: Object

Type parameters

NameType
TDataany
TKeystring

Type declaration

NameType
delete(key: TKey) => Promise<void>
read(key: TKey, options: ProxyOptions<TData, any>) => Promise<TData>
write(key: TKey, data: TData, options: ProxyOptions<TData, any>) => Promise<TData>

Defined in

packages/store/src/index.ts:12

Variables

PredefinedProxyOptions

Const PredefinedProxyOptions: Record<PredefinedProxyOptionsName, ProxyOptions<any>>

Defined in

packages/store/src/index.ts:115