Skip to content
actor-ts

SnapshotPolicy

SnapshotPolicy<State, Event> = (seq, state, event) => boolean

Defined in: src/persistence/PersistentActor.ts:23

How often to take snapshots — called after every event apply. Returning true means “snapshot the current state”.

Type Parameters

Section titled “Type Parameters”

State

Section titled “State”

State

Event

Section titled “Event”

Event

Parameters

Section titled “Parameters”

seq

Section titled “seq”

number

state

Section titled “state”

State

event

Section titled “event”

Event

Returns

Section titled “Returns”

boolean