| # axios | |
| [](https://www.npmjs.org/package/axios) | |
| [](https://cdnjs.com/libraries/axios) | |
|  | |
| [](https://gitpod.io/#https://github.com/axios/axios) | |
| [](https://coveralls.io/r/mzabriskie/axios) | |
| [](https://packagephobia.now.sh/result?p=axios) | |
| [](http://npm-stat.com/charts.html?package=axios) | |
| [](https://gitter.im/mzabriskie/axios) | |
| [](https://www.codetriage.com/axios/axios) | |
| Promise based HTTP client for the browser and node.js | |
| > New axios docs website: [click here](https://axios-http.com/) | |
| ## Table of Contents | |
| - [Features](#features) | |
| - [Browser Support](#browser-support) | |
| - [Installing](#installing) | |
| - [Example](#example) | |
| - [Axios API](#axios-api) | |
| - [Request method aliases](#request-method-aliases) | |
| - [Concurrency (Deprecated)](#concurrency-deprecated) | |
| - [Creating an instance](#creating-an-instance) | |
| - [Instance methods](#instance-methods) | |
| - [Request Config](#request-config) | |
| - [Response Schema](#response-schema) | |
| - [Config Defaults](#config-defaults) | |
| - [Global axios defaults](#global-axios-defaults) | |
| - [Custom instance defaults](#custom-instance-defaults) | |
| - [Config order of precedence](#config-order-of-precedence) | |
| - [Interceptors](#interceptors) | |
| - [Handling Errors](#handling-errors) | |
| - [Cancellation](#cancellation) | |
| - [Using application/x-www-form-urlencoded format](#using-applicationx-www-form-urlencoded-format) | |
| - [Browser](#browser) | |
| - [Node.js](#nodejs) | |
| - [Query string](#query-string) | |
| - [Form data](#form-data) | |
| - [Semver](#semver) | |
| - [Promises](#promises) | |
| - [TypeScript](#typescript) | |
| - [Resources](#resources) | |
| - [Credits](#credits) | |
| - [License](#license) | |
| ## 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 | |
| - Automatic transforms for JSON data | |
| - Client side support for protecting against [XSRF](http://en.wikipedia.org/wiki/Cross-site_request_forgery) | |
| ## Browser Support | |
|  |  |  |  |  |  | | |
| --- | --- | --- | --- | --- | --- | | |
| Latest β | Latest β | Latest β | Latest β | Latest β | 11 β | | |
| [](https://saucelabs.com/u/axios) | |
| ## Installing | |
| Using npm: | |
| ```bash | |
| $ npm install axios | |
| ``` | |
| Using bower: | |
| ```bash | |
| $ bower install axios | |
| ``` | |
| Using yarn: | |
| ```bash | |
| $ yarn add axios | |
| ``` | |
| Using jsDelivr CDN: | |
| ```html | |
| <script src="https://cdn.jsdelivr.net/npm/axios/dist/axios.min.js"></script> | |
| ``` | |
| Using unpkg CDN: | |
| ```html | |
| <script src="https://unpkg.com/axios/dist/axios.min.js"></script> | |
| ``` | |
| ## Example | |
| ### note: CommonJS usage | |
| In order to gain the TypeScript typings (for intellisense / autocomplete) while using CommonJS imports with `require()` use the following approach: | |
| ```js | |
| const axios = require('axios').default; | |
| // axios.<method> will now provide autocomplete and parameter typings | |
| ``` | |
| Performing a `GET` request | |
| ```js | |
| 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); | |
| }) | |
| .then(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); | |
| }) | |
| .then(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. | |
| Performing a `POST` request | |
| ```js | |
| axios.post('/user', { | |
| firstName: 'Fred', | |
| lastName: 'Flintstone' | |
| }) | |
| .then(function (response) { | |
| console.log(response); | |
| }) | |
| .catch(function (error) { | |
| console.log(error); | |
| }); | |
| ``` | |
| Performing multiple concurrent requests | |
| ```js | |
| function getUserAccount() { | |
| return axios.get('/user/12345'); | |
| } | |
| function getUserPermissions() { | |
| return axios.get('/user/12345/permissions'); | |
| } | |
| Promise.all([getUserAccount(), getUserPermissions()]) | |
| .then(function (results) { | |
| const acct = results[0]; | |
| const perm = results[1]; | |
| }); | |
| ``` | |
| ## axios API | |
| Requests can be made by passing the relevant config to `axios`. | |
| ##### axios(config) | |
| ```js | |
| // Send a POST request | |
| axios({ | |
| method: 'post', | |
| url: '/user/12345', | |
| data: { | |
| firstName: 'Fred', | |
| lastName: 'Flintstone' | |
| } | |
| }); | |
| ``` | |
| ```js | |
| // 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]) | |
| ```js | |
| // 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]]) | |
| ###### NOTE | |
| When using the alias methods `url`, `method`, and `data` properties don't need to be specified in config. | |
| ### Concurrency (Deprecated) | |
| Please use `Promise.all` to replace the below functions. | |
| Helper functions for dealing with concurrent requests. | |
| axios.all(iterable) | |
| axios.spread(callback) | |
| ### Creating an instance | |
| You can create a new instance of axios with a custom config. | |
| ##### axios.create([config]) | |
| ```js | |
| 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]) | |
| ## 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. | |
| ```js | |
| { | |
| // `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 | |
| 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 | |
| // transitional options for backward compatibility that may be removed in the newer versions | |
| transitional: { | |
| // silent JSON parsing mode | |
| // `true` - ignore JSON parsing errors and set response.data to null if parsing failed (old behaviour) | |
| // `false` - throw SyntaxError if JSON parsing failed (Note: responseType must be set to 'json') | |
| silentJSONParsing: true, // default value for the current Axios version | |
| // try to parse the response string as JSON even if `responseType` is not 'json' | |
| forcedJSONParsing: true, | |
| // throw ETIMEDOUT error instead of generic ECONNABORTED on request timeouts | |
| clarifyTimeoutError: false, | |
| } | |
| } | |
| ``` | |
| ## Response Schema | |
| The response for a request contains the following information. | |
| ```js | |
| { | |
| // `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 | |
| 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: | |
| ```js | |
| 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. | |
| ## Config Defaults | |
| You can specify config defaults that will be applied to every request. | |
| ### Global axios defaults | |
| ```js | |
| axios.defaults.baseURL = 'https://api.example.com'; | |
| // Important: If axios is used with multiple domains, the AUTH_TOKEN will be sent to all of them. | |
| // See below for an example using Custom instance defaults instead. | |
| axios.defaults.headers.common['Authorization'] = AUTH_TOKEN; | |
| axios.defaults.headers.post['Content-Type'] = 'application/x-www-form-urlencoded'; | |
| ``` | |
| ### Custom instance defaults | |
| ```js | |
| // 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.js](https://github.com/axios/axios/blob/master/lib/defaults.js#L28), 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. | |
| ```js | |
| // 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 | |
| }); | |
| ``` | |
| ## Interceptors | |
| You can intercept requests or responses before they are handled by `then` or `catch`. | |
| ```js | |
| // 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. | |
| ```js | |
| const myInterceptor = axios.interceptors.request.use(function () {/*...*/}); | |
| axios.interceptors.request.eject(myInterceptor); | |
| ``` | |
| You can add interceptors to a custom instance of axios. | |
| ```js | |
| const instance = axios.create(); | |
| instance.interceptors.request.use(function () {/*...*/}); | |
| ``` | |
| When you add request interceptors, they are presumed to be asynchronous by default. This can cause a delay | |
| in the execution of your axios request when the main thread is blocked (a promise is created under the hood for | |
| the interceptor and your request gets put on the bottom of the call stack). If your request interceptors are synchronous you can add a flag | |
| to the options object that will tell axios to run the code synchronously and avoid any delays in request execution. | |
| ```js | |
| axios.interceptors.request.use(function (config) { | |
| config.headers.test = 'I am only a header!'; | |
| return config; | |
| }, null, { synchronous: true }); | |
| ``` | |
| If you want to execute a particular interceptor based on a runtime check, | |
| you can add a `runWhen` function to the options object. The interceptor will not be executed **if and only if** the return | |
| of `runWhen` is `false`. The function will be called with the config | |
| object (don't forget that you can bind your own arguments to it as well.) This can be handy when you have an | |
| asynchronous request interceptor that only needs to run at certain times. | |
| ```js | |
| function onGetCall(config) { | |
| return config.method === 'get'; | |
| } | |
| axios.interceptors.request.use(function (config) { | |
| config.headers.test = 'special get headers'; | |
| return config; | |
| }, null, { runWhen: onGetCall }); | |
| ``` | |
| ## Handling Errors | |
| ```js | |
| 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. | |
| ```js | |
| 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. | |
| ```js | |
| axios.get('/user/12345') | |
| .catch(function (error) { | |
| console.log(error.toJSON()); | |
| }); | |
| ``` | |
| ## Cancellation | |
| You can cancel a request using a *cancel token*. | |
| > The axios cancel token API is based on the withdrawn [cancelable promises proposal](https://github.com/tc39/proposal-cancelable-promises). | |
| You can create a cancel token using the `CancelToken.source` factory as shown below: | |
| ```js | |
| 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: | |
| ```js | |
| 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. | |
| > If a cancellation token is already cancelled at the moment of starting an Axios request, then the request is cancelled immediately, without any attempts to make real request. | |
| ## Using application/x-www-form-urlencoded format | |
| 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 options. | |
| ### Browser | |
| In a browser, you can use the [`URLSearchParams`](https://developer.mozilla.org/en-US/docs/Web/API/URLSearchParams) API as follows: | |
| ```js | |
| 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: | |
| ```js | |
| const qs = require('qs'); | |
| axios.post('/foo', qs.stringify({ 'bar': 123 })); | |
| ``` | |
| Or in another way (ES6), | |
| ```js | |
| 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: | |
| ```js | |
| 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: | |
| ```js | |
| 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). | |
| #### Form data | |
| In node.js, you can use the [`form-data`](https://github.com/form-data/form-data) library as follows: | |
| ```js | |
| 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, { headers: form.getHeaders() }) | |
| ``` | |
| Alternatively, use an interceptor: | |
| ```js | |
| axios.interceptors.request.use(config => { | |
| if (config.data instanceof FormData) { | |
| Object.assign(config.headers, config.data.getHeaders()); | |
| } | |
| return config; | |
| }); | |
| ``` | |
| ## 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 and a type guard for axios errors. | |
| ```typescript | |
| let user: User = null; | |
| try { | |
| const { data } = await axios.get('/user?ID=12345'); | |
| user = data.userDetails; | |
| } catch (error) { | |
| if (axios.isAxiosError(error)) { | |
| handleAxiosError(error); | |
| } else { | |
| handleUnexpectedError(error); | |
| } | |
| } | |
| ``` | |
| ## Online one-click setup | |
| You can use Gitpod an online IDE(which is free for Open Source) for contributing or running the examples online. | |
| [](https://gitpod.io/#https://github.com/axios/axios/blob/master/examples/server.js) | |
| ## 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](LICENSE) | |