Skip to content
English

TerminateOptions

TerminateOptions = object

Defined in: src/ActorSystem.ts:121

Per-call choices for ActorSystem.terminate.

A plain parameter bag with no builder, like ClusterReadinessOptions: it is read once, by the call it is handed to, and nothing layers HOCON over it.

readonly optional runCoordinatedShutdown?: boolean

Defined in: src/ActorSystem.ts:132

Run the coordinated-shutdown pipeline before the teardown, with ActorSystemTerminateReason — every task in every phase, so the HTTP unbind, the broker close and the cluster leave the framework registers there, and whatever the application added. false is the bare teardown terminate() has always been, which reaches none of them. Unset takes the choice from actor-ts.coordinated-shutdown.run-by-actor-system-terminate, which is off unless configured (#1455) — so a value here beats the config, as an explicit option does everywhere.