Gaxios

An HTTP request client that provides an axios like interface over top of no...

HTTP client • Fetch • AJAX
googleapis/gaxiosgaxios

README

gaxios


An HTTP request client that provides an axios like interface over top of node-fetch.


Install


  1. ```sh
  2. $ npm install gaxios
  3. ```

Example


  1. ```js
  2. const {request} = require('gaxios');
  3. const res = await request({
  4.   url: 'https://www.googleapis.com/discovery/v1/apis/',
  5. });
  6. ```

Setting Defaults


Gaxios supports setting default properties both on the default instance, and on additional instances. This is often useful when making many requests to the same domain with the same base settings. For example:

  1. ```js
  2. const gaxios = require('gaxios');
  3. gaxios.instance.defaults = {
  4.   baseURL: 'https://example.com'
  5.   headers: {
  6.     Authorization: 'SOME_TOKEN'
  7.   }
  8. }
  9. gaxios.request({url: '/data'}).then(...);
  10. ```

Note that setting default values will take precedence
over other authentication methods, i.e., application default credentials.

Request Options


  1. ```js
  2. {
  3.   // The url to which the request should be sent.  Required.
  4.   url: string,

  6.   // The HTTP method to use for the request.  Defaults to `GET`.
  7.   method: 'GET',

  9.   // The base Url to use for the request. Prepended to the `url` property above.
  10.   baseURL: 'https://example.com';

  12.   // The HTTP methods to be sent with the request.
  13.   headers: { 'some': 'header' },

  15.   // The data to send in the body of the request. Data objects will be
  16.   // serialized as JSON.
  17.   //
  18.   // Note: if you would like to provide a Content-Type header other than
  19.   // application/json you you must provide a string or readable stream, rather
  20.   // than an object:
  21.   // data: JSON.stringify({some: 'data'})
  22.   // data: fs.readFile('./some-data.jpeg')
  23.   data: {
  24.     some: 'data'
  25.   },

  27.   // The max size of the http response content in bytes allowed.
  28.   // Defaults to `0`, which is the same as unset.
  29.   maxContentLength: 2000,

  31.   // The max number of HTTP redirects to follow.
  32.   // Defaults to 100.
  33.   maxRedirects: 100,

  35.   // The querystring parameters that will be encoded using `qs` and
  36.   // appended to the url
  37.   params: {
  38.     querystring: 'parameters'
  39.   },

  41.   // By default, we use the `querystring` package in node core to serialize
  42.   // querystring parameters.  You can override that and provide your
  43.   // own implementation.
  44.   paramsSerializer: (params) => {
  45.     return qs.stringify(params);
  46.   },

  48.   // The timeout for the HTTP request in milliseconds. Defaults to 0.
  49.   timeout: 1000,

  51.   // Optional method to override making the actual HTTP request. Useful
  52.   // for writing tests and instrumentation
  53.   adapter?: async (options, defaultAdapter) => {
  54.     const res = await defaultAdapter(options);
  55.     res.data = {
  56.       ...res.data,
  57.       extraProperty: 'your extra property',
  58.     };
  59.     return res;
  60.   };

  62.   // The expected return type of the request.  Options are:
  63.   // json | stream | blob | arraybuffer | text | unknown
  64.   // Defaults to `unknown`.
  65.   responseType: 'unknown',

  67.   // The node.js http agent to use for the request.
  68.   agent: someHttpsAgent,

  70.   // Custom function to determine if the response is valid based on the
  71.   // status code.  Defaults to (>= 200 && < 300)
  72.   validateStatus: (status: number) => true,

  74.   // Implementation of `fetch` to use when making the API call. By default,
  75.   // will use the browser context if available, and fall back to `node-fetch`
  76.   // in node.js otherwise.
  77.   fetchImplementation?: typeof fetch;

  79.   // Configuration for retrying of requests.
  80.   retryConfig: {
  81.     // The number of times to retry the request.  Defaults to 3.
  82.     retry?: number;

  84.     // The number of retries already attempted.
  85.     currentRetryAttempt?: number;

  87.     // The HTTP Methods that will be automatically retried.
  88.     // Defaults to ['GET','PUT','HEAD','OPTIONS','DELETE']
  89.     httpMethodsToRetry?: string[];

  91.     // The HTTP response status codes that will automatically be retried.
  92.     // Defaults to: [[100, 199], [429, 429], [500, 599]]
  93.     statusCodesToRetry?: number[][];

  95.     // Function to invoke when a retry attempt is made.
  96.     onRetryAttempt?: (err: GaxiosError) => Promise<void> | void;

  98.     // Function to invoke which determines if you should retry
  99.     shouldRetry?: (err: GaxiosError) => Promise<boolean> | boolean;

  101.     // When there is no response, the number of retries to attempt. Defaults to 2.
  102.     noResponseRetries?: number;

  104.     // The amount of time to initially delay the retry, in ms.  Defaults to 100ms.
  105.     retryDelay?: number;
  106.   },

  108.   // Enables default configuration for retries.
  109.   retry: boolean,

  111.   // Cancelling a request requires the `abort-controller` library.
  112.   // See https://github.com/bitinn/node-fetch#request-cancellation-with-abortsignal
  113.   signal?: AbortSignal

  115.   /**
  116.    * An experimental, customizable error redactor.
  117.    *
  118.    * Set `false` to disable.
  119.    *
  120.    * @experimental
  121.    */
  122.   errorRedactor?: typeof defaultErrorRedactor | false;
  123. }
  124. ```

License


Apache-2.0