Skip to content

ServeStreamOptions

Defined in: src/serve-stream.ts:19

Options for serveStream — a single RPC session over one stream pair.

readable: ReadableStream<Uint8Array<ArrayBufferLike>> | ReadableStream;

Defined in: src/serve-stream.ts:22

Incoming request bytes — a web ReadableStream<Uint8Array> or a Node Readable (e.g. a Duplex bridging a MessagePort).


optional serverOptions?: VgiRpcServerOptions;

Defined in: src/serve-stream.ts:29

Passed through to the VgiRpcServer constructor (describe, hooks, …) when target is a bare Protocol. Refused alongside a built server: the options belong on that server.


optional transportKind?: TransportKind;

Defined in: src/serve-stream.ts:31

Reported to the on_serve_start hook. Defaults to PIPE.


optional writable?: number | Socket | ByteSink;

Defined in: src/serve-stream.ts:25

Outgoing response sink — a stdout-like fd number, or a net.Socket / structurally-compatible Duplex. Omit for the stdout fd.