Interface GaxiosOptions (6.3.0)

Request options that are used to form the request.

Package

gaxios

Properties

adapter

adapter?: <T = any>(options: GaxiosOptions, defaultAdapter: (options: GaxiosOptions) => GaxiosPromise<T>) => GaxiosPromise<T>;

Optional method to override making the actual HTTP request. Useful for writing tests.

agent

agent?: Agent | ((parsedUrl: URL) => Agent);

baseUrl

baseUrl?: string;

baseURL

baseURL?: string | URL;

body

body?: any;

cert

cert?: string;

data

data?: any;

errorRedactor

errorRedactor?: typeof defaultErrorRedactor | false;

An experimental error redactor.

fetchImplementation

fetchImplementation?: FetchImplementation;

Implementation of fetch to use when making the API call. By default, will use the browser context if available, and fall back to node-fetch in node.js otherwise.

follow

follow?: number;

headers

headers?: Headers;

key

key?: string;

maxContentLength

maxContentLength?: number;

The maximum size of the http response content in bytes allowed.

maxRedirects

maxRedirects?: number;

The maximum number of redirects to follow. Defaults to 20.

method

method?: 'GET' | 'HEAD' | 'POST' | 'DELETE' | 'PUT' | 'CONNECT' | 'OPTIONS' | 'TRACE' | 'PATCH';

onUploadProgress

onUploadProgress?: (progressEvent: any) => void;

params

params?: any;

paramsSerializer

paramsSerializer?: (params: {
        [index: string]: string | number;
    }) => string;

responseType

responseType?: 'arraybuffer' | 'blob' | 'json' | 'text' | 'stream' | 'unknown';

retry

retry?: boolean;

retryConfig

retryConfig?: RetryConfig;

signal

signal?: any;

size

size?: number;

timeout

timeout?: number;

url

url?: string | URL;

validateStatus

validateStatus?: (status: number) => boolean;