DurableStateActor
Defined in: src/persistence/DurableStateActor.ts:32
Base class for actors that persist a single state value per
persistenceId instead of an event log. State is loaded on startup
(or an emptyState snapshot is used) and persisted after each
mutation via persist(newState).
User code overrides onCommand with the command handler and calls
this.state to read, this.persist(next) to write. Writes are
optimistic — concurrent writers receive DurableStateConcurrencyError.
Extends
Section titled “Extends”Actor<Cmd>
Type Parameters
Section titled “Type Parameters”Cmd
S
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new DurableStateActor<
Cmd,S>(settings):DurableStateActor<Cmd,S>
Defined in: src/persistence/DurableStateActor.ts:36
Parameters
Section titled “Parameters”settings
Section titled “settings”Returns
Section titled “Returns”DurableStateActor<Cmd, S>
Overrides
Section titled “Overrides”Properties
Section titled “Properties”settings
Section titled “settings”
readonlysettings:DurableStateSettings<S>
Defined in: src/persistence/DurableStateActor.ts:36
Methods
Section titled “Methods”onCommand()
Section titled “onCommand()”
abstractonCommand(cmd):void|Promise<void>
Defined in: src/persistence/DurableStateActor.ts:95
User handler — invoked once preStart has loaded the record.
Parameters
Section titled “Parameters”Cmd
Returns
Section titled “Returns”void | Promise<void>
onReceive()
Section titled “onReceive()”onReceive(
cmd):Promise<void>
Defined in: src/persistence/DurableStateActor.ts:89
Main message handler. Receives each envelope dequeued from the mailbox. A thrown error (sync or async) is caught by the supervisor.
Parameters
Section titled “Parameters”Cmd
Returns
Section titled “Returns”Promise<void>
Overrides
Section titled “Overrides”postRestart()
Section titled “postRestart()”postRestart(
_reason):void|Promise<void>
Defined in: src/Actor.ts:55
Called on the fresh instance after a restart. Default: call preStart().
Parameters
Section titled “Parameters”_reason
Section titled “_reason”Error
Returns
Section titled “Returns”void | Promise<void>
Inherited from
Section titled “Inherited from”postStop()
Section titled “postStop()”postStop():
void|Promise<void>
Defined in: src/Actor.ts:44
Called after the actor has been terminated. Children are already stopped.
Returns
Section titled “Returns”void | Promise<void>
Inherited from
Section titled “Inherited from”preRestart()
Section titled “preRestart()”preRestart(
_reason,_message?):void|Promise<void>
Defined in: src/Actor.ts:50
Called before a restart, on the instance about to be thrown away. The default stops children and then calls postStop().
Parameters
Section titled “Parameters”_reason
Section titled “_reason”Error
_message?
Section titled “_message?”Cmd
Returns
Section titled “Returns”void | Promise<void>
Inherited from
Section titled “Inherited from”preStart()
Section titled “preStart()”preStart():
Promise<void>
Defined in: src/persistence/DurableStateActor.ts:73
Called after construction and before the first message is processed.
Returns
Section titled “Returns”Promise<void>
Overrides
Section titled “Overrides”supervisorStrategy()
Section titled “supervisorStrategy()”supervisorStrategy():
SupervisorStrategy
Defined in: src/Actor.ts:63
Supervisor strategy for this actor’s children. Defaults to restart, up to 10 times per minute, then stop.