Documentation / @agentick/core / HookPersistenceOptions

Interface: HookPersistenceOptions

Defined in: core/src/hooks/runtime-context.ts:38

Base options for hook snapshot persistence.

Hooks that store state (useData, useComState) extend this to let callers opt individual entries out of session snapshots.

Values must be JSON-serializable — no Dates, Maps, Sets, functions, or circular references. Non-serializable values are silently skipped at snapshot time.

Extended by

• UseDataOptions
• UseComStateOptions

Properties

persist?

optional persist: boolean

Defined in: core/src/hooks/runtime-context.ts:50

Whether to include this entry in session snapshots.

When true (default), the value is saved in session snapshots and restored when the session is loaded from store.

Set to false for large datasets, frequently-changing data, or values already persisted elsewhere.

Default

true