connect-bidi-web
    Preparing search index...

    Interface ConnectWebSocketTransport

    A connect-es Transport carrying streaming RPCs over WebSocket, plus control over the shared multiplexed connection.

    interface ConnectWebSocketTransport {
        close(): void;
        stream<I extends DescMessage, O extends DescMessage>(
            method: DescMethodStreaming<I, O>,
            signal: AbortSignal | undefined,
            timeoutMs: number | undefined,
            header: HeadersInit | undefined,
            input: AsyncIterable<MessageInitShape<I>>,
            contextValues?: ContextValues,
        ): Promise<StreamResponse<I, O>>;
        unary<I extends DescMessage, O extends DescMessage>(
            method: DescMethodUnary<I, O>,
            signal: AbortSignal | undefined,
            timeoutMs: number | undefined,
            header: HeadersInit | undefined,
            input: MessageInitShape<I>,
            contextValues?: ContextValues,
        ): Promise<UnaryResponse<I, O>>;
    }

    Hierarchy

    • Transport
      • ConnectWebSocketTransport
    Index
    close stream unary

    • Closes the shared multiplexed connection, if one is open, terminating any RPCs still running on it. The transport remains usable: the next RPC dials a new connection. Useful outside the browser (tests, CLI tools), where an open WebSocket keeps the process alive.

      Returns void

    • Call a streaming RPC - a method that takes zero or more input messages, and responds with zero or more output messages.

      Type Parameters

      • I extends DescMessage
      • O extends DescMessage

      Parameters

      • method: DescMethodStreaming<I, O>
      • signal: AbortSignal | undefined
      • timeoutMs: number | undefined
      • header: HeadersInit | undefined
      • input: AsyncIterable<MessageInitShape<I>>
      • OptionalcontextValues: ContextValues

      Returns Promise<StreamResponse<I, O>>

    • Call a unary RPC - a method that takes a single input message, and responds with a single output message.

      Type Parameters

      • I extends DescMessage
      • O extends DescMessage

      Parameters

      • method: DescMethodUnary<I, O>
      • signal: AbortSignal | undefined
      • timeoutMs: number | undefined
      • header: HeadersInit | undefined
      • input: MessageInitShape<I>
      • OptionalcontextValues: ContextValues

      Returns Promise<UnaryResponse<I, O>>

    Settings
    Member Visibility

    On This Page
    Methods