Interface GaxiosOptions (6.5.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.

Remarks

This does not replace the requirement for an active Data Loss Prevention (DLP) provider. For DLP suggestions, see: - https://cloud.google.com/sensitive-data-protection/docs/redacting-sensitive-data#dlp_deidentify_replace_infotype-nodejs - https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference#credentials_and_secrets

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';

multipart

multipart?: GaxiosMultipartOptions[];

A collection of parts to send as a Content-Type: multipart/related request.

noProxy

noProxy?: (string | URL | RegExp)[];

A list for excluding traffic for proxies. Available via process.env.NO_PROXY as well as a common-separated list of strings - merged with any local noProxy rules.

  • When provided a string, it is matched by - Wildcard *. and . matching are available. (e.g. .example.com or *.example.com) - When provided a URL, it is matched by the .origin property. - For example, requesting https://example.com with the following noProxys would result in a no proxy use: - new URL('https://example.com') - new URL('https://example.com:443') - The following would be used with a proxy: - new URL('http://example.com:80') - new URL('https://example.com:8443') - When provided a regular expression it is used to match the stringified URL

onUploadProgress

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

params

params?: any;

paramsSerializer

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

proxy

proxy?: string | URL;

An optional proxy to use for requests. Available via process.env.HTTP_PROXY and process.env.HTTPS_PROXY as well - with a preference for the this config option when multiple are available. The option overrides this.

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;