跳到主要内容

useState()

function useState(namespace): (name) => NamespacedState;

Defined in: rxdb-angular/src/use-state.ts:286

创建命名空间下的持久化状态读写入口。

Parameters​

ParameterTypeDescription
namespacestring状态命名空间,与 name 组成 localStorage 的键

Returns​

传入 name 后返回 NamespacedState,同一 namespace + name 始终返回同一个 signal

(name) => NamespacedState

Remarks​

必须在 Angular 注入上下文中调用 useState(namespace)(name) —— 注册表是 root 服务。

首次调用时的 initialValue 决定初值;后续同 key 调用直接复用已有 signal, 传入的 initialValue 与 options 会被忽略;值类型与首次不一致时会抛错(RAN-010)。

namespace 与 name 可以包含任意字符:两者在持久化键里各自转义, 不会互相串号(RAN-005)。含 : 或 % 的旧键在首次读取时一次性迁移到新键。

暂不监听 storage 事件,因此不跨标签页同步:另一个标签页的写入不会反映到本页 signal。