Interface StdioJsonTransportOptions

Options for the standard JSON-line RPC stdio transport.

interface StdioJsonTransportOptions {
    lifecycle?: StreamLifecycleLike;
    readable: ReadableLike;
    writable: WritableLike;
    onInvalidFrame(frame: string, error?: unknown): void;
}

Hierarchy (View Summary)

StdioPlatformOptions
- StdioJsonTransportOptions

Index

Properties

lifecycle? readable writable

Methods

onInvalidFrame?

Properties

`Optional`lifecycle

lifecycle?: StreamLifecycleLike

Optional lifecycle event source enabling onClose on the transport.

readable

readable: ReadableLike

Readable stream that emits incoming JSON-line data.

writable

writable: WritableLike

Writable stream that receives outgoing JSON-line data.

Methods

`Optional`onInvalidFrame

onInvalidFrame(frame: string, error?: unknown): void
Observe stdout lines that are not valid RPC frames.
Parameters
- frame: string
- Optionalerror: unknown
Returns void
- Defined in packages/kkrpc/src/transports/stdio.ts:57