axios
Promise based HTTP client for the browser and node.js
Features
- Make XMLHttpRequests from the browser
- Make http requests from node.js
- Supports the 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
Browser Support
Latest ✔ | Latest ✔ | Latest ✔ | Latest ✔ | Latest ✔ | 11 ✔ |
Installing
Using npm:
$ npm install axios
Using bower:
$ bower install axios
Using cdn:
Example
Performing a GET
request
const axios = ; // Make a request for a user with a given IDaxios ; // Optionally the request above could also be done asaxios ; // Want to use async/await? Add the `async` keyword to your outer function/method. { try const response = await axios; console; catch error console; }
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
axios ;
Performing multiple concurrent requests
{ return axios;} { return axios;} axiosall ;
axios API
Requests can be made by passing the relevant config to axios
.
axios(config)
// Send a POST request;
// GET request for remote image ;
axios(url[, config])
// Send a GET request (default method);
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
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])
const instance = axios;
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.
// `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', and 'PATCH' // 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: { // 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: { // 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/) { return Qs } // `data` is the data to be sent as the request body // Only applicable for request methods 'PUT', 'POST', 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' // `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). { /* ... */ } // `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`. auth: username: 'janedoe' password: 's00pers3cret' // `responseType` indicates the type of data that the server will respond with // options are 'arraybuffer', 'blob', 'document', 'json', 'text', 'stream' responseType: 'json' // default // `responseEncoding` indicates encoding to use for decoding responses // 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 { // Do whatever you want with the native progress event } // `onDownloadProgress` allows handling of progress events for downloads { // Do whatever you want with the native progress event } // `maxContentLength` defines the max size of the http response content in bytes allowed maxContentLength: 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. { 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: keepAlive: true httpsAgent: keepAlive: true // 'proxy' defines the hostname and port 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`. proxy: 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: { }
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 statusText: 'OK' // `headers` the headers that the server responded with // All header names are lower cased 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 the browser request: {}
When using then
, you will receive the response as follows:
axios ;
When using catch
, or passing a rejection callback as second parameter of then
, the response will be available through the error
object as explained in the Handling Errors section.
Config Defaults
You can specify config defaults that will be applied to every request.
Global axios defaults
axiosdefaultsbaseURL = 'https://api.example.com';axiosdefaultsheaderscommon'Authorization' = AUTH_TOKEN;axiosdefaultsheaderspost'Content-Type' = 'application/x-www-form-urlencoded';
Custom instance defaults
// Set config defaults when creating the instanceconst instance = axios; // Alter defaults after instance has been createdinstancedefaultsheaderscommon'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, 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 libraryconst instance = axios; // Override timeout default for the library// Now all requests using this instance will wait 2.5 seconds before timing outinstancedefaultstimeout = 2500; // Override timeout for this request as it's known to take a long timeinstance;
Interceptors
You can intercept requests or responses before they are handled by then
or catch
.
// Add a request interceptoraxiosinterceptorsrequest; // Add a response interceptoraxiosinterceptorsresponse;
If you may need to remove an interceptor later you can.
const myInterceptor = axiosinterceptorsrequest;axiosinterceptorsrequest;
You can add interceptors to a custom instance of axios.
const instance = axios;instanceinterceptorsrequest;
Handling Errors
axios ;
You can define a custom HTTP status code error range using the validateStatus
config option.
axios
Cancellation
You can cancel a request using a cancel token.
The axios cancel token API is based on the withdrawn cancelable promises proposal.
You can create a cancel token using the CancelToken.source
factory as shown below:
const CancelToken = axiosCancelToken;const source = CancelTokensource; axios; axios // cancel the request (the message parameter is optional)source;
You can also create a cancel token by passing an executor function to the CancelToken
constructor:
const CancelToken = axiosCancelToken;let cancel; axios; // cancel the request;
Note: you can cancel several requests with the same cancel token.
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
API as follows:
const params = ;params;params;axios;
Note that
URLSearchParams
is not supported by all browsers (see caniuse.com), but there is a polyfill available (make sure to polyfill the global environment).
Alternatively, you can encode data using the qs
library:
const qs = ;axios;
Or in another way (ES6),
;const data = 'bar': 123 ;const options = method: 'POST' headers: 'content-type': 'application/x-www-form-urlencoded' data: qs url;;
Node.js
In node.js, you can use the querystring
module as follows:
const querystring = ;axios;
You can also use the 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).
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. If your environment doesn't support ES6 Promises, you can polyfill.
TypeScript
axios includes TypeScript definitions.
;axios.get'/user?ID=12345';
Resources
Credits
axios is heavily inspired by the $http service provided in Angular. Ultimately axios is an effort to provide a standalone $http
-like service for use outside of Angular.
License
MIT