usePersistedState()

function usePersistedState<T>(
   namespace, 
   name, 
   initialValue
): PersistedState<T>;

Defined in: rxdb-vue/src/use-persisted-state.ts:116

创建（或复用）一份持久化到 localStorage 的命名空间状态。

Type Parameters

Type Parameter	Description
T	状态值类型

Parameters

Parameter	Type	Description
namespace	string	状态命名空间
name	string	键名；与 namespace 各自转义后组成持久化键
initialValue	T	仅首次注册生效的初值；盘上已有值时以盘上值为准

Returns

PersistedState<T>

见 PersistedState

Throws

同 namespace + name 此前以不同值类型注册过时抛出

Example

const theme = usePersistedState('my-app', 'theme', 'dark');

theme.value.value = 'light'; // 立即落盘到 'my-app:theme'

Remarks

同 namespace + name 始终返回同一份状态：两个调用点互相可见，也不会各自 拿着陈旧副本互相覆盖盘上数据。后续调用传入的 initialValue 会被忽略， 但仍参与类型标签校验 —— 同 key 换值类型直接抛错，而不是静默串型。

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

非浏览器环境（SSR）下不读也不写 localStorage，状态退化成纯内存值，不会抛错； 客户端 hydrate 后从盘上恢复。

暂不监听 storage 事件，因此不跨标签页同步。

三端等价实现：Angular usePersistedState（WritableSignal）、React usePersistedState（快照 + setter）。持久化内核是共享的 @aiao/utils PersistedStateRegistry，键格式三端一致。