Documentation / @super-store/store / StoreValueOptions

Interface: StoreValueOptions<T>

Defined in: store-value.ts:103

Type Parameters

T

T

Properties

debug?

optional debug?: boolean

Defined in: store-value.ts:106

---

doc?

optional doc?: Doc

Defined in: store-value.ts:110

Inject a Yjs document to persist/sync this store. Attach providers (y-indexeddb, y-websocket, …) to this doc yourself. Omit for a private in-memory doc that is created lazily on first Yjs access.

---

isEqual?

optional isEqual?: (a, b) => boolean

Defined in: store-value.ts:104

Parameters

a

T

b

T

Returns

boolean

---

name?

optional name?: string

Defined in: store-value.ts:105

---

undo?

optional undo?: boolean | { captureTimeout?: number; }

Defined in: store-value.ts:114

Track local writes for undo/redo. true (or an options object) attaches a Yjs UndoManager scoped to this root, tracking only this store's own writes. Off by default — UndoManager pins deleted content and disables GC.