ActorContext

Defined in: src/ActorContext.ts:15

Runtime API given to every Actor. Access through this.context inside an Actor subclass.

Type Parameters

TMsg

TMsg = unknown

Properties

children

readonly children: readonly ActorRef<unknown>[]

Defined in: src/ActorContext.ts:32

Snapshot of direct children.

log

readonly log: Logger

Defined in: src/ActorContext.ts:35

Logger bound to this actor’s path.

parent

readonly parent: Option<ActorRef<unknown>>

Defined in: src/ActorContext.ts:29

Parent actor, or None for the root guardian.

path

readonly path: ActorPath

Defined in: src/ActorContext.ts:20

The ActorPath of this actor.

self

readonly self: ActorRef<TMsg>

Defined in: src/ActorContext.ts:17

A reference to this actor.

sender

readonly sender: Option<ActorRef<unknown>>

Defined in: src/ActorContext.ts:23

The sender of the message currently being processed, or None.

stashSize

readonly stashSize: number

Defined in: src/ActorContext.ts:95

Number of currently-stashed messages.

system

readonly system: ActorSystem

Defined in: src/ActorContext.ts:26

The enclosing ActorSystem.

timers

readonly timers: TimerScheduler<TMsg>

Defined in: src/ActorContext.ts:103

Per-actor scheduling facade. Timers are identified by user-supplied string keys and are automatically cancelled when the actor stops.

Methods

actorOf()

actorOf<T>(props, name?): ActorRef<T>

Defined in: src/ActorContext.ts:38

Spawn a child actor under this one. name must be unique among siblings.

Type Parameters

T

T

Parameters

props

Props<T>

name?

string

Returns

ActorRef<T>

actorSelection()

actorSelection(path): ActorSelection

Defined in: src/ActorContext.ts:47

Build an ActorSelection that resolves a full-path lookup. Delegates to the enclosing ActorSystem — same semantics as system.actorSelection.

Parameters

path

string

Returns

ActorSelection

become()

become(behavior, discardOld?): void

Defined in: src/ActorContext.ts:65

Replace the current behaviour. When discardOld is false, the previous behaviour is pushed onto a stack and can be restored via unbecome().

Parameters

behavior

Receive<TMsg>

discardOld?

boolean

Returns

void

cancelReceiveTimeout()

cancelReceiveTimeout(): void

Defined in: src/ActorContext.ts:77

Disable the receive timeout.

Returns

void

cancelThrottle()

cancelThrottle(): void

Defined in: src/ActorContext.ts:125

Remove any active throttle, restoring unlimited dequeue rate.

Returns

void

child()

child(name): Option<ActorRef<unknown>>

Defined in: src/ActorContext.ts:41

Look up a direct child by name. None if no such child exists.

Parameters

name

string

Returns

Option<ActorRef<unknown>>

setReceiveTimeout()

setReceiveTimeout(ms): void

Defined in: src/ActorContext.ts:74

Fire a ReceiveTimeout message when no user message has been received in ms. Pass 0 to disable.

Parameters

ms

number

Returns

void

stash()

stash(): void

Defined in: src/ActorContext.ts:86

Buffer the message currently being handled. It is reinserted into the mailbox when unstashAll() is called. Throws if called outside a user-message handler or if the stash is full.

Returns

void

stop()

stop(ref): void

Defined in: src/ActorContext.ts:50

Ask the runtime to stop the given actor. Equivalent to ref.stop().

Parameters

ref

ActorRef

Returns

void

stopSelf()

stopSelf(): void

Defined in: src/ActorContext.ts:53

Stop this actor itself.

Returns

void

throttle()

throttle(opts): void

Defined in: src/ActorContext.ts:122

Throttle this actor’s user-message processing to a token-bucket rate (#83). Every dequeue from the user mailbox consumes one token; when the bucket is empty the cell behaves per ThrottleOnExcess. System messages (Terminated, supervision, watchNotify) are NOT throttled — they always run immediately, so timer fires and lifecycle events stay responsive.

Calling throttle again replaces the existing limiter; pass { qps: Infinity } or call cancelThrottle to remove one.

Cluster-aware variants (split a budget across cluster-router routees, etc.) are out of scope here — this is per-actor only.