Skip to content
2 min read · 358 words

Interface: ServeIsolatedOptions

Defined in: src/batteries/isolation/serve.ts:43

Options accepted by serveIsolated/serveIsolatedOverPort.

Extends

Properties

PropertyTypeDescriptionInherited fromDefined in
debugPayloads?booleanInclude payload bodies on call:*/wire:* reports (see IsolationReport.payload). Default false — payloads may be large/sensitive, so this is opt-in even when hooks are wired.IsolationObservabilityHooks.debugPayloadssrc/batteries/isolation/observability.ts:135
encodables?readonly { name: string; }[]Classes to register with @nhtio/encoder's custom-encodable round-trip on this side (sugar over registerClass; lazy — only touches the encoder peer when this array is non-empty).-src/batteries/isolation/serve.ts:46
onAbort?IsolationReportCallbackabort:sent — the host sent an abort envelope for an in-flight call.IsolationObservabilityHooks.onAbortsrc/batteries/isolation/observability.ts:128
onCall?IsolationReportCallbackcall:start / call:settle — a single request/response method call.IsolationObservabilityHooks.onCallsrc/batteries/isolation/observability.ts:124
onCodecEscalate?IsolationReportCallbackcodec:escalate — the codec escalated an argument past the 'raw' tier.IsolationObservabilityHooks.onCodecEscalatesrc/batteries/isolation/observability.ts:132
onCrashReport?IsolationReportCallbackcrash — the transport reported an unexpected guest exit/termination.IsolationObservabilityHooks.onCrashReportsrc/batteries/isolation/observability.ts:120
onDispose?IsolationReportCallbackdispose:start / dispose:done — graceful-then-forced teardown.IsolationObservabilityHooks.onDisposesrc/batteries/isolation/observability.ts:116
onIsolation?IsolationReportCallbackFires on EVERY report (the firehose).IsolationObservabilityHooks.onIsolationsrc/batteries/isolation/observability.ts:112
onRecycle?IsolationReportCallbackrecycle:start / recycle:done — terminate + reconnect through the same transport.IsolationObservabilityHooks.onRecyclesrc/batteries/isolation/observability.ts:118
onRespawnAuto?IsolationReportCallbackrespawn:auto — an autoRespawn crash-policy verdict was consulted and acted on.IsolationObservabilityHooks.onRespawnAutosrc/batteries/isolation/observability.ts:122
onSpawn?IsolationReportCallbackspawn:start / spawn:ready / spawn:error — guest connect lifecycle.IsolationObservabilityHooks.onSpawnsrc/batteries/isolation/observability.ts:114
onStream?IsolationReportCallbackstream:start / stream:end / stream:error / stream:cancel — a streaming method call.IsolationObservabilityHooks.onStreamsrc/batteries/isolation/observability.ts:126
onWire?IsolationReportCallbackwire:out / wire:in — every envelope crossing the wire (verbose; opt in deliberately).IsolationObservabilityHooks.onWiresrc/batteries/isolation/observability.ts:130