ReplicatedEventSourcedActor
Defined in: src/persistence/ReplicatedEventSourcedActor.ts:120
Base class for user actors. Subclasses must override onReceive.
Lifecycle hooks (preStart, postStop, preRestart, postRestart) have sensible
defaults but can be overridden.
Actors are single-threaded by construction: the runtime guarantees that onReceive is never invoked concurrently for the same actor. If onReceive returns a Promise, the runtime awaits it before starting the next message.
Extends
Section titled “Extends”Actor<Cmd|ReplicatedEventEnvelope<Event>>
Type Parameters
Section titled “Type Parameters”Cmd
Event
State
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new ReplicatedEventSourcedActor<
Cmd,Event,State>(cluster):ReplicatedEventSourcedActor<Cmd,Event,State>
Defined in: src/persistence/ReplicatedEventSourcedActor.ts:223
Parameters
Section titled “Parameters”cluster
Section titled “cluster”Returns
Section titled “Returns”ReplicatedEventSourcedActor<Cmd, Event, State>
Overrides
Section titled “Overrides”Properties
Section titled “Properties”cluster
Section titled “cluster”
readonlycluster:Cluster
Defined in: src/persistence/ReplicatedEventSourcedActor.ts:223
persistenceId
Section titled “persistenceId”
abstractreadonlypersistenceId:string
Defined in: src/persistence/ReplicatedEventSourcedActor.ts:122
replicaId
Section titled “replicaId”
abstractreadonlyreplicaId:string
Defined in: src/persistence/ReplicatedEventSourcedActor.ts:124
Stable id for this replica. Default: cluster.selfAddress.toString().
Methods
Section titled “Methods”initialState()
Section titled “initialState()”
abstractinitialState():State
Defined in: src/persistence/ReplicatedEventSourcedActor.ts:126
Returns
Section titled “Returns”State
onCommand()
Section titled “onCommand()”
abstractonCommand(state,cmd):void|Promise<void>
Defined in: src/persistence/ReplicatedEventSourcedActor.ts:128
Parameters
Section titled “Parameters”State
Cmd
Returns
Section titled “Returns”void | Promise<void>
onEvent()
Section titled “onEvent()”
abstractonEvent(state,event):State
Defined in: src/persistence/ReplicatedEventSourcedActor.ts:127
Parameters
Section titled “Parameters”State
Event
Returns
Section titled “Returns”State
onReceive()
Section titled “onReceive()”onReceive(
msg):Promise<void>
Defined in: src/persistence/ReplicatedEventSourcedActor.ts:362
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”SubscribeAck | Cmd | ReplicatedEventEnvelope<Event>
Returns
Section titled “Returns”Promise<void>
Overrides
Section titled “Overrides”onRecoveryComplete()
Section titled “onRecoveryComplete()”onRecoveryComplete(
_state):void|Promise<void>
Defined in: src/persistence/ReplicatedEventSourcedActor.ts:157
Recovery hook — called after the local journal has been replayed.
Parameters
Section titled “Parameters”_state
Section titled “_state”State
Returns
Section titled “Returns”void | Promise<void>
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
Defined in: src/persistence/ReplicatedEventSourcedActor.ts:341
Called after the actor has been terminated. Children are already stopped.
Returns
Section titled “Returns”void
Overrides
Section titled “Overrides”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 | ReplicatedEventEnvelope<Event>
Returns
Section titled “Returns”void | Promise<void>
Inherited from
Section titled “Inherited from”preStart()
Section titled “preStart()”preStart():
Promise<void>
Defined in: src/persistence/ReplicatedEventSourcedActor.ts:237
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.