Interface CallOptions

Options for a call. Every client should accept CallOptions as optional argument in its RPC methods.

interface CallOptions {
    contextValues?: ContextValues;
    headers?: HeadersInit;
    signal?: AbortSignal;
    timeoutMs?: number;
    onHeader?(headers): void;
    onTrailer?(trailers): void;
}

Properties

contextValues? headers? signal? timeoutMs?

Methods

onHeader? onTrailer?

Properties

Optional contextValues

contextValues?: ContextValues

ContextValues to pass to the interceptors.

Optional headers

headers?: HeadersInit

Custom headers to send with the request.

Optional signal

signal?: AbortSignal

An optional AbortSignal to cancel the call. If cancelled, an error with Code.Canceled is raised.

Optional timeoutMs

timeoutMs?: number

Timeout in milliseconds.

Set to <= 0 to disable the default timeout.

Methods

Optional onHeader

  • onHeader(headers): void

  • Called when response headers are received.

    Parameters

    • headers: Headers

    Returns void

Optional onTrailer

  • onTrailer(trailers): void

  • Called when response trailers are received.

    Parameters

    • trailers: Headers

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc