Type Alias EndpointCall<E>

EndpointCall: (
    EndpointCallArgs<E> extends undefined
        ? (args?: PerCallOverrides) => Promise<EndpointResponse<E>>
        : (
            args: EndpointCallArgs<E> & PerCallOverrides,
        ) => Promise<EndpointResponse<E>>
) & {
    file: EndpointCallArgs<E> extends undefined
        ? (args?: PerCallOverrides) => Promise<Blob>
        : (args: EndpointCallArgs<E> & PerCallOverrides) => Promise<Blob>;
    stream: EndpointCallArgs<E> extends undefined
        ? (options?: { signal?: AbortSignal }) => AsyncIterable<string>
        : (
            args: EndpointCallArgs<E> & { signal?: AbortSignal },
        ) => AsyncIterable<string>;
}

The callable signature for a single endpoint on the typed client.

When the endpoint requires arguments (path params, body, query, or headers) the function takes a single argument object. When no arguments are needed the function can be called with no arguments.

Every endpoint call also exposes a .stream() method that returns an AsyncIterable<string> yielding newline-delimited chunks (e.g. NDJSON). An optional AbortSignal can be passed to cancel an in-flight stream.

Type Alias EndpointCall<E>

Type Parameters

Settings