@protobuf-ts/twirp-transport/build/types/twirp-options.d.ts

Twirp transport for clients generated by the protoc plugin "protobuf-ts".

import { RpcOptions } from "@protobuf-ts/runtime-rpc";
export interface TwirpOptions extends RpcOptions {
    /**
     * Base URI for all HTTP requests.
     *
     * Requests will be made to <baseUrl>/<package>.<service>/method
     *
     * If you need the "twirp" path prefix, you must add it yourself.
     *
     * Example: `baseUrl: "https://example.com/twirp"`
     *
     * This will make a `POST /twirp/my_package.MyService/Foo` to
     * `example.com` via HTTPS.
     */
    baseUrl: string;
    /**
     * For Twirp, method names are CamelCased just as they would be in Go.
     * To use the original method name as defined in the .proto, set this
     * option to `true`.
     */
    useProtoMethodName?: boolean;
    /**
     * Send JSON? Defaults to false, which means binary
     * format is sent.
     */
    sendJson?: boolean;
    /**
     * Extra options to pass through to the fetch when doing a request.
     *
     * Example: `fetchInit: { credentials: 'include' }`
     *
     * This will make requests include cookies for cross-origin calls.
     */
    fetchInit?: Omit<RequestInit, 'body' | 'headers' | 'method' | 'signal'>;
}