@zturnlibs/ztron-api

---

store#

Classes#

Store#

Defined in: store.ts:38

资源风格的 store 实例（上游 Store 对齐）：显式生命周期、实例级 autoSave 与变更监听；旧版函数面继续作用于同一批文件。

Properties#

storeId#

readonly storeId: string

Defined in: store.ts:39

Methods#

close()#

close(): Promise<void>

Defined in: store.ts:103

冲刷（autoSave）并卸载实例。

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

订阅 set/delete/reset 变更；返回取消监听函数。

Parameters#

handler#

(e) => void

Returns#

Promise<() => Promise<void>>

reset()#

reset(): Promise<void>

Defined in: store.ts:78

清空 store（按 autoSave 持久化；推送 reset 事件）。

Returns#

Promise<void>

save()#

save(): Promise<void>

Defined in: store.ts:82

无视 autoSave 立即持久化。

Returns#

Promise<void>

saveTo()#

saveTo(newPath): Promise<void>

Defined in: store.ts:86

把本 store 的 JSON 持久化到另一个路径。

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()#

static load(path, options?): Promise<Store>

Defined in: store.ts:46

装载/附着 store 文件（autoSave 缺省为上游的 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

经 onChange 通道推送的变更记录（G9/D2）。

Variables#

store#

const store: 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[]>