Behaviors
constBehaviors:object
Defined in: src/typed/Behaviors.ts:40
Factory for building Behaviors — the functional facade over the OO Actor API. Use these combinators to compose an actor’s logic as a tree of values rather than as an imperative class.
Type Declaration
Section titled “Type Declaration”Get Signature
Section titled “Get Signature”get empty():
Behavior<never>
Sentinel: accept messages but do nothing — useful as a placeholder.
Returns
Section titled “Returns”Behavior<never>
ignore
Section titled “ignore”Get Signature
Section titled “Get Signature”get ignore():
Behavior<never>
Sentinel: drop every incoming message silently.
Returns
Section titled “Returns”Behavior<never>
Get Signature
Section titled “Get Signature”get same():
Behavior<never>
Sentinel: keep the current behavior.
Returns
Section titled “Returns”Behavior<never>
stopped
Section titled “stopped”Get Signature
Section titled “Get Signature”get stopped():
Behavior<never>
Sentinel: stop the actor.
Returns
Section titled “Returns”Behavior<never>
unhandled
Section titled “unhandled”Get Signature
Section titled “Get Signature”get unhandled():
Behavior<never>
Sentinel: mark the message as unhandled (goes to dead letters).
Returns
Section titled “Returns”Behavior<never>
receive()
Section titled “receive()”receive<
T>(handler):ReceiveBehavior<T>
Standard receive — gets both context and message.
Type Parameters
Section titled “Type Parameters”T
Parameters
Section titled “Parameters”handler
Section titled “handler”(ctx, msg) => Behavior<T>
Returns
Section titled “Returns”receiveMessage()
Section titled “receiveMessage()”receiveMessage<
T>(handler):ReceiveBehavior<T>
Receive when you don’t need the context — message-only shortcut.
Type Parameters
Section titled “Type Parameters”T
Parameters
Section titled “Parameters”handler
Section titled “handler”(msg) => Behavior<T>
Returns
Section titled “Returns”receiveWithSignal()
Section titled “receiveWithSignal()”receiveWithSignal<
T>(handler,onSignal):ReceiveBehavior<T>
Receive with an additional signal handler.
Type Parameters
Section titled “Type Parameters”T
Parameters
Section titled “Parameters”handler
Section titled “handler”(ctx, msg) => Behavior<T>
onSignal
Section titled “onSignal”(ctx, signal) => Behavior<T>
Returns
Section titled “Returns”setup()
Section titled “setup()”setup<
T>(factory):Behavior<T>
Run factory once with the actor’s context; the returned Behavior is
the first one the actor adopts. Use this to capture ctx.self or spawn
children in the “constructor”.
Type Parameters
Section titled “Type Parameters”T
Parameters
Section titled “Parameters”factory
Section titled “factory”(ctx) => Behavior<T>
Returns
Section titled “Returns”Behavior<T>
supervise()
Section titled “supervise()”supervise<
T>(child):SuperviseBuilder<T>
Wrap a behavior with a supervisor strategy. Any error thrown from the
wrapped handler is routed through strategy — the behavior is restarted
(reset to its initial form), stopped, resumed, or escalated.
Type Parameters
Section titled “Type Parameters”T
Parameters
Section titled “Parameters”Behavior<T>
Returns
Section titled “Returns”withStash()
Section titled “withStash()”withStash<
T>(capacity,factory):Behavior<T>
Expose a capacity-bounded stash buffer. The inner behavior can stash
user messages (e.g. during init) and call stash.unstashAll() later.
Type Parameters
Section titled “Type Parameters”T
Parameters
Section titled “Parameters”capacity
Section titled “capacity”number
factory
Section titled “factory”(stash) => Behavior<T>
Returns
Section titled “Returns”Behavior<T>
withTimers()
Section titled “withTimers()”withTimers<
T>(factory):Behavior<T>
Expose the per-actor TimerScheduler to the behavior.
Type Parameters
Section titled “Type Parameters”T
Parameters
Section titled “Parameters”factory
Section titled “factory”(timers) => Behavior<T>
Returns
Section titled “Returns”Behavior<T>