Promise based HTTP client for the browser and node.js. New axios docs website: click here. Config Defaults. Using application/x-www-form-urlencoded formatNode.jsForm data. Node.jsForm data. 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. Using jsDelivr CDN:. Using unpkg CDN:. In order to gain the TypeScript typings (for intellisense / autocomplete) while using CommonJS imports with require() use the following approach:. Performing a GET request. NOTE:async/await is part of ECMAScript 2017 and is not supported in InternetExplorer and older browsers, so use with caution.
Performing a POST request. Performing multiple concurrent requests. Requests can be made by passing the relevant config to axios. For convenience, aliases have been provided for all common request methods. When using the alias methods url, method, and data properties don't need to be specified in config.
How do you upload a file in Node.js?
Please use Promise.all to replace the below functions. Helper functions for dealing with concurrent requests. You can create a new instance of axios with a custom config. The available instance methods are listed below.
The specified config will be merged with the instance 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.
The response for a request contains the following information.
Everything put together
When using then, you will receive the response as follows:. 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.
You can specify config defaults that will be applied to every request. 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. You can intercept requests or responses before they are handled by then or catch.
If you need to remove an interceptor later you can. You can add interceptors to a custom instance of axios. When you add request interceptors, they are presumed to be asynchronous by default.
This can cause a delayin the execution of your axios request when the main thread is blocked (a promise is created under the hood forthe interceptor and your request gets put on the bottom of the call stack).
If your request interceptors are synchronous you can add a flagto the options object that will tell axios to run the code synchronously and avoid any delays in request execution.
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 returnof runWhen is false. The function will be called with the configobject (don't forget that you can bind your own arguments to it as well.) This can be handy when you have anasynchronous request interceptor that only needs to run at certain times.
Given you add multiple response interceptorsand when the response was fulfilled.
then each interceptor is executed. then they are executed in the order they were added. then only the last interceptor's result is returned. then every interceptor receives the result of it's predecessor.
and when the fulfillment-interceptor throwsthen the following fulfillment-interceptor is not calledthen the following rejection-interceptor is calledonce caught, another following fulfill-interceptor is called again (just like in a promise chain).
then the following fulfillment-interceptor is not called. then the following rejection-interceptor is called. once caught, another following fulfill-interceptor is called again (just like in a promise chain). Read the interceptor tests for seeing all this in code. Using the validateStatus config option, you can define HTTP code(s) that should throw an error.
Using toJSON you get an object with more information about the HTTP error.
Starting from v0.22.0 Axios supports AbortController to cancel requests in fetch API way:. You can also cancel a request using a CancelToken.
The axios cancel token API is based on the withdrawn cancelable promises proposal.
Table of Contents
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:. You can also create a cancel token by passing an executor function to the CancelToken constructor:.
Note: you can cancel several requests with the same cancel token/abort controller.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.
During the transition period, you can use both cancellation APIs, even for the same request:.
1. Install NodeJS
Alternatively, you can encode data using the qs library:.
Or in another way (ES6),. In node.js, you can use the querystring module as follows:.