store
Classes
Store
Defined in: store.ts:38
Resource-style store instance (upstream Store parity): explicit
lifecycle, per-instance autoSave and change listeners. The legacy
function surface above keeps working against the same files.
Properties
storeId
readonlystoreId:string
Defined in: store.ts:39
Methods
close()
close():
Promise<void>
Defined in: store.ts:103
Flushes (autoSave) and unloads the instance.
Returns
Promise<void>
delete()
delete(
key):Promise<void>
Defined in: store.ts:63
Parameters
key
string
Returns
Promise<void>
entries()
entries():
Promise<[string,unknown][]>
Defined in: store.ts:72
Returns
Promise<[string, unknown][]>
get()
get<
T>(key):Promise<T|null>
Defined in: store.ts:54
Type Parameters
T
T = unknown
Parameters
key
string
Returns
Promise<T | null>
has()
has(
key):Promise<boolean>
Defined in: store.ts:60
Parameters
key
string
Returns
Promise<boolean>
keys()
keys():
Promise<string[]>
Defined in: store.ts:66
Returns
Promise<string[]>
onChange()
onChange(
handler):Promise<() =>Promise<void>>
Defined in: store.ts:93
Subscribes to set/delete/reset changes; returns an unlisten fn.
Parameters
handler
(e) => void
Returns
Promise<() => Promise<void>>
reset()
reset():
Promise<void>
Defined in: store.ts:78
Empties the store (persists per autoSave; pushes a reset event).
Returns
Promise<void>
save()
save():
Promise<void>
Defined in: store.ts:82
Persists now regardless of autoSave.
Returns
Promise<void>
saveTo()
saveTo(
newPath):Promise<void>
Defined in: store.ts:86
Persists this store's JSON under another path.
Parameters
newPath
string
Returns
Promise<void>
set()
set(
key,value):Promise<void>
Defined in: store.ts:57
Parameters
key
string
value
unknown
Returns
Promise<void>
setAutoSave()
setAutoSave(
autoSave):Promise<void>
Defined in: store.ts:89
Parameters
autoSave
boolean
Returns
Promise<void>
values()
values():
Promise<unknown[]>
Defined in: store.ts:69
Returns
Promise<unknown[]>
load()
staticload(path,options?):Promise<Store>
Defined in: store.ts:46
Loads/attaches a store file (autoSave defaults to upstream's true).
Parameters
path
string
options?
autoSave?
boolean
Returns
Promise<Store>
Type Aliases
StoreChangeEvent
StoreChangeEvent = {
event:"set"|"delete";key:string;value?:unknown; } | {event:"reset";key:null; }
Defined in: store.ts:29
Change record pushed over an onChange channel (G9/D2).
Variables
store
conststore:object
Defined in: store.ts:26
Type Declaration
clear
clear: (
path) =>Promise<void>
Parameters
path
string
Returns
Promise<void>
entries
entries: (
path) =>Promise<[string,unknown][]>
Parameters
path
string
Returns
Promise<[string, unknown][]>
get
get: <
T>(path,key) =>Promise<T|null>
Type Parameters
T
T = unknown
Parameters
path
string
key
string
Returns
Promise<T | null>
keys
keys: (
path) =>Promise<string[]>
Parameters
path
string
Returns
Promise<string[]>
remove
remove: (
path,key) =>Promise<void>
Parameters
path
string
key
string
Returns
Promise<void>
set
set: (
path,key,value) =>Promise<void>
Parameters
path
string
key
string
value
unknown
Returns
Promise<void>
values
values: (
path) =>Promise<unknown[]>
Parameters
path
string
Returns
Promise<unknown[]>
Functions
clear()
clear(
path):Promise<void>
Defined in: store.ts:22
Parameters
path
string
Returns
Promise<void>
entries()
entries(
path):Promise<[string,unknown][]>
Defined in: store.ts:19
Parameters
path
string
Returns
Promise<[string, unknown][]>
get()
get<
T>(path,key):Promise<T|null>
Defined in: store.ts:4
Type Parameters
T
T = unknown
Parameters
path
string
key
string
Returns
Promise<T | null>
keys()
keys(
path):Promise<string[]>
Defined in: store.ts:13
Parameters
path
string
Returns
Promise<string[]>
remove()
remove(
path,key):Promise<void>
Defined in: store.ts:10
Parameters
path
string
key
string
Returns
Promise<void>
set()
set(
path,key,value):Promise<void>
Defined in: store.ts:7
Parameters
path
string
key
string
value
unknown
Returns
Promise<void>
values()
values(
path):Promise<unknown[]>
Defined in: store.ts:16
Parameters
path
string
Returns
Promise<unknown[]>