Pular para o conteúdo
Português (BR)

ActorRef

Este conteúdo não está disponível em sua língua ainda.

Defined in: src/ActorRef.ts:118

Handle to an actor. The only way to interact with an actor — you never hold a direct reference to the Actor instance itself. tell() is fire-and- forget; ask() provides a request/response Promise.

TMessage = unknown

new ActorRef<TMessage>(): ActorRef<TMessage>

ActorRef<TMessage>

abstract readonly path: ActorPath

Defined in: src/ActorRef.ts:119

ask<TResponse>(message, timeoutMs?): Promise<TResponse>

Defined in: src/ActorRef.ts:145

Request/response — send message and await the recipient’s reply. The framework synthesises a one-shot reply ref, injects it as both the sender slot and as message.replyTo, and resolves the returned promise with the first reply (or rejects with AskTimeoutError).

The caller never specifies replyTo on the message — the OmitReplyTo type subtracts it from the parameter type if the recipient declares it.

const value = await counter.ask<number>({ kind: 'get' });

timeoutMs must be a positive finite number; omit it (or pass undefined) to get ActorRef._defaultAskTimeoutMs — the configured actor-ts.actor.ask-timeout on a ref that can reach its ActorSystem, and DEFAULT_ASK_TIMEOUT_MS on one that cannot. 0, a negative value, NaN and Infinity throw OptionsError — see assertAskTimeout for why an ask has no “no deadline” mode.

TResponse = unknown

OmitReplyTo<TMessage>

number

Promise<TResponse>


equals(other): boolean

Defined in: src/ActorRef.ts:241

ActorRef

boolean


kill(): void

Defined in: src/ActorRef.ts:237

Kill this actor — raises ActorKilledError through the normal supervision path.

void


send(message): void

Defined in: src/ActorRef.ts:125

Alias for tell — useful if you want to pipe something.

TMessage

void


stop(): void

Defined in: src/ActorRef.ts:234

Gracefully stop this actor after it drains its mailbox.

void


abstract tell(message, sender?): void

Defined in: src/ActorRef.ts:122

Send a message to this actor. sender is surfaced as context.sender in the recipient.

TMessage

ActorRef<unknown> | null

void


toString(): string

Defined in: src/ActorRef.ts:239

string