DiagnosticsOptionsBuilder
Defined in: src/diagnostics/DiagnosticsOptions.ts:169
Fluent builder for DiagnosticsOptionsType.
Extends
Section titled “Extends”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new DiagnosticsOptionsBuilder():
DiagnosticsOptionsBuilder
Returns
Section titled “Returns”DiagnosticsOptionsBuilder
Inherited from
Section titled “Inherited from”Methods
Section titled “Methods”build()
Section titled “build()”build():
Partial<T>
Defined in: src/util/OptionsBuilder.ts:51
Snapshot the set fields as an independent Partial<T> (own props only).
Returns
Section titled “Returns”Partial<T>
Inherited from
Section titled “Inherited from”withDebugEventStream()
Section titled “withDebugEventStream()”withDebugEventStream(
debugEventStream?):this
Defined in: src/diagnostics/DiagnosticsOptions.ts:206
Trace event-stream subscribe and unsubscribe. Never publish.
Parameters
Section titled “Parameters”debugEventStream?
Section titled “debugEventStream?”boolean = true
Returns
Section titled “Returns”this
withDebugLifecycle()
Section titled “withDebugLifecycle()”withDebugLifecycle(
debugLifecycle?):this
Defined in: src/diagnostics/DiagnosticsOptions.ts:201
Trace actor start, stop and restart.
Parameters
Section titled “Parameters”debugLifecycle?
Section titled “debugLifecycle?”boolean = true
Returns
Section titled “Returns”this
withDebugUnhandled()
Section titled “withDebugUnhandled()”withDebugUnhandled(
debugUnhandled?):this
Defined in: src/diagnostics/DiagnosticsOptions.ts:196
Trace messages an actor was handed and declined.
Parameters
Section titled “Parameters”debugUnhandled?
Section titled “debugUnhandled?”boolean = true
Returns
Section titled “Returns”this
withLogConfigOnStart()
Section titled “withLogConfigOnStart()”withLogConfigOnStart(
logConfigOnStart?):this
Defined in: src/diagnostics/DiagnosticsOptions.ts:191
Dump the merged configuration to the log once at startup.
Parameters
Section titled “Parameters”logConfigOnStart?
Section titled “logConfigOnStart?”boolean = true
Returns
Section titled “Returns”this
withLogDeadLetters()
Section titled “withLogDeadLetters()”withLogDeadLetters(
logDeadLetters):this
Defined in: src/diagnostics/DiagnosticsOptions.ts:176
Dead letters logged in full before logging suspends. 0 disables it.
Parameters
Section titled “Parameters”logDeadLetters
Section titled “logDeadLetters”number
Returns
Section titled “Returns”this
withLogDeadLettersDuringShutdown()
Section titled “withLogDeadLettersDuringShutdown()”withLogDeadLettersDuringShutdown(
logDeadLettersDuringShutdown):this
Defined in: src/diagnostics/DiagnosticsOptions.ts:181
Log the dead letters terminate()’s mailbox drain produces.
Parameters
Section titled “Parameters”logDeadLettersDuringShutdown
Section titled “logDeadLettersDuringShutdown”boolean
Returns
Section titled “Returns”this
withLogDeadLettersSuspendDurationMs()
Section titled “withLogDeadLettersSuspendDurationMs()”withLogDeadLettersSuspendDurationMs(
logDeadLettersSuspendDurationMs):this
Defined in: src/diagnostics/DiagnosticsOptions.ts:186
How long logging stays suspended after the cap. 0 never suspends.
Parameters
Section titled “Parameters”logDeadLettersSuspendDurationMs
Section titled “logDeadLettersSuspendDurationMs”number
Returns
Section titled “Returns”this
create()
Section titled “create()”
staticcreate():DiagnosticsOptionsBuilder
Defined in: src/diagnostics/DiagnosticsOptions.ts:171
Start a fresh builder.
Returns
Section titled “Returns”DiagnosticsOptionsBuilder
