Type Alias HTTPRequest<T>

HTTPRequest<T>: {
    client_timeout_ms: number;
    data: T;
    headers: Record<string, string | undefined>;
    method: "POST";
    path?: SupportedFaunaAPIPaths;
}

An object representing an http request. The Client provides this to the HTTPClient implementation.

Type Parameters

Type declaration

  • client_timeout_ms: number

    The timeout of each http request, in milliseconds.

  • data: T

    The encoded Fauna query to send

  • headers: Record<string, string | undefined>

    Headers in object format

  • method: "POST"

    HTTP method to use

  • Optionalpath?: SupportedFaunaAPIPaths

    The path of the endpoint to call if not using the default

Settings

Member Visibility