ActorSystem
Defined in: src/ActorSystem.ts:48
The ActorSystem is the top-level container for actors. It owns the root guardians, the event stream, the scheduler, and the default dispatcher. Create one per logical application.
Properties
Section titled “Properties”config
Section titled “config”
readonlyconfig:Config
Defined in: src/ActorSystem.ts:56
Full merged configuration in effect for this system.
deadLetters
Section titled “deadLetters”
readonlydeadLetters:ActorRef
Defined in: src/ActorSystem.ts:54
dispatcher
Section titled “dispatcher”
readonlydispatcher:Dispatcher
Defined in: src/ActorSystem.ts:50
eventStream
Section titled “eventStream”
readonlyeventStream:EventStream
Defined in: src/ActorSystem.ts:52
extensions
Section titled “extensions”
readonlyextensions:Extensions
Defined in: src/ActorSystem.ts:58
Per-system extension registry (serialization, sharding, pubsub, …).
readonlylog:Logger
Defined in: src/ActorSystem.ts:53
readonlyname:string
Defined in: src/ActorSystem.ts:49
scheduler
Section titled “scheduler”
readonlyscheduler:Scheduler
Defined in: src/ActorSystem.ts:51
Accessors
Section titled “Accessors”isTerminated
Section titled “isTerminated”Get Signature
Section titled “Get Signature”get isTerminated():
boolean
Defined in: src/ActorSystem.ts:175
Returns
Section titled “Returns”boolean
Methods
Section titled “Methods”actorOf()
Section titled “actorOf()”actorOf<
T>(props,name?):ActorRef<T>
Defined in: src/ActorSystem.ts:117
Spawn a top-level user actor under /user.
Type Parameters
Section titled “Type Parameters”T
Parameters
Section titled “Parameters”Props<T>
string
Returns
Section titled “Returns”ActorRef<T>
actorSelection()
Section titled “actorSelection()”actorSelection(
path):ActorSelection
Defined in: src/ActorSystem.ts:130
Build an ActorSelection that resolves a path at lookup time. Accepts
- a fully-qualified URI (“actor-ts://sys/user/foo/bar”)
- an absolute path (“/user/foo/bar” or “user/foo/bar”) Wildcards are not supported in v1.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”extension()
Section titled “extension()”extension<
T>(id):T
Defined in: src/ActorSystem.ts:112
Convenience shortcut for system.extensions.get(id) — the one-liner
used throughout the codebase to resolve an extension by its id.
Type Parameters
Section titled “Type Parameters”T extends Extension
Parameters
Section titled “Parameters”ExtensionId<T>
Returns
Section titled “Returns”T
stop()
Section titled “stop()”stop(
ref):void
Defined in: src/ActorSystem.ts:154
Stop any actor by reference. Returns a promise that resolves once it is fully terminated.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”void
terminate()
Section titled “terminate()”terminate():
Promise<void>
Defined in: src/ActorSystem.ts:159
Shut down: stops /user (children first) and resolves once everything is drained.
Returns
Section titled “Returns”Promise<void>
whenTerminated()
Section titled “whenTerminated()”whenTerminated():
Promise<void>
Defined in: src/ActorSystem.ts:168
Promise that resolves when the system has finished shutting down.
Returns
Section titled “Returns”Promise<void>
create()
Section titled “create()”
staticcreate(name?,settings?):ActorSystem
Defined in: src/ActorSystem.ts:104
Create a new actor system.
Parameters
Section titled “Parameters”string = 'default'
settings?
Section titled “settings?”ActorSystemSettings = {}
Returns
Section titled “Returns”ActorSystem