Type alias HTTPFetchOptions

HTTPFetchOptions: {
    body?: HTTPFetchBody;
    headers?: Record<string, string>;
    method?: string;
    qs?: Record<string, unknown>;
    req?: Request;
}

The options for a request.

Type declaration

  • Optional body?: HTTPFetchBody

    The body of the request.

  • Optional headers?: Record<string, string>

    The headers dictionary.

  • Optional method?: string

    The HTTP method.

    Default

    'GET'
  • Optional qs?: Record<string, unknown>

    A dictionary of query string parameters.

  • Optional req?: Request

    A request object generated by the application. This can be used to copy information like custom headers or the IP (for the X-Forwarded-For header).

Settings

Member Visibility

Theme

Generated using TypeDoc