

Axios
=====

Promise based HTTP client for the browser and node.js

Axios is a simple promise based HTTP client for the browser and node.js. Axios provides a simple to use library in a small package with a very extensible interface.



 © 2020-present John Jakob "Jake" Sarjeant  
Licensed under the MIT License.  

<https://axios-http.com/docs/>

Getting Started
===============

 Promise based HTTP client for the browser and node.js

 What is Axios?
==============

 Axios is a *[promise-based](https://javascript.info/promise-basics)* HTTP Client for [`node.js`](https://nodejs.org) and the browser. It is *[isomorphic](https://www.lullabot.com/articles/what-is-an-isomorphic-application)* (= it can run in the browser and nodejs with the same codebase). On the server-side it uses the native node.js `http` module, while on the client (browser) it uses XMLHttpRequests.

 Features
========

 * Make [XMLHttpRequests](https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest) from the browser
* Make [http](http://nodejs.org/api/http.html) requests from node.js
* Supports the [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise) API
* Intercept request and response
* Transform request and response data
* Cancel requests
* Timeouts
* Query parameters serialization with support for nested entries
* Automatic request body serialization to:
	+ JSON (`application/json`)
	+ Multipart / FormData (`multipart/form-data`)
	+ URL encoded form (`application/x-www-form-urlencoded`)
* Posting HTML forms as JSON
* Automatic JSON data handling in response
* Progress capturing for browsers and node.js with extra info (speed rate, remaining time)
* Setting bandwidth limits for node.js
* Compatible with spec-compliant FormData and Blob (including `node.js`)
* Client side support for protecting against [XSRF](http://en.wikipedia.org/wiki/Cross-site_request_forgery)

 Installing
==========

 Using npm:

 
```
$ npm install axios

```
 Using bower:

 
```
$ bower install axios

```
 Using yarn:

 
```
$ yarn add axios

```
 Using jsDelivr CDN:

 
```
<script src="https://cdn.jsdelivr.net/npm/axios/dist/axios.min.js"></script>

```
 Using unpkg CDN:

 
```
<script src="https://unpkg.com/axios/dist/axios.min.js"></script>

```
 Prebuilt CommonJS modules for direct importing with require (if your module bundler failed to resolve them automatically)

 
```
const axios = require('axios/dist/browser/axios.cjs'); // browser
const axios = require('axios/dist/node/axios.cjs'); // node

```


 © 2020-present John Jakob "Jake" Sarjeant  
Licensed under the MIT License.  

<https://axios-http.com/docs/intro>

POST Requests
=============

 How to perform POST requests with Axios

 Performing a `POST` request
---------------------------

 ### JSON

 
```
axios.post('/user', {
    firstName: 'Fred',
    lastName: 'Flintstone'
  })
  .then(function (response) {
    console.log(response);
  })
  .catch(function (error) {
    console.log(error);
  });

```
 Performing multiple concurrent requests

 
```
function getUserAccount() {
  return axios.get('/user/12345');
}

function getUserPermissions() {
  return axios.get('/user/12345/permissions');
}

const [acct, perm] = await Promise.all([getUserAccount(), getUserPermissions()]);

// OR

Promise.all([getUserAccount(), getUserPermissions()])
  .then(function ([acct, perm]) {
    // ...
  });

```
 Post an HTML form as JSON

 
```
const {data} = await axios.post('/user', document.querySelector('#my-form'), {
  headers: {
    'Content-Type': 'application/json'
  }
})

```
 ### Forms

 * Multipart (`multipart/form-data`)

 
```
const {data} = await axios.post('https://httpbin.org/post', {
    firstName: 'Fred',
    lastName: 'Flintstone',
    orders: [1, 2, 3],
    photo: document.querySelector('#fileInput').files
  }, {
    headers: {
      'Content-Type': 'multipart/form-data'
    }
  }
)

```
 * URL encoded form (`application/x-www-form-urlencoded`)

 
```
const {data} = await axios.post('https://httpbin.org/post', {
    firstName: 'Fred',
    lastName: 'Flintstone',
    orders: [1, 2, 3]
  }, {
    headers: {
      'Content-Type': 'application/x-www-form-urlencoded'
    }
})

```


 © 2020-present John Jakob "Jake" Sarjeant  
Licensed under the MIT License.  

<https://axios-http.com/docs/post_example>

Minimal Example
===============

 A little example of using axios

 note: CommonJS usage
--------------------

 In order to gain the TypeScript typings (for intellisense / autocomplete) while using CommonJS imports with `require()` use the following approach:

 
```
const axios = require('axios').default;

// axios.<method> will now provide autocomplete and parameter typings

```
 Example
=======

 Performing a `GET` request

 
```
const axios = require('axios');

// Make a request for a user with a given ID
axios.get('/user?ID=12345')
  .then(function (response) {
    // handle success
    console.log(response);
  })
  .catch(function (error) {
    // handle error
    console.log(error);
  })
  .finally(function () {
    // always executed
  });

// Optionally the request above could also be done as
axios.get('/user', {
    params: {
      ID: 12345
    }
  })
  .then(function (response) {
    console.log(response);
  })
  .catch(function (error) {
    console.log(error);
  })
  .finally(function () {
    // always executed
  });  

// Want to use async/await? Add the `async` keyword to your outer function/method.
async function getUser() {
  try {
    const response = await axios.get('/user?ID=12345');
    console.log(response);
  } catch (error) {
    console.error(error);
  }
}

```
 
>  **NOTE:** `async/await` is part of ECMAScript 2017 and is not supported in Internet Explorer and older browsers, so use with caution.
> 
>  



 © 2020-present John Jakob "Jake" Sarjeant  
Licensed under the MIT License.  

<https://axios-http.com/docs/example>

Notes
=====

 A couple more notes to round it off

 Semver
------

 Until axios reaches a `1.0` release, breaking changes will be released with a new minor version. For example `0.5.1`, and `0.5.4` will have the same API, but `0.6.0` will have breaking changes.

 Promises
--------

 axios depends on a native ES6 Promise implementation to be [supported](http://caniuse.com/promises). If your environment doesn't support ES6 Promises, you can [polyfill](https://github.com/jakearchibald/es6-promise).

 TypeScript
----------

 axios includes [TypeScript](http://typescriptlang.org) definitions.

 
```
import axios from 'axios';
axios.get('/user?ID=12345');

```
 Resources
---------

 * [Changelog](https://github.com/axios/axios/blob/master/CHANGELOG.md)
* [Upgrade Guide](https://github.com/axios/axios/blob/master/UPGRADE_GUIDE.md)
* [Ecosystem](https://github.com/axios/axios/blob/master/ECOSYSTEM.md)
* [Contributing Guide](https://github.com/axios/axios/blob/master/CONTRIBUTING.md)
* [Code of Conduct](https://github.com/axios/axios/blob/master/CODE_OF_CONDUCT.md)

 Credits
-------

 axios is heavily inspired by the [$http service](https://docs.angularjs.org/api/ng/service/$http) provided in [Angular](https://angularjs.org/). Ultimately axios is an effort to provide a standalone `$http`-like service for use outside of Angular.

 License
-------

 [MIT](https://github.com/axios/axios/blob/master/LICENSE)



 © 2020-present John Jakob "Jake" Sarjeant  
Licensed under the MIT License.  

<https://axios-http.com/docs/notes>

The Axios Instance
==================

 ### Creating an instance

 You can create a new instance of axios with a custom config.

 ##### axios.create([config])

 
```
const instance = axios.create({
  baseURL: 'https://some-domain.com/api/',
  timeout: 1000,
  headers: {'X-Custom-Header': 'foobar'}
});

```
 ### Instance methods

 The available instance methods are listed below. The specified config will be merged with the instance config.

 ##### axios#request(config)

 ##### axios#get(url[, config])

 ##### axios#delete(url[, config])

 ##### axios#head(url[, config])

 ##### axios#options(url[, config])

 ##### axios#post(url[, data[, config]])

 ##### axios#put(url[, data[, config]])

 ##### axios#patch(url[, data[, config]])

 ##### axios#getUri([config])



 © 2020-present John Jakob "Jake" Sarjeant  
Licensed under the MIT License.  

<https://axios-http.com/docs/instance>

Interceptors
============

 You can intercept requests or responses before they are handled by `then` or `catch`.

 
```
// Add a request interceptor
axios.interceptors.request.use(function (config) {
    // Do something before request is sent
    return config;
  }, function (error) {
    // Do something with request error
    return Promise.reject(error);
  });

// Add a response interceptor
axios.interceptors.response.use(function (response) {
    // Any status code that lie within the range of 2xx cause this function to trigger
    // Do something with response data
    return response;
  }, function (error) {
    // Any status codes that falls outside the range of 2xx cause this function to trigger
    // Do something with response error
    return Promise.reject(error);
  });

```
 If you need to remove an interceptor later you can.

 
```
const myInterceptor = axios.interceptors.request.use(function () {/*...*/});
axios.interceptors.request.eject(myInterceptor);

```
 You can add interceptors to a custom instance of axios.

 
```
const instance = axios.create();
instance.interceptors.request.use(function () {/*...*/});

```


 © 2020-present John Jakob "Jake" Sarjeant  
Licensed under the MIT License.  

<https://axios-http.com/docs/interceptors>

Multipart Bodies
================

 Posting data as `multipart/form-data`
-------------------------------------

 ### Using FormData API

 #### Browser

 
```
const form = new FormData();
form.append('my_field', 'my value');
form.append('my_buffer', new Blob([1,2,3]));
form.append('my_file', fileInput.files[0]);

axios.post('https://example.com', form)

```
 The same result can be achieved using the internal Axios serializer and corresponding shorthand method:

 
```
axios.postForm('https://httpbin.org/post', {
  my_field: 'my value',
  my_buffer: new Blob([1,2,3]),
  my_file:  fileInput.files // FileList will be unwrapped as sepate fields
});

```
 HTML form can be passes directly as a request payload

 #### Node.js

 
```
import axios from 'axios';

const form = new FormData();
form.append('my_field', 'my value');
form.append('my_buffer', new Blob(['some content']));

axios.post('https://example.com', form)

```
 Since node.js does not currently support creating a `Blob` from a file, you can use a third-party package for this purpose.

 
```
import {fileFromPath} from 'formdata-node/file-from-path'

form.append('my_field', 'my value');
form.append('my_file', await fileFromPath('/foo/bar.jpg'));

axios.post('https://example.com', form)

```
 For Axios older than `v1.3.0` you must import `form-data` package.

 
```
const FormData = require('form-data');

const form = new FormData();
form.append('my_field', 'my value');
form.append('my_buffer', new Buffer(10));
form.append('my_file', fs.createReadStream('/foo/bar.jpg'));

axios.post('https://example.com', form)

```
 ### 🆕 Automatic serialization

 Starting from `v0.27.0`, Axios supports automatic object serialization to a FormData object if the request Content-Type header is set to `multipart/form-data`.

 The following request will submit the data in a FormData format (Browser & Node.js):

 
```
import axios from 'axios';

axios.post('https://httpbin.org/post', {
  user: {
    name: 'Dmitriy'
  },
  file: fs.createReadStream('/foo/bar.jpg')
}, {
  headers: {
    'Content-Type': 'multipart/form-data'
  }
}).then(({data})=> console.log(data));

```
 Axios FormData serializer supports some special endings to perform the following operations:

 * `{}` - serialize the value with JSON.stringify
* `[]` - unwrap the array-like object as separate fields with the same key

 
>  NOTE: unwrap/expand operation will be used by default on arrays and FileList objects
> 
>  

 FormData serializer supports additional options via `config.formSerializer: object` property to handle rare cases:

 * `visitor: Function` - user-defined visitor function that will be called recursively to serialize the data object to a `FormData` object by following custom rules.
* `dots: boolean = false` - use dot notation instead of brackets to serialize arrays and objects;
* `metaTokens: boolean = true` - add the special ending (e.g `user{}: '{"name": "John"}'`) in the FormData key. The back-end body-parser could potentially use this meta-information to automatically parse the value as JSON.
* `indexes: null|false|true = false` - controls how indexes will be added to unwrapped keys of `flat` array-like objects


	+ `null` - don't add brackets (`arr: 1`, `arr: 2`, `arr: 3`)
	+ `false`(default) - add empty brackets (`arr[]: 1`, `arr[]: 2`, `arr[]: 3`)
	+ `true` - add brackets with indexes (`arr[0]: 1`, `arr[1]: 2`, `arr[2]: 3`)

 Let's say we have an object like this one:

 
```
const obj = {
  x: 1,
  arr: [1, 2, 3],
  arr2: [1, [2], 3],
  users: [{name: 'Peter', surname: 'Griffin'}, {name: 'Thomas', surname: 'Anderson'}],
  'obj2{}': [{x:1}]
};

```
 The following steps will be executed by the Axios serializer internally:

 
```
const formData= new FormData();
formData.append('x', '1');
formData.append('arr[]', '1');
formData.append('arr[]', '2');
formData.append('arr[]', '3');
formData.append('arr2[0]', '1');
formData.append('arr2[1][0]', '2');
formData.append('arr2[2]', '3');
formData.append('users[0][name]', 'Peter');
formData.append('users[0][surname]', 'Griffin');
formData.append('users[1][name]', 'Thomas');
formData.append('users[1][surname]', 'Anderson');
formData.append('obj2{}', '[{"x":1}]');

```
 
```
import axios from 'axios';

axios.post('https://httpbin.org/post', {
  'myObj{}': {x: 1, s: "foo"},
  'files[]': document.querySelector('#fileInput').files 
}, {
  headers: {
    'Content-Type': 'multipart/form-data'
  }
}).then(({data})=> console.log(data));

```
 Axios supports the following shortcut methods: `postForm`, `putForm`, `patchForm` which are just the corresponding http methods with the content-type header preset to `multipart/form-data`.

 `FileList` object can be passed directly:

 
```
await axios.postForm('https://httpbin.org/post', document.querySelector('#fileInput').files)

```
 All files will be sent with the same field names: `files[]`;



 © 2020-present John Jakob "Jake" Sarjeant  
Licensed under the MIT License.  

<https://axios-http.com/docs/multipart>

Request Config
==============

 These are the available config options for making requests. Only the `url` is required. Requests will default to `GET` if `method` is not specified.

 
```
{
  // `url` is the server URL that will be used for the request
  url: '/user',

  // `method` is the request method to be used when making the request
  method: 'get', // default

  // `baseURL` will be prepended to `url` unless `url` is absolute.
  // It can be convenient to set `baseURL` for an instance of axios to pass relative URLs
  // to methods of that instance.
  baseURL: 'https://some-domain.com/api',

  // `transformRequest` allows changes to the request data before it is sent to the server
  // This is only applicable for request methods 'PUT', 'POST', 'PATCH' and 'DELETE'
  // The last function in the array must return a string or an instance of Buffer, ArrayBuffer,
  // FormData or Stream
  // You may modify the headers object.
  transformRequest: [function (data, headers) {
    // Do whatever you want to transform the data

    return data;
  }],

  // `transformResponse` allows changes to the response data to be made before
  // it is passed to then/catch
  transformResponse: [function (data) {
    // Do whatever you want to transform the data

    return data;
  }],

  // `headers` are custom headers to be sent
  headers: {'X-Requested-With': 'XMLHttpRequest'},

  // `params` are the URL parameters to be sent with the request
  // Must be a plain object or a URLSearchParams object
  // NOTE: params that are null or undefined are not rendered in the URL.
  params: {
    ID: 12345
  },

  // `paramsSerializer` is an optional function in charge of serializing `params`
  // (e.g. https://www.npmjs.com/package/qs, http://api.jquery.com/jquery.param/)
  paramsSerializer: function (params) {
    return Qs.stringify(params, {arrayFormat: 'brackets'})
  },

  // `data` is the data to be sent as the request body
  // Only applicable for request methods 'PUT', 'POST', 'DELETE', and 'PATCH'
  // When no `transformRequest` is set, must be of one of the following types:
  // - string, plain object, ArrayBuffer, ArrayBufferView, URLSearchParams
  // - Browser only: FormData, File, Blob
  // - Node only: Stream, Buffer
  data: {
    firstName: 'Fred'
  },
  
  // syntax alternative to send data into the body
  // method post
  // only the value is sent, not the key
  data: 'Country=Brasil&City=Belo Horizonte',

  // `timeout` specifies the number of milliseconds before the request times out.
  // If the request takes longer than `timeout`, the request will be aborted.
  timeout: 1000, // default is `0` (no timeout)

  // `withCredentials` indicates whether or not cross-site Access-Control requests
  // should be made using credentials
  withCredentials: false, // default

  // `adapter` allows custom handling of requests which makes testing easier.
  // Return a promise and supply a valid response (see lib/adapters/README.md).
  adapter: function (config) {
    /* ... */
  },

  // `auth` indicates that HTTP Basic auth should be used, and supplies credentials.
  // This will set an `Authorization` header, overwriting any existing
  // `Authorization` custom headers you have set using `headers`.
  // Please note that only HTTP Basic auth is configurable through this parameter.
  // For Bearer tokens and such, use `Authorization` custom headers instead.
  auth: {
    username: 'janedoe',
    password: 's00pers3cret'
  },

  // `responseType` indicates the type of data that the server will respond with
  // options are: 'arraybuffer', 'document', 'json', 'text', 'stream'
  //   browser only: 'blob'
  responseType: 'json', // default

  // `responseEncoding` indicates encoding to use for decoding responses (Node.js only)
  // Note: Ignored for `responseType` of 'stream' or client-side requests
  responseEncoding: 'utf8', // default

  // `xsrfCookieName` is the name of the cookie to use as a value for xsrf token
  xsrfCookieName: 'XSRF-TOKEN', // default

  // `xsrfHeaderName` is the name of the http header that carries the xsrf token value
  xsrfHeaderName: 'X-XSRF-TOKEN', // default

  // `onUploadProgress` allows handling of progress events for uploads
  // browser only
  onUploadProgress: function (progressEvent) {
    // Do whatever you want with the native progress event
  },

  // `onDownloadProgress` allows handling of progress events for downloads
  // browser only
  onDownloadProgress: function (progressEvent) {
    // Do whatever you want with the native progress event
  },

  // `maxContentLength` defines the max size of the http response content in bytes allowed in node.js
  maxContentLength: 2000,

  // `maxBodyLength` (Node only option) defines the max size of the http request content in bytes allowed
  maxBodyLength: 2000,

  // `validateStatus` defines whether to resolve or reject the promise for a given
  // HTTP response status code. If `validateStatus` returns `true` (or is set to `null`
  // or `undefined`), the promise will be resolved; otherwise, the promise will be
  // rejected.
  validateStatus: function (status) {
    return status >= 200 && status < 300; // default
  },

  // `maxRedirects` defines the maximum number of redirects to follow in node.js.
  // If set to 0, no redirects will be followed.
  maxRedirects: 5, // default

  // `socketPath` defines a UNIX Socket to be used in node.js.
  // e.g. '/var/run/docker.sock' to send requests to the docker daemon.
  // Only either `socketPath` or `proxy` can be specified.
  // If both are specified, `socketPath` is used.
  socketPath: null, // default

  // `httpAgent` and `httpsAgent` define a custom agent to be used when performing http
  // and https requests, respectively, in node.js. This allows options to be added like
  // `keepAlive` that are not enabled by default.
  httpAgent: new http.Agent({ keepAlive: true }),
  httpsAgent: new https.Agent({ keepAlive: true }),

  // `proxy` defines the hostname, port, and protocol of the proxy server.
  // You can also define your proxy using the conventional `http_proxy` and
  // `https_proxy` environment variables. If you are using environment variables
  // for your proxy configuration, you can also define a `no_proxy` environment
  // variable as a comma-separated list of domains that should not be proxied.
  // Use `false` to disable proxies, ignoring environment variables.
  // `auth` indicates that HTTP Basic auth should be used to connect to the proxy, and
  // supplies credentials.
  // This will set an `Proxy-Authorization` header, overwriting any existing
  // `Proxy-Authorization` custom headers you have set using `headers`.
  // If the proxy server uses HTTPS, then you must set the protocol to `https`. 
  proxy: {
    protocol: 'https',
    host: '127.0.0.1',
    port: 9000,
    auth: {
      username: 'mikeymike',
      password: 'rapunz3l'
    }
  },

  // `cancelToken` specifies a cancel token that can be used to cancel the request
  // (see Cancellation section below for details)
  cancelToken: new CancelToken(function (cancel) {
  }),

  // `decompress` indicates whether or not the response body should be decompressed 
  // automatically. If set to `true` will also remove the 'content-encoding' header 
  // from the responses objects of all decompressed responses
  // - Node only (XHR cannot turn off decompression)
  decompress: true // default

}

```


 © 2020-present John Jakob "Jake" Sarjeant  
Licensed under the MIT License.  

<https://axios-http.com/docs/req_config>

Config Defaults
===============

 Config Defaults
---------------

 You can specify config defaults that will be applied to every request.

 ### Global axios defaults

 
```
axios.defaults.baseURL = 'https://api.example.com';
axios.defaults.headers.common['Authorization'] = AUTH_TOKEN;
axios.defaults.headers.post['Content-Type'] = 'application/x-www-form-urlencoded';

```
 ### Custom instance defaults

 
```
// Set config defaults when creating the instance
const instance = axios.create({
  baseURL: 'https://api.example.com'
});

// Alter defaults after instance has been created
instance.defaults.headers.common['Authorization'] = AUTH_TOKEN;

```
 ### Config order of precedence

 Config will be merged with an order of precedence. The order is library defaults found in [lib/defaults/index.js](https://github.com/axios/axios/blob/649d739288c8e2c55829ac60e2345a0f3439c730/lib/defaults/index.js#L59), then `defaults` property of the instance, and finally `config` argument for the request. The latter will take precedence over the former. Here's an example.

 
```
// Create an instance using the config defaults provided by the library
// At this point the timeout config value is `0` as is the default for the library
const instance = axios.create();

// Override timeout default for the library
// Now all requests using this instance will wait 2.5 seconds before timing out
instance.defaults.timeout = 2500;

// Override timeout for this request as it's known to take a long time
instance.get('/longRequest', {
  timeout: 5000
});

```


 © 2020-present John Jakob "Jake" Sarjeant  
Licensed under the MIT License.  

<https://axios-http.com/docs/config_defaults>

Cancellation
============

 Cancelling requests
-------------------

 Setting the `timeout` property in an axios call handles **response** related timeouts.

 In some cases (e.g. network connection becomes unavailable) an axios call would benefit from cancelling the **connection** early. Without cancellation, the axios call can hang until the parent code/stack times out (might be a few minutes in a server-side applications).

 To terminate an axios call you can use following methods:

 * `signal`
* `cancelToken` (deprecated)

 Combining `timeout` and cancellation method (e.g. `signal`) should cover **response** related timeouts AND **connection** related timeouts.

 ### 
`signal`: AbortController

 Starting from `v0.22.0` Axios supports [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController) to cancel requests in fetch API way:

 
```
const controller = new AbortController();

axios.get('/foo/bar', {
   signal: controller.signal
}).then(function(response) {
   //...
});
// cancel the request
controller.abort()

```
 Example with a timeout using latest [`AbortSignal.timeout()`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal/timeout) API [nodejs 17.3+]:

 
```
axios.get('/foo/bar', {
   signal: AbortSignal.timeout(5000) //Aborts request after 5 seconds
}).then(function(response) {
   //...
});

```
 Example with a timeout helper function:

 
```
function newAbortSignal(timeoutMs) {
  const abortController = new AbortController();
  setTimeout(() => abortController.abort(), timeoutMs || 0);

  return abortController.signal;
}

axios.get('/foo/bar', {
   signal: newAbortSignal(5000) //Aborts request after 5 seconds
}).then(function(response) {
   //...
});

```
 ### CancelToken `deprecated`

 You can also cancel a request using a *CancelToken*.

 
>  The axios cancel token API is based on the withdrawn [cancelable promises proposal](https://github.com/tc39/proposal-cancelable-promises).
> 
>  

 
>  This API is deprecated since `v0.22.0` and shouldn't be used in new projects
> 
>  

 You can create a cancel token using the `CancelToken.source` factory as shown below:

 
```
const CancelToken = axios.CancelToken;
const source = CancelToken.source();

axios.get('/user/12345', {
  cancelToken: source.token
}).catch(function (thrown) {
  if (axios.isCancel(thrown)) {
    console.log('Request canceled', thrown.message);
  } else {
    // handle error
  }
});

axios.post('/user/12345', {
  name: 'new name'
}, {
  cancelToken: source.token
})

// cancel the request (the message parameter is optional)
source.cancel('Operation canceled by the user.');

```
 You can also create a cancel token by passing an executor function to the `CancelToken` constructor:

 
```
const CancelToken = axios.CancelToken;
let cancel;

axios.get('/user/12345', {
  cancelToken: new CancelToken(function executor(c) {
    // An executor function receives a cancel function as a parameter
    cancel = c;
  })
});

// cancel the request
cancel();

```
 
>  Note: you can cancel several requests with the same cancel token / signal.
> 
>  

 During the transition period, you can use both cancellation APIs, even for the same request:

 
```
const controller = new AbortController();

const CancelToken = axios.CancelToken;
const source = CancelToken.source();

axios.get('/user/12345', {
  cancelToken: source.token,
  signal: controller.signal
}).catch(function (thrown) {
  if (axios.isCancel(thrown)) {
    console.log('Request canceled', thrown.message);
  } else {
    // handle error
  }
});

axios.post('/user/12345', {
  name: 'new name'
}, {
  cancelToken: source.token
})

// cancel the request (the message parameter is optional)
source.cancel('Operation canceled by the user.');
// OR
controller.abort(); // the message parameter is not supported

```


 © 2020-present John Jakob "Jake" Sarjeant  
Licensed under the MIT License.  

<https://axios-http.com/docs/cancellation>

Translating the documentation
=============================

 To make Axios accessible to as many people as possible, it is important that these docs can be read in all languages. We always appreciate anyone who wants to help translate the documentation. This guide provides instructions for adding a translation to this documentation.

 Structure
---------

 Every translation is composed of a configuration file, `{language-shortcut}.lang.js` (for example, `en.lang.js` or `de.lang.js`) and the translated documentation files in `posts/{language-shortcut}/*.md` (for example `posts/en` or `posts/de`). `{language-shortcut}` should be replaced with your language's [ISO 639-1](https://en.wikipedia.org/wiki/ISO_639-1) two-letter code.

 Configuring your language
-------------------------

 * Copy `en.lang.js`.
* Rename it to `{language-shortcut}.lang.js`.
* Replace `display` with the name of your language, in your language. For example, if you're translating german, place “Deutsch” instead of “German”.
* Replace prefix with `/{language-shortcut}/`.
* Translate the values in the `p` and `t` fields.
* Translate all the properties labeled `text` in the sidebar. **Note:** Since the latest version of this documentation, links in the sidebar no longer need to be updated.

 ### Registering the configuration

 Once you've finished configuring your language and translating the phrases and links in the configuration file, you'll need to register it in the root configuration. To do this, open `inert.config.js` and add the following line near the top:

 
```
const {language-shortcut}Config = require('./{language-shortcut}.config.js');

```
 Of course, remember to replace `{language-shortuct}` with the correct [ISO 369-1](https://en.wikipedia.org/wiki/ISO_639-1) code (in the variable name, too!).

 Now, look for the `langs` constant. If this constant is located above your `require` statement, move your `require` statement above it. To the `langs` list, add the following object:

 
```
const langs = [
  ...
  {
    name: 'Some name that uniquely identifies your language, for example "English" or "German"',
    prefix: "The same prefix as in the configuration file",
    config: {language-shortcut}Config // The configuration object you imported earlier
  }
  ...
];

```
 Now, you can begin translating the files. Copy the folder `posts/en` into a new folder `posts/{language-shortcut}` and translate all the files (don't translate the filenames, of course).

 If you hit any problems, feel free to [create and issue](https://github.com/axios/axios-docs/issues/new/choose).



 © 2020-present John Jakob "Jake" Sarjeant  
Licensed under the MIT License.  

<https://axios-http.com/docs/translating>

Response Schema
===============

 The response for a request contains the following information.

 
```
{
  // `data` is the response that was provided by the server
  data: {},

  // `status` is the HTTP status code from the server response
  status: 200,

  // `statusText` is the HTTP status message from the server response
  // As of HTTP/2 status text is blank or unsupported.
  // (HTTP/2 RFC: https://www.rfc-editor.org/rfc/rfc7540#section-8.1.2.4)
  statusText: 'OK',

  // `headers` the HTTP headers that the server responded with
  // All header names are lower cased and can be accessed using the bracket notation.
  // Example: `response.headers['content-type']`
  headers: {},

  // `config` is the config that was provided to `axios` for the request
  config: {},

  // `request` is the request that generated this response
  // It is the last ClientRequest instance in node.js (in redirects)
  // and an XMLHttpRequest instance in the browser
  request: {}
}

```
 When using `then`, you will receive the response as follows:

 
```
axios.get('/user/12345')
  .then(function (response) {
    console.log(response.data);
    console.log(response.status);
    console.log(response.statusText);
    console.log(response.headers);
    console.log(response.config);
  });

```
 When using `catch`, or passing a [rejection callback](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise/then) as second parameter of `then`, the response will be available through the `error` object as explained in the [Handling Errors](handling_errors) section.



 © 2020-present John Jakob "Jake" Sarjeant  
Licensed under the MIT License.  

<https://axios-http.com/docs/res_schema>

Handling Errors
===============

 
```
axios.get('/user/12345')
  .catch(function (error) {
    if (error.response) {
      // The request was made and the server responded with a status code
      // that falls out of the range of 2xx
      console.log(error.response.data);
      console.log(error.response.status);
      console.log(error.response.headers);
    } else if (error.request) {
      // The request was made but no response was received
      // `error.request` is an instance of XMLHttpRequest in the browser and an instance of
      // http.ClientRequest in node.js
      console.log(error.request);
    } else {
      // Something happened in setting up the request that triggered an Error
      console.log('Error', error.message);
    }
    console.log(error.config);
  });

```
 Using the `validateStatus` config option, you can define HTTP code(s) that should throw an error.

 
```
axios.get('/user/12345', {
  validateStatus: function (status) {
    return status < 500; // Resolve only if the status code is less than 500
  }
})

```
 Using `toJSON` you get an object with more information about the HTTP error.

 
```
axios.get('/user/12345')
  .catch(function (error) {
    console.log(error.toJSON());
  });

```


 © 2020-present John Jakob "Jake" Sarjeant  
Licensed under the MIT License.  

<https://axios-http.com/docs/handling_errors>

URL-Encoding Bodies
===================

 By default, axios serializes JavaScript objects to `JSON`. To send data in the `application/x-www-form-urlencoded` format instead, you can use one of the following approaches.

 ### Browser

 In a browser, you can use the [`URLSearchParams`](https://developer.mozilla.org/en-US/docs/Web/API/URLSearchParams) API as follows:

 
```
const params = new URLSearchParams();
params.append('param1', 'value1');
params.append('param2', 'value2');
axios.post('/foo', params);

```
 
>  Note that `URLSearchParams` is not supported by all browsers (see [caniuse.com](http://www.caniuse.com/#feat=urlsearchparams)), but there is a [polyfill](https://github.com/WebReflection/url-search-params) available (make sure to polyfill the global environment).
> 
>  

 Alternatively, you can encode data using the [`qs`](https://github.com/ljharb/qs) library:

 
```
const qs = require('qs');
axios.post('/foo', qs.stringify({ 'bar': 123 }));

```
 Or in another way (ES6),

 
```
import qs from 'qs';
const data = { 'bar': 123 };
const options = {
  method: 'POST',
  headers: { 'content-type': 'application/x-www-form-urlencoded' },
  data: qs.stringify(data),
  url,
};
axios(options);

```
 ### Node.js

 #### Query string

 In node.js, you can use the [`querystring`](https://nodejs.org/api/querystring.html) module as follows:

 
```
const querystring = require('querystring');
axios.post('http://something.com/', querystring.stringify({ foo: 'bar' }));

```
 or ['URLSearchParams'](https://nodejs.org/api/url.html#url_class_urlsearchparams) from ['url module'](https://nodejs.org/api/url.html) as follows:

 
```
const url = require('url');
const params = new url.URLSearchParams({ foo: 'bar' });
axios.post('http://something.com/', params.toString());

```
 You can also use the [`qs`](https://github.com/ljharb/qs) library.

 
>  Note: The `qs` library is preferable if you need to stringify nested objects, as the `querystring` method has known issues with that use case (<https://github.com/nodejs/node-v0.x-archive/issues/1665>).
> 
>  

 ### 🆕 Automatic serialization

 Axios will automatically serialize the data object to urlencoded format if the `content-type` header is set to `application/x-www-form-urlencoded`.

 This works both in the browser and in `node.js`:

 
```
const data = {
  x: 1,
  arr: [1, 2, 3],
  arr2: [1, [2], 3],
  users: [{name: 'Peter', surname: 'Griffin'}, {name: 'Thomas', surname: 'Anderson'}],
};

await axios.post('https://postman-echo.com/post', data,
  {headers: {'content-type': 'application/x-www-form-urlencoded'}}
);

```
 The server will handle it as

 
```
  {
    x: '1',
    'arr[]': [ '1', '2', '3' ],
    'arr2[0]': '1',
    'arr2[1][0]': '2',
    'arr2[2]': '3',
    'arr3[]': [ '1', '2', '3' ],
    'users[0][name]': 'Peter',
    'users[0][surname]': 'griffin',
    'users[1][name]': 'Thomas',
    'users[1][surname]': 'Anderson'
  }

```
 If your server framework's request body parser (like `body-parser` of `express.js`) supports nested objects decoding, you will automatically receive the same server object that you submitted.

 Echo server example (`express.js`) :

 
```
  var app = express();
  
  app.use(bodyParser.urlencoded({ extended: true })); // support url-encoded bodies
  
  app.post('/', function (req, res, next) {
     res.send(JSON.stringify(req.body));
  });

  server = app.listen(3000);

```


 © 2020-present John Jakob "Jake" Sarjeant  
Licensed under the MIT License.  

<https://axios-http.com/docs/urlencoded>

Axios API
=========

 The Axios API Reference

 Requests can be made by passing the relevant config to `axios`.

 ##### axios(config)

 
```
// Send a POST request
axios({
  method: 'post',
  url: '/user/12345',
  data: {
    firstName: 'Fred',
    lastName: 'Flintstone'
  }
});

```
 
```
// GET request for remote image in node.js
axios({
  method: 'get',
  url: 'http://bit.ly/2mTM3nY',
  responseType: 'stream'
})
  .then(function (response) {
    response.data.pipe(fs.createWriteStream('ada_lovelace.jpg'))
  });

```
 ##### axios(url[, config])

 
```
// Send a GET request (default method)
axios('/user/12345');

```
 ### Request method aliases

 For convenience aliases have been provided for all supported request methods.

 ##### axios.request(config)

 ##### axios.get(url[, config])

 ##### axios.delete(url[, config])

 ##### axios.head(url[, config])

 ##### axios.options(url[, config])

 ##### axios.post(url[, data[, config]])

 ##### axios.put(url[, data[, config]])

 ##### axios.patch(url[, data[, config]])

 ##### axios.postForm(url[, data[, config]])

 ##### axios.putForm(url[, data[, config]])

 ##### axios.patchForm(url[, data[, config]])

 ###### NOTE

 When using the alias methods `url`, `method`, and `data` properties don't need to be specified in config.



 © 2020-present John Jakob "Jake" Sarjeant  
Licensed under the MIT License.  

<https://axios-http.com/docs/api_intro>

axios