ActorSystemOptionsType

ActorSystemOptionsType = object

Defined in: src/ActorSystemOptions.ts:26

Plain options-object shape accepted by ActorSystem.create.

Properties

config?

readonly optional config?: Config | ConfigObject

Defined in: src/ActorSystemOptions.ts:50

Application config. Accepts:

• a prebuilt Config (highest precedence layered on top of reference);
• a plain JS object of overrides (converted via Config.fromObject);
• omitted — reference defaults + application.conf in CWD are used. Constructor options (logger, logLevel, dispatcher) still win over anything in config — they are explicit code overrides.

---

configFile?

readonly optional configFile?: string

Defined in: src/ActorSystemOptions.ts:52

Explicit path to application.conf; overrides ACTOR_TS_CONFIG + CWD lookup.

---

deadLetters?

readonly optional deadLetters?: DeadLetterQueueOptions

Defined in: src/ActorSystemOptions.ts:83

Dead-letter queue settings — the explicit layer over actor-ts.dead-letters.*.

Needed because system.deadLetterQueue is built by the constructor and is readonly: without a slot here the publicly exported DeadLetterQueueOptions family had no reachable consumer at all. A queue you construct yourself is never installed as the capture sink, so it is a correctly-configured object that receives nothing — which made HOCON the only way to configure the real queue, against the project’s explicit options > HOCON > built-in defaults rule.

Field-by-field, so setting one knob here does not blank the others out of the config file.

---

dispatcher?

readonly optional dispatcher?: Dispatcher

Defined in: src/ActorSystemOptions.ts:39

---

logger?

readonly optional logger?: Logger

Defined in: src/ActorSystemOptions.ts:27

---

logLevel?

readonly optional logLevel?: LogLevel

Defined in: src/ActorSystemOptions.ts:38

---

logSinks?

readonly optional logSinks?: readonly LogSink[]

Defined in: src/ActorSystemOptions.ts:37

Log destinations — the system wraps them in a MultiSinkLogger, attaches them to its scheduler, and flushes them on terminate().

The shorthand for the common case; logger still wins when both are given. Setting either one replaces the actor-ts.logger.sinks.* block wholesale rather than merging with it: a sink is configured in code or in HOCON, never half in each.

---

persistence?

readonly optional persistence?: object

Defined in: src/ActorSystemOptions.ts:64

Persistence overrides — wire a real journal / snapshot store at system creation time instead of reaching into the extension after the fact. Either field is independent; omit one to keep the in-memory default for that slot.

Equivalent to: const sys = ActorSystem.create(name); sys.extension(PersistenceExtensionId).setJournal(journal); sys.extension(PersistenceExtensionId).setSnapshotStore(snapshotStore);

journal?

readonly optional journal?: Journal

snapshotStore?

readonly optional snapshotStore?: SnapshotStore

---

scheduler?

readonly optional scheduler?: Scheduler

Defined in: src/ActorSystemOptions.ts:41

Inject a custom scheduler — typically a ManualScheduler in tests.