Skip to content

buildErrorStream

function buildErrorStream(
error,
schema?,
serverId?,
requestId?,
includeTraceback?
): Uint8Array;

Defined in: src/wire/public.ts:92

Build a complete IPC stream carrying a single error batch.

This is the wire shape an intermediary returns to deny or abort a call in-band — the client decodes it back into a thrown error. schema defaults to an empty schema, matching Python’s build_error_stream.

The batch carries the error model (vgi_rpc.error_code always, kind and details when error declares them). includeTraceback defaults to true, as on every server transport (WIRE_PROTOCOL.md §8).

Parameter Type Default value
error Error undefined
schema? VgiSchema undefined
serverId? string ""
requestId? string | null null
includeTraceback? boolean true

Uint8Array