@flowscripter/pluggable-io-framework-api
    Preparing search index...

    Interface StreamHandle<K>

    A handle to a readable or writable stream of a single, declared PayloadKind - homogeneous, so consumers never need to test each item's kind. Plus optional capability methods for providers/decorators that support more than plain sequential read/write - see the capability interfaces and is* guards in capability/.

    interface StreamHandle<K extends PayloadKind = PayloadKind> {
        bounded?: boolean;
        kind: K;
        payloadType?: string;
        stream: ReadableStream<ItemOfKind<K>> | WritableStream<ItemOfKind<K>>;
    }

    Type Parameters

    Index
    bounded? kind payloadType? stream
    bounded?: boolean

    Whether the stream has a natural end. Defaults to true; false marks a live source that runs until end-of-stream or a stop. Always declared, never inferred from a missing size.

    kind: K
    payloadType?: string

    The payload type ID carried by this stream. Defaults to BYTES_PAYLOAD_TYPE. Confirmed by the open handle, since some sources only know it after connecting.

    stream: ReadableStream<ItemOfKind<K>> | WritableStream<ItemOfKind<K>>

    Settings
    Member Visibility

    On This Page
    Properties