gaxios

constructor

constructor(defaults?: GaxiosOptions);

• The Gaxios class is responsible for making HTTP requests.

  Parameter defaults

  The default set of options to be used for this instance.

property agentCache

protected agentCache: Map<any, any>;

property defaults

defaults: GaxiosOptions;

• Default HTTP options that will be used for every HTTP request.

property interceptors

interceptors: {
    request: GaxiosInterceptorManager<GaxiosOptions>;
    response: GaxiosInterceptorManager<GaxiosResponse>;
};

• Interceptors

method request

request: <T = any>(opts?: GaxiosOptions) => GaxiosPromise<T>;

• Perform an HTTP request with the given options.

  Parameter opts

  Set of HTTP options that will be used for this HTTP request.

constructor

constructor(
    message: string,
    config: GaxiosOptions,
    response?: GaxiosResponse<T>,
    error?: any
);

property [GAXIOS_ERROR_SYMBOL]

[GAXIOS_ERROR_SYMBOL]: string;

• Support instanceof operator for GaxiosError across builds/duplicated files.

  See Also

  • GAXIOS_ERROR_SYMBOL

  • https://github.com/microsoft/TypeScript/issues/13965#issuecomment-278570200

  • https://stackoverflow.com/questions/46618852/require-and-instanceof

  • https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function/@@hasInstance#reverting_to_default_instanceof_behavior

property code

code?: string;

• An Error code. See

  Example 1

  'ECONNRESET'

property config

config: GaxiosOptions;

property error

error?: any;

property response

response?: GaxiosResponse<T>;

property status

status?: number;

• An HTTP Status code. See

  Example 1

  500

method [Symbol.hasInstance]

static [Symbol.hasInstance]: (instance: unknown) => boolean;

• Support instanceof operator for GaxiosError across builds/duplicated files.

  See Also

  • GAXIOS_ERROR_SYMBOL

property rejected

rejected?: (err: GaxiosError) => void;

• Function to be run if the previous call to resolved throws / rejects or the request results in an invalid status as determined by the call to validateStatus.

  Parameter err

  The error thrown from the previously called resolved function.

property resolved

resolved?: (configOrResponse: T) => Promise<T>;

• Function to be run when applying an interceptor.

  Parameter configOrResponse

  The current configuration or response.

  Returns

  {Promise} Promise that resolves to the modified set of options or response.

property 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.

property agent

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

property baseUrl

baseUrl?: string;

• Deprecated

property baseURL

baseURL?: string | URL;

property body

body?: any;

property cert

cert?: string;

property data

data?: any;

property 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

  Modifiers

  • @experimental

property 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.

property follow

follow?: number;

property headers

headers?: Headers;

property key

key?: string;

property maxContentLength

maxContentLength?: number;

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

property maxRedirects

maxRedirects?: number;

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

property method

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

property multipart

multipart?: GaxiosMultipartOptions[];

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

property 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

  See Also

  • GaxiosOptions.proxy

property onUploadProgress

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

• Deprecated

  ignored

property params

params?: any;

property paramsSerializer

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

property 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.

  See Also

  • GaxiosOptions.noProxy

  • GaxiosOptions.agent

property responseType

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

property retry

retry?: boolean;

property retryConfig

retryConfig?: RetryConfig;

property signal

signal?: any;

property size

size?: number;

property timeout

timeout?: number;

property url

url?: string | URL;

property validateStatus

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

property config

config: GaxiosOptions;

property data

data: T;

property headers

headers: Headers;

property request

request: GaxiosXMLHttpRequest;

property status

status: number;

property statusText

statusText: string;

index signature

[index: string]: any;

property currentRetryAttempt

currentRetryAttempt?: number;

• The number of retries already attempted.

property httpMethodsToRetry

httpMethodsToRetry?: string[];

• The HTTP Methods that will be automatically retried. Defaults to ['GET','PUT','HEAD','OPTIONS','DELETE']

property maxRetryDelay

maxRetryDelay?: number;

property noResponseRetries

noResponseRetries?: number;

• When there is no response, the number of retries to attempt. Defaults to 2.

property onRetryAttempt

onRetryAttempt?: (err: GaxiosError) => Promise<void> | void;

• Function to invoke when a retry attempt is made.

property retry

retry?: number;

• The number of times to retry the request. Defaults to 3.

property retryBackoff

retryBackoff?: (err: GaxiosError, defaultBackoffMs: number) => Promise<void>;

• Function to invoke which returns a promise. After the promise resolves, the retry will be triggered. If provided, this will be used in-place of the retryDelay

property retryDelay

retryDelay?: number;

• The amount of time to initially delay the retry, in ms. Defaults to 100ms.

property retryDelayMultiplier

retryDelayMultiplier?: number;

property shouldRetry

shouldRetry?: (err: GaxiosError) => Promise<boolean> | boolean;

• Function to invoke which determines if you should retry

property statusCodesToRetry

statusCodesToRetry?: number[][];

• The HTTP response status codes that will automatically be retried. Defaults to: [[100, 199], [408, 408], [429, 429], [500, 599]]

property timeOfFirstRequest

timeOfFirstRequest?: number;

• Time that the initial request was made. Users should not set this directly.

property totalTimeout

totalTimeout?: number;

• The length of time to keep retrying in ms. The last sleep period will be shortened as necessary, so that the last retry runs at deadline (and not considerably beyond it). The total time starting from when the initial request is sent, after which an error will be returned, regardless of the retrying attempts made meanwhile. Defaults to Number.MAX_SAFE_INTEGER indicating to effectively ignore totalTimeout.