1 | # axios
|
2 |
|
3 | [![npm version](https://img.shields.io/npm/v/axios.svg?style=flat-square)](https://www.npmjs.org/package/axios)
|
4 | [![CDNJS](https://img.shields.io/cdnjs/v/axios.svg?style=flat-square)](https://cdnjs.com/libraries/axios)
|
5 | ![Build status](https://github.com/axios/axios/actions/workflows/ci.yml/badge.svg)
|
6 | [![Gitpod Ready-to-Code](https://img.shields.io/badge/Gitpod-Ready--to--Code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/axios/axios)
|
7 | [![code coverage](https://img.shields.io/coveralls/mzabriskie/axios.svg?style=flat-square)](https://coveralls.io/r/mzabriskie/axios)
|
8 | [![install size](https://packagephobia.now.sh/badge?p=axios)](https://packagephobia.now.sh/result?p=axios)
|
9 | [![npm downloads](https://img.shields.io/npm/dm/axios.svg?style=flat-square)](http://npm-stat.com/charts.html?package=axios)
|
10 | [![gitter chat](https://img.shields.io/gitter/room/mzabriskie/axios.svg?style=flat-square)](https://gitter.im/mzabriskie/axios)
|
11 | [![code helpers](https://www.codetriage.com/axios/axios/badges/users.svg)](https://www.codetriage.com/axios/axios)
|
12 | [![Known Vulnerabilities](https://snyk.io/test/npm/axios/badge.svg)](https://snyk.io/test/npm/axios)
|
13 |
|
14 | Promise based HTTP client for the browser and node.js
|
15 |
|
16 | > New axios docs website: [click here](https://axios-http.com/)
|
17 |
|
18 | ## Table of Contents
|
19 |
|
20 | - [Features](#features)
|
21 | - [Browser Support](#browser-support)
|
22 | - [Installing](#installing)
|
23 | - [Example](#example)
|
24 | - [Axios API](#axios-api)
|
25 | - [Request method aliases](#request-method-aliases)
|
26 | - [Concurrency 👎](#concurrency-deprecated)
|
27 | - [Creating an instance](#creating-an-instance)
|
28 | - [Instance methods](#instance-methods)
|
29 | - [Request Config](#request-config)
|
30 | - [Response Schema](#response-schema)
|
31 | - [Config Defaults](#config-defaults)
|
32 | - [Global axios defaults](#global-axios-defaults)
|
33 | - [Custom instance defaults](#custom-instance-defaults)
|
34 | - [Config order of precedence](#config-order-of-precedence)
|
35 | - [Interceptors](#interceptors)
|
36 | - [Multiple Interceptors](#multiple-interceptors)
|
37 | - [Handling Errors](#handling-errors)
|
38 | - [Cancellation](#cancellation)
|
39 | - [AbortController](#abortcontroller)
|
40 | - [CancelToken 👎](#canceltoken-deprecated)
|
41 | - [Using application/x-www-form-urlencoded format](#using-applicationx-www-form-urlencoded-format)
|
42 | - [Browser](#browser)
|
43 | - [Node.js](#nodejs)
|
44 | - [Query string](#query-string)
|
45 | - [Form data](#form-data)
|
46 | - [Automatic serialization](#-automatic-serialization)
|
47 | - [Manual FormData passing](#manual-formdata-passing)
|
48 | - [Semver](#semver)
|
49 | - [Promises](#promises)
|
50 | - [TypeScript](#typescript)
|
51 | - [Resources](#resources)
|
52 | - [Credits](#credits)
|
53 | - [License](#license)
|
54 |
|
55 | ## Features
|
56 |
|
57 | - Make [XMLHttpRequests](https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest) from the browser
|
58 | - Make [http](http://nodejs.org/api/http.html) requests from node.js
|
59 | - Supports the [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise) API
|
60 | - Intercept request and response
|
61 | - Transform request and response data
|
62 | - Cancel requests
|
63 | - Automatic transforms for JSON data
|
64 | - Client side support for protecting against [XSRF](http://en.wikipedia.org/wiki/Cross-site_request_forgery)
|
65 |
|
66 | ## Browser Support
|
67 |
|
68 | ![Chrome](https://raw.github.com/alrra/browser-logos/master/src/chrome/chrome_48x48.png) | ![Firefox](https://raw.github.com/alrra/browser-logos/master/src/firefox/firefox_48x48.png) | ![Safari](https://raw.github.com/alrra/browser-logos/master/src/safari/safari_48x48.png) | ![Opera](https://raw.github.com/alrra/browser-logos/master/src/opera/opera_48x48.png) | ![Edge](https://raw.github.com/alrra/browser-logos/master/src/edge/edge_48x48.png) | ![IE](https://raw.github.com/alrra/browser-logos/master/src/archive/internet-explorer_9-11/internet-explorer_9-11_48x48.png) |
|
69 | --- | --- | --- | --- | --- | --- |
|
70 | Latest ✔ | Latest ✔ | Latest ✔ | Latest ✔ | Latest ✔ | 11 ✔ |
|
71 |
|
72 | [![Browser Matrix](https://saucelabs.com/open_sauce/build_matrix/axios.svg)](https://saucelabs.com/u/axios)
|
73 |
|
74 | ## Installing
|
75 |
|
76 | Using npm:
|
77 |
|
78 | ```bash
|
79 | $ npm install axios
|
80 | ```
|
81 |
|
82 | Using bower:
|
83 |
|
84 | ```bash
|
85 | $ bower install axios
|
86 | ```
|
87 |
|
88 | Using yarn:
|
89 |
|
90 | ```bash
|
91 | $ yarn add axios
|
92 | ```
|
93 |
|
94 | Using jsDelivr CDN:
|
95 |
|
96 | ```html
|
97 | <script src="https://cdn.jsdelivr.net/npm/axios/dist/axios.min.js"></script>
|
98 | ```
|
99 |
|
100 | Using unpkg CDN:
|
101 |
|
102 | ```html
|
103 | <script src="https://unpkg.com/axios/dist/axios.min.js"></script>
|
104 | ```
|
105 |
|
106 | ## Example
|
107 |
|
108 | ### note: CommonJS usage
|
109 | In order to gain the TypeScript typings (for intellisense / autocomplete) while using CommonJS imports with `require()` use the following approach:
|
110 |
|
111 | ```js
|
112 | const axios = require('axios').default;
|
113 |
|
114 | // axios.<method> will now provide autocomplete and parameter typings
|
115 | ```
|
116 |
|
117 | Performing a `GET` request
|
118 |
|
119 | ```js
|
120 | const axios = require('axios').default;
|
121 |
|
122 | // Make a request for a user with a given ID
|
123 | axios.get('/user?ID=12345')
|
124 | .then(function (response) {
|
125 | // handle success
|
126 | console.log(response);
|
127 | })
|
128 | .catch(function (error) {
|
129 | // handle error
|
130 | console.log(error);
|
131 | })
|
132 | .then(function () {
|
133 | // always executed
|
134 | });
|
135 |
|
136 | // Optionally the request above could also be done as
|
137 | axios.get('/user', {
|
138 | params: {
|
139 | ID: 12345
|
140 | }
|
141 | })
|
142 | .then(function (response) {
|
143 | console.log(response);
|
144 | })
|
145 | .catch(function (error) {
|
146 | console.log(error);
|
147 | })
|
148 | .then(function () {
|
149 | // always executed
|
150 | });
|
151 |
|
152 | // Want to use async/await? Add the `async` keyword to your outer function/method.
|
153 | async function getUser() {
|
154 | try {
|
155 | const response = await axios.get('/user?ID=12345');
|
156 | console.log(response);
|
157 | } catch (error) {
|
158 | console.error(error);
|
159 | }
|
160 | }
|
161 | ```
|
162 |
|
163 | > **NOTE:** `async/await` is part of ECMAScript 2017 and is not supported in Internet
|
164 | > Explorer and older browsers, so use with caution.
|
165 |
|
166 | Performing a `POST` request
|
167 |
|
168 | ```js
|
169 | axios.post('/user', {
|
170 | firstName: 'Fred',
|
171 | lastName: 'Flintstone'
|
172 | })
|
173 | .then(function (response) {
|
174 | console.log(response);
|
175 | })
|
176 | .catch(function (error) {
|
177 | console.log(error);
|
178 | });
|
179 | ```
|
180 |
|
181 | Performing multiple concurrent requests
|
182 |
|
183 | ```js
|
184 | function getUserAccount() {
|
185 | return axios.get('/user/12345');
|
186 | }
|
187 |
|
188 | function getUserPermissions() {
|
189 | return axios.get('/user/12345/permissions');
|
190 | }
|
191 |
|
192 | Promise.all([getUserAccount(), getUserPermissions()])
|
193 | .then(function (results) {
|
194 | const acct = results[0];
|
195 | const perm = results[1];
|
196 | });
|
197 | ```
|
198 |
|
199 | ## axios API
|
200 |
|
201 | Requests can be made by passing the relevant config to `axios`.
|
202 |
|
203 | ##### axios(config)
|
204 |
|
205 | ```js
|
206 | // Send a POST request
|
207 | axios({
|
208 | method: 'post',
|
209 | url: '/user/12345',
|
210 | data: {
|
211 | firstName: 'Fred',
|
212 | lastName: 'Flintstone'
|
213 | }
|
214 | });
|
215 | ```
|
216 |
|
217 | ```js
|
218 | // GET request for remote image in node.js
|
219 | axios({
|
220 | method: 'get',
|
221 | url: 'http://bit.ly/2mTM3nY',
|
222 | responseType: 'stream'
|
223 | })
|
224 | .then(function (response) {
|
225 | response.data.pipe(fs.createWriteStream('ada_lovelace.jpg'))
|
226 | });
|
227 | ```
|
228 |
|
229 | ##### axios(url[, config])
|
230 |
|
231 | ```js
|
232 | // Send a GET request (default method)
|
233 | axios('/user/12345');
|
234 | ```
|
235 |
|
236 | ### Request method aliases
|
237 |
|
238 | For convenience, aliases have been provided for all common request methods.
|
239 |
|
240 | ##### axios.request(config)
|
241 | ##### axios.get(url[, config])
|
242 | ##### axios.delete(url[, config])
|
243 | ##### axios.head(url[, config])
|
244 | ##### axios.options(url[, config])
|
245 | ##### axios.post(url[, data[, config]])
|
246 | ##### axios.put(url[, data[, config]])
|
247 | ##### axios.patch(url[, data[, config]])
|
248 |
|
249 | ###### NOTE
|
250 | When using the alias methods `url`, `method`, and `data` properties don't need to be specified in config.
|
251 |
|
252 | ### Concurrency (Deprecated)
|
253 | Please use `Promise.all` to replace the below functions.
|
254 |
|
255 | Helper functions for dealing with concurrent requests.
|
256 |
|
257 | axios.all(iterable)
|
258 | axios.spread(callback)
|
259 |
|
260 | ### Creating an instance
|
261 |
|
262 | You can create a new instance of axios with a custom config.
|
263 |
|
264 | ##### axios.create([config])
|
265 |
|
266 | ```js
|
267 | const instance = axios.create({
|
268 | baseURL: 'https://some-domain.com/api/',
|
269 | timeout: 1000,
|
270 | headers: {'X-Custom-Header': 'foobar'}
|
271 | });
|
272 | ```
|
273 |
|
274 | ### Instance methods
|
275 |
|
276 | The available instance methods are listed below. The specified config will be merged with the instance config.
|
277 |
|
278 | ##### axios#request(config)
|
279 | ##### axios#get(url[, config])
|
280 | ##### axios#delete(url[, config])
|
281 | ##### axios#head(url[, config])
|
282 | ##### axios#options(url[, config])
|
283 | ##### axios#post(url[, data[, config]])
|
284 | ##### axios#put(url[, data[, config]])
|
285 | ##### axios#patch(url[, data[, config]])
|
286 | ##### axios#getUri([config])
|
287 |
|
288 | ## Request Config
|
289 |
|
290 | These are the available config options for making requests. Only the `url` is required. Requests will default to `GET` if `method` is not specified.
|
291 |
|
292 | ```js
|
293 | {
|
294 | // `url` is the server URL that will be used for the request
|
295 | url: '/user',
|
296 |
|
297 | // `method` is the request method to be used when making the request
|
298 | method: 'get', // default
|
299 |
|
300 | // `baseURL` will be prepended to `url` unless `url` is absolute.
|
301 | // It can be convenient to set `baseURL` for an instance of axios to pass relative URLs
|
302 | // to methods of that instance.
|
303 | baseURL: 'https://some-domain.com/api/',
|
304 |
|
305 | // `transformRequest` allows changes to the request data before it is sent to the server
|
306 | // This is only applicable for request methods 'PUT', 'POST', 'PATCH' and 'DELETE'
|
307 | // The last function in the array must return a string or an instance of Buffer, ArrayBuffer,
|
308 | // FormData or Stream
|
309 | // You may modify the headers object.
|
310 | transformRequest: [function (data, headers) {
|
311 | // Do whatever you want to transform the data
|
312 |
|
313 | return data;
|
314 | }],
|
315 |
|
316 | // `transformResponse` allows changes to the response data to be made before
|
317 | // it is passed to then/catch
|
318 | transformResponse: [function (data) {
|
319 | // Do whatever you want to transform the data
|
320 |
|
321 | return data;
|
322 | }],
|
323 |
|
324 | // `headers` are custom headers to be sent
|
325 | headers: {'X-Requested-With': 'XMLHttpRequest'},
|
326 |
|
327 | // `params` are the URL parameters to be sent with the request
|
328 | // Must be a plain object or a URLSearchParams object
|
329 | params: {
|
330 | ID: 12345
|
331 | },
|
332 |
|
333 | // `paramsSerializer` is an optional function in charge of serializing `params`
|
334 | // (e.g. https://www.npmjs.com/package/qs, http://api.jquery.com/jquery.param/)
|
335 | paramsSerializer: function (params) {
|
336 | return Qs.stringify(params, {arrayFormat: 'brackets'})
|
337 | },
|
338 |
|
339 | // `data` is the data to be sent as the request body
|
340 | // Only applicable for request methods 'PUT', 'POST', 'DELETE , and 'PATCH'
|
341 | // When no `transformRequest` is set, must be of one of the following types:
|
342 | // - string, plain object, ArrayBuffer, ArrayBufferView, URLSearchParams
|
343 | // - Browser only: FormData, File, Blob
|
344 | // - Node only: Stream, Buffer
|
345 | data: {
|
346 | firstName: 'Fred'
|
347 | },
|
348 |
|
349 | // syntax alternative to send data into the body
|
350 | // method post
|
351 | // only the value is sent, not the key
|
352 | data: 'Country=Brasil&City=Belo Horizonte',
|
353 |
|
354 | // `timeout` specifies the number of milliseconds before the request times out.
|
355 | // If the request takes longer than `timeout`, the request will be aborted.
|
356 | timeout: 1000, // default is `0` (no timeout)
|
357 |
|
358 | // `withCredentials` indicates whether or not cross-site Access-Control requests
|
359 | // should be made using credentials
|
360 | withCredentials: false, // default
|
361 |
|
362 | // `adapter` allows custom handling of requests which makes testing easier.
|
363 | // Return a promise and supply a valid response (see lib/adapters/README.md).
|
364 | adapter: function (config) {
|
365 | /* ... */
|
366 | },
|
367 |
|
368 | // `auth` indicates that HTTP Basic auth should be used, and supplies credentials.
|
369 | // This will set an `Authorization` header, overwriting any existing
|
370 | // `Authorization` custom headers you have set using `headers`.
|
371 | // Please note that only HTTP Basic auth is configurable through this parameter.
|
372 | // For Bearer tokens and such, use `Authorization` custom headers instead.
|
373 | auth: {
|
374 | username: 'janedoe',
|
375 | password: 's00pers3cret'
|
376 | },
|
377 |
|
378 | // `responseType` indicates the type of data that the server will respond with
|
379 | // options are: 'arraybuffer', 'document', 'json', 'text', 'stream'
|
380 | // browser only: 'blob'
|
381 | responseType: 'json', // default
|
382 |
|
383 | // `responseEncoding` indicates encoding to use for decoding responses (Node.js only)
|
384 | // Note: Ignored for `responseType` of 'stream' or client-side requests
|
385 | responseEncoding: 'utf8', // default
|
386 |
|
387 | // `xsrfCookieName` is the name of the cookie to use as a value for xsrf token
|
388 | xsrfCookieName: 'XSRF-TOKEN', // default
|
389 |
|
390 | // `xsrfHeaderName` is the name of the http header that carries the xsrf token value
|
391 | xsrfHeaderName: 'X-XSRF-TOKEN', // default
|
392 |
|
393 | // `onUploadProgress` allows handling of progress events for uploads
|
394 | // browser only
|
395 | onUploadProgress: function (progressEvent) {
|
396 | // Do whatever you want with the native progress event
|
397 | },
|
398 |
|
399 | // `onDownloadProgress` allows handling of progress events for downloads
|
400 | // browser only
|
401 | onDownloadProgress: function (progressEvent) {
|
402 | // Do whatever you want with the native progress event
|
403 | },
|
404 |
|
405 | // `maxContentLength` defines the max size of the http response content in bytes allowed in node.js
|
406 | maxContentLength: 2000,
|
407 |
|
408 | // `maxBodyLength` (Node only option) defines the max size of the http request content in bytes allowed
|
409 | maxBodyLength: 2000,
|
410 |
|
411 | // `validateStatus` defines whether to resolve or reject the promise for a given
|
412 | // HTTP response status code. If `validateStatus` returns `true` (or is set to `null`
|
413 | // or `undefined`), the promise will be resolved; otherwise, the promise will be
|
414 | // rejected.
|
415 | validateStatus: function (status) {
|
416 | return status >= 200 && status < 300; // default
|
417 | },
|
418 |
|
419 | // `maxRedirects` defines the maximum number of redirects to follow in node.js.
|
420 | // If set to 0, no redirects will be followed.
|
421 | maxRedirects: 21, // default
|
422 |
|
423 | // `beforeRedirect` defines a function that will be called before redirect.
|
424 | // Use this to adjust the request options upon redirecting,
|
425 | // to inspect the latest response headers,
|
426 | // or to cancel the request by throwing an error
|
427 | // If maxRedirects is set to 0, `beforeRedirect` is not used.
|
428 | beforeRedirect: (options, { headers }) => {
|
429 | if (options.hostname === "example.com") {
|
430 | options.auth = "user:password";
|
431 | }
|
432 | };
|
433 |
|
434 | // `socketPath` defines a UNIX Socket to be used in node.js.
|
435 | // e.g. '/var/run/docker.sock' to send requests to the docker daemon.
|
436 | // Only either `socketPath` or `proxy` can be specified.
|
437 | // If both are specified, `socketPath` is used.
|
438 | socketPath: null, // default
|
439 |
|
440 | // `httpAgent` and `httpsAgent` define a custom agent to be used when performing http
|
441 | // and https requests, respectively, in node.js. This allows options to be added like
|
442 | // `keepAlive` that are not enabled by default.
|
443 | httpAgent: new http.Agent({ keepAlive: true }),
|
444 | httpsAgent: new https.Agent({ keepAlive: true }),
|
445 |
|
446 | // `proxy` defines the hostname, port, and protocol of the proxy server.
|
447 | // You can also define your proxy using the conventional `http_proxy` and
|
448 | // `https_proxy` environment variables. If you are using environment variables
|
449 | // for your proxy configuration, you can also define a `no_proxy` environment
|
450 | // variable as a comma-separated list of domains that should not be proxied.
|
451 | // Use `false` to disable proxies, ignoring environment variables.
|
452 | // `auth` indicates that HTTP Basic auth should be used to connect to the proxy, and
|
453 | // supplies credentials.
|
454 | // This will set an `Proxy-Authorization` header, overwriting any existing
|
455 | // `Proxy-Authorization` custom headers you have set using `headers`.
|
456 | // If the proxy server uses HTTPS, then you must set the protocol to `https`.
|
457 | proxy: {
|
458 | protocol: 'https',
|
459 | host: '127.0.0.1',
|
460 | port: 9000,
|
461 | auth: {
|
462 | username: 'mikeymike',
|
463 | password: 'rapunz3l'
|
464 | }
|
465 | },
|
466 |
|
467 | // `cancelToken` specifies a cancel token that can be used to cancel the request
|
468 | // (see Cancellation section below for details)
|
469 | cancelToken: new CancelToken(function (cancel) {
|
470 | }),
|
471 |
|
472 | // an alternative way to cancel Axios requests using AbortController
|
473 | signal: new AbortController().signal,
|
474 |
|
475 | // `decompress` indicates whether or not the response body should be decompressed
|
476 | // automatically. If set to `true` will also remove the 'content-encoding' header
|
477 | // from the responses objects of all decompressed responses
|
478 | // - Node only (XHR cannot turn off decompression)
|
479 | decompress: true // default
|
480 |
|
481 | // `insecureHTTPParser` boolean.
|
482 | // Indicates where to use an insecure HTTP parser that accepts invalid HTTP headers.
|
483 | // This may allow interoperability with non-conformant HTTP implementations.
|
484 | // Using the insecure parser should be avoided.
|
485 | // see options https://nodejs.org/dist/latest-v12.x/docs/api/http.html#http_http_request_url_options_callback
|
486 | // see also https://nodejs.org/en/blog/vulnerability/february-2020-security-releases/#strict-http-header-parsing-none
|
487 | insecureHTTPParser: undefined // default
|
488 |
|
489 | // transitional options for backward compatibility that may be removed in the newer versions
|
490 | transitional: {
|
491 | // silent JSON parsing mode
|
492 | // `true` - ignore JSON parsing errors and set response.data to null if parsing failed (old behaviour)
|
493 | // `false` - throw SyntaxError if JSON parsing failed (Note: responseType must be set to 'json')
|
494 | silentJSONParsing: true, // default value for the current Axios version
|
495 |
|
496 | // try to parse the response string as JSON even if `responseType` is not 'json'
|
497 | forcedJSONParsing: true,
|
498 |
|
499 | // throw ETIMEDOUT error instead of generic ECONNABORTED on request timeouts
|
500 | clarifyTimeoutError: false,
|
501 | },
|
502 |
|
503 | env: {
|
504 | // The FormData class to be used to automatically serialize the payload into a FormData object
|
505 | FormData: window?.FormData || global?.FormData
|
506 | }
|
507 | }
|
508 | ```
|
509 |
|
510 | ## Response Schema
|
511 |
|
512 | The response for a request contains the following information.
|
513 |
|
514 | ```js
|
515 | {
|
516 | // `data` is the response that was provided by the server
|
517 | data: {},
|
518 |
|
519 | // `status` is the HTTP status code from the server response
|
520 | status: 200,
|
521 |
|
522 | // `statusText` is the HTTP status message from the server response
|
523 | statusText: 'OK',
|
524 |
|
525 | // `headers` the HTTP headers that the server responded with
|
526 | // All header names are lower cased and can be accessed using the bracket notation.
|
527 | // Example: `response.headers['content-type']`
|
528 | headers: {},
|
529 |
|
530 | // `config` is the config that was provided to `axios` for the request
|
531 | config: {},
|
532 |
|
533 | // `request` is the request that generated this response
|
534 | // It is the last ClientRequest instance in node.js (in redirects)
|
535 | // and an XMLHttpRequest instance in the browser
|
536 | request: {}
|
537 | }
|
538 | ```
|
539 |
|
540 | When using `then`, you will receive the response as follows:
|
541 |
|
542 | ```js
|
543 | axios.get('/user/12345')
|
544 | .then(function (response) {
|
545 | console.log(response.data);
|
546 | console.log(response.status);
|
547 | console.log(response.statusText);
|
548 | console.log(response.headers);
|
549 | console.log(response.config);
|
550 | });
|
551 | ```
|
552 |
|
553 | 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.
|
554 |
|
555 | ## Config Defaults
|
556 |
|
557 | You can specify config defaults that will be applied to every request.
|
558 |
|
559 | ### Global axios defaults
|
560 |
|
561 | ```js
|
562 | axios.defaults.baseURL = 'https://api.example.com';
|
563 |
|
564 | // Important: If axios is used with multiple domains, the AUTH_TOKEN will be sent to all of them.
|
565 | // See below for an example using Custom instance defaults instead.
|
566 | axios.defaults.headers.common['Authorization'] = AUTH_TOKEN;
|
567 |
|
568 | axios.defaults.headers.post['Content-Type'] = 'application/x-www-form-urlencoded';
|
569 | ```
|
570 |
|
571 | ### Custom instance defaults
|
572 |
|
573 | ```js
|
574 | // Set config defaults when creating the instance
|
575 | const instance = axios.create({
|
576 | baseURL: 'https://api.example.com'
|
577 | });
|
578 |
|
579 | // Alter defaults after instance has been created
|
580 | instance.defaults.headers.common['Authorization'] = AUTH_TOKEN;
|
581 | ```
|
582 |
|
583 | ### Config order of precedence
|
584 |
|
585 | 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.
|
586 |
|
587 | ```js
|
588 | // Create an instance using the config defaults provided by the library
|
589 | // At this point the timeout config value is `0` as is the default for the library
|
590 | const instance = axios.create();
|
591 |
|
592 | // Override timeout default for the library
|
593 | // Now all requests using this instance will wait 2.5 seconds before timing out
|
594 | instance.defaults.timeout = 2500;
|
595 |
|
596 | // Override timeout for this request as it's known to take a long time
|
597 | instance.get('/longRequest', {
|
598 | timeout: 5000
|
599 | });
|
600 | ```
|
601 |
|
602 | ## Interceptors
|
603 |
|
604 | You can intercept requests or responses before they are handled by `then` or `catch`.
|
605 |
|
606 | ```js
|
607 | // Add a request interceptor
|
608 | axios.interceptors.request.use(function (config) {
|
609 | // Do something before request is sent
|
610 | return config;
|
611 | }, function (error) {
|
612 | // Do something with request error
|
613 | return Promise.reject(error);
|
614 | });
|
615 |
|
616 | // Add a response interceptor
|
617 | axios.interceptors.response.use(function (response) {
|
618 | // Any status code that lie within the range of 2xx cause this function to trigger
|
619 | // Do something with response data
|
620 | return response;
|
621 | }, function (error) {
|
622 | // Any status codes that falls outside the range of 2xx cause this function to trigger
|
623 | // Do something with response error
|
624 | return Promise.reject(error);
|
625 | });
|
626 | ```
|
627 |
|
628 | If you need to remove an interceptor later you can.
|
629 |
|
630 | ```js
|
631 | const myInterceptor = axios.interceptors.request.use(function () {/*...*/});
|
632 | axios.interceptors.request.eject(myInterceptor);
|
633 | ```
|
634 |
|
635 | You can add interceptors to a custom instance of axios.
|
636 |
|
637 | ```js
|
638 | const instance = axios.create();
|
639 | instance.interceptors.request.use(function () {/*...*/});
|
640 | ```
|
641 |
|
642 | When you add request interceptors, they are presumed to be asynchronous by default. This can cause a delay
|
643 | in the execution of your axios request when the main thread is blocked (a promise is created under the hood for
|
644 | 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
|
645 | to the options object that will tell axios to run the code synchronously and avoid any delays in request execution.
|
646 |
|
647 | ```js
|
648 | axios.interceptors.request.use(function (config) {
|
649 | config.headers.test = 'I am only a header!';
|
650 | return config;
|
651 | }, null, { synchronous: true });
|
652 | ```
|
653 |
|
654 | If you want to execute a particular interceptor based on a runtime check,
|
655 | you can add a `runWhen` function to the options object. The interceptor will not be executed **if and only if** the return
|
656 | of `runWhen` is `false`. The function will be called with the config
|
657 | object (don't forget that you can bind your own arguments to it as well.) This can be handy when you have an
|
658 | asynchronous request interceptor that only needs to run at certain times.
|
659 |
|
660 | ```js
|
661 | function onGetCall(config) {
|
662 | return config.method === 'get';
|
663 | }
|
664 | axios.interceptors.request.use(function (config) {
|
665 | config.headers.test = 'special get headers';
|
666 | return config;
|
667 | }, null, { runWhen: onGetCall });
|
668 | ```
|
669 |
|
670 | ### Multiple Interceptors
|
671 |
|
672 | Given you add multiple response interceptors
|
673 | and when the response was fulfilled
|
674 | - then each interceptor is executed
|
675 | - then they are executed in the order they were added
|
676 | - then only the last interceptor's result is returned
|
677 | - then every interceptor receives the result of it's predecessor
|
678 | - and when the fulfillment-interceptor throws
|
679 | - then the following fulfillment-interceptor is not called
|
680 | - then the following rejection-interceptor is called
|
681 | - once caught, another following fulfill-interceptor is called again (just like in a promise chain).
|
682 |
|
683 | Read [the interceptor tests](./test/specs/interceptors.spec.js) for seeing all this in code.
|
684 |
|
685 | ## Handling Errors
|
686 |
|
687 | ```js
|
688 | axios.get('/user/12345')
|
689 | .catch(function (error) {
|
690 | if (error.response) {
|
691 | // The request was made and the server responded with a status code
|
692 | // that falls out of the range of 2xx
|
693 | console.log(error.response.data);
|
694 | console.log(error.response.status);
|
695 | console.log(error.response.headers);
|
696 | } else if (error.request) {
|
697 | // The request was made but no response was received
|
698 | // `error.request` is an instance of XMLHttpRequest in the browser and an instance of
|
699 | // http.ClientRequest in node.js
|
700 | console.log(error.request);
|
701 | } else {
|
702 | // Something happened in setting up the request that triggered an Error
|
703 | console.log('Error', error.message);
|
704 | }
|
705 | console.log(error.config);
|
706 | });
|
707 | ```
|
708 |
|
709 | Using the `validateStatus` config option, you can define HTTP code(s) that should throw an error.
|
710 |
|
711 | ```js
|
712 | axios.get('/user/12345', {
|
713 | validateStatus: function (status) {
|
714 | return status < 500; // Resolve only if the status code is less than 500
|
715 | }
|
716 | })
|
717 | ```
|
718 |
|
719 | Using `toJSON` you get an object with more information about the HTTP error.
|
720 |
|
721 | ```js
|
722 | axios.get('/user/12345')
|
723 | .catch(function (error) {
|
724 | console.log(error.toJSON());
|
725 | });
|
726 | ```
|
727 |
|
728 | ## Cancellation
|
729 |
|
730 | ### AbortController
|
731 |
|
732 | Starting from `v0.22.0` Axios supports AbortController to cancel requests in fetch API way:
|
733 |
|
734 | ```js
|
735 | const controller = new AbortController();
|
736 |
|
737 | axios.get('/foo/bar', {
|
738 | signal: controller.signal
|
739 | }).then(function(response) {
|
740 | //...
|
741 | });
|
742 | // cancel the request
|
743 | controller.abort()
|
744 | ```
|
745 |
|
746 | ### CancelToken `👎deprecated`
|
747 |
|
748 | You can also cancel a request using a *CancelToken*.
|
749 |
|
750 | > The axios cancel token API is based on the withdrawn [cancelable promises proposal](https://github.com/tc39/proposal-cancelable-promises).
|
751 |
|
752 | > This API is deprecated since v0.22.0 and shouldn't be used in new projects
|
753 |
|
754 | You can create a cancel token using the `CancelToken.source` factory as shown below:
|
755 |
|
756 | ```js
|
757 | const CancelToken = axios.CancelToken;
|
758 | const source = CancelToken.source();
|
759 |
|
760 | axios.get('/user/12345', {
|
761 | cancelToken: source.token
|
762 | }).catch(function (thrown) {
|
763 | if (axios.isCancel(thrown)) {
|
764 | console.log('Request canceled', thrown.message);
|
765 | } else {
|
766 | // handle error
|
767 | }
|
768 | });
|
769 |
|
770 | axios.post('/user/12345', {
|
771 | name: 'new name'
|
772 | }, {
|
773 | cancelToken: source.token
|
774 | })
|
775 |
|
776 | // cancel the request (the message parameter is optional)
|
777 | source.cancel('Operation canceled by the user.');
|
778 | ```
|
779 |
|
780 | You can also create a cancel token by passing an executor function to the `CancelToken` constructor:
|
781 |
|
782 | ```js
|
783 | const CancelToken = axios.CancelToken;
|
784 | let cancel;
|
785 |
|
786 | axios.get('/user/12345', {
|
787 | cancelToken: new CancelToken(function executor(c) {
|
788 | // An executor function receives a cancel function as a parameter
|
789 | cancel = c;
|
790 | })
|
791 | });
|
792 |
|
793 | // cancel the request
|
794 | cancel();
|
795 | ```
|
796 |
|
797 | > Note: you can cancel several requests with the same cancel token/abort controller.
|
798 | > 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.
|
799 |
|
800 | > During the transition period, you can use both cancellation APIs, even for the same request:
|
801 |
|
802 | ## Using application/x-www-form-urlencoded format
|
803 |
|
804 | 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.
|
805 |
|
806 | ### Browser
|
807 |
|
808 | In a browser, you can use the [`URLSearchParams`](https://developer.mozilla.org/en-US/docs/Web/API/URLSearchParams) API as follows:
|
809 |
|
810 | ```js
|
811 | const params = new URLSearchParams();
|
812 | params.append('param1', 'value1');
|
813 | params.append('param2', 'value2');
|
814 | axios.post('/foo', params);
|
815 | ```
|
816 |
|
817 | > 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).
|
818 |
|
819 | Alternatively, you can encode data using the [`qs`](https://github.com/ljharb/qs) library:
|
820 |
|
821 | ```js
|
822 | const qs = require('qs');
|
823 | axios.post('/foo', qs.stringify({ 'bar': 123 }));
|
824 | ```
|
825 |
|
826 | Or in another way (ES6),
|
827 |
|
828 | ```js
|
829 | import qs from 'qs';
|
830 | const data = { 'bar': 123 };
|
831 | const options = {
|
832 | method: 'POST',
|
833 | headers: { 'content-type': 'application/x-www-form-urlencoded' },
|
834 | data: qs.stringify(data),
|
835 | url,
|
836 | };
|
837 | axios(options);
|
838 | ```
|
839 |
|
840 | ### Node.js
|
841 |
|
842 | #### Query string
|
843 |
|
844 | In node.js, you can use the [`querystring`](https://nodejs.org/api/querystring.html) module as follows:
|
845 |
|
846 | ```js
|
847 | const querystring = require('querystring');
|
848 | axios.post('http://something.com/', querystring.stringify({ foo: 'bar' }));
|
849 | ```
|
850 |
|
851 | or ['URLSearchParams'](https://nodejs.org/api/url.html#url_class_urlsearchparams) from ['url module'](https://nodejs.org/api/url.html) as follows:
|
852 |
|
853 | ```js
|
854 | const url = require('url');
|
855 | const params = new url.URLSearchParams({ foo: 'bar' });
|
856 | axios.post('http://something.com/', params.toString());
|
857 | ```
|
858 |
|
859 | You can also use the [`qs`](https://github.com/ljharb/qs) library.
|
860 |
|
861 | > NOTE:
|
862 | > The `qs` library is preferable if you need to stringify nested objects, as the `querystring` method has [known issues](https://github.com/nodejs/node-v0.x-archive/issues/1665) with that use case.
|
863 |
|
864 | #### Form data
|
865 |
|
866 | ##### 🆕 Automatic serialization
|
867 |
|
868 | Starting from `v0.27.0`, Axios supports automatic object serialization to a FormData object if the request `Content-Type`
|
869 | header is set to `multipart/form-data`.
|
870 |
|
871 | The following request will submit the data in a FormData format (Browser & Node.js):
|
872 |
|
873 | ```js
|
874 | import axios from 'axios';
|
875 |
|
876 | axios.post('https://httpbin.org/post', {x: 1}, {
|
877 | headers: {
|
878 | 'Content-Type': 'multipart/form-data'
|
879 | }
|
880 | }).then(({data})=> console.log(data));
|
881 | ```
|
882 |
|
883 | In the `node.js` build, the ([`form-data`](https://github.com/form-data/form-data)) polyfill is used by default.
|
884 |
|
885 | You can overload the FormData class by setting the `env.FormData` config variable,
|
886 | but you probably won't need it in most cases:
|
887 |
|
888 | ```js
|
889 | const axios= require('axios');
|
890 | var FormData = require('form-data');
|
891 |
|
892 | axios.post('https://httpbin.org/post', {x: 1, buf: new Buffer(10)}, {
|
893 | headers: {
|
894 | 'Content-Type': 'multipart/form-data'
|
895 | }
|
896 | }).then(({data})=> console.log(data));
|
897 | ```
|
898 |
|
899 | Axios FormData serializer supports some special endings to perform the following operations:
|
900 |
|
901 | - `{}` - serialize the value with JSON.stringify
|
902 | - `[]` - unwrap the array like object as separate fields with the same key
|
903 |
|
904 | ```js
|
905 | const axios= require('axios');
|
906 |
|
907 | axios.post('https://httpbin.org/post', {
|
908 | 'myObj{}': {x: 1, s: "foo"},
|
909 | 'files[]': document.querySelector('#fileInput').files
|
910 | }, {
|
911 | headers: {
|
912 | 'Content-Type': 'multipart/form-data'
|
913 | }
|
914 | }).then(({data})=> console.log(data));
|
915 | ```
|
916 |
|
917 | Axios supports the following shortcut methods: `postForm`, `putForm`, `patchForm`
|
918 | which are just the corresponding http methods with a header preset: `Content-Type`: `multipart/form-data`.
|
919 |
|
920 | FileList object can be passed directly:
|
921 |
|
922 | ```js
|
923 | await axios.postForm('https://httpbin.org/post', document.querySelector('#fileInput').files)
|
924 | ```
|
925 |
|
926 | All files will be sent with the same field names: `files[]`;
|
927 |
|
928 | ##### Manual FormData passing
|
929 |
|
930 | In node.js, you can use the [`form-data`](https://github.com/form-data/form-data) library as follows:
|
931 |
|
932 | ```js
|
933 | const FormData = require('form-data');
|
934 |
|
935 | const form = new FormData();
|
936 | form.append('my_field', 'my value');
|
937 | form.append('my_buffer', new Buffer(10));
|
938 | form.append('my_file', fs.createReadStream('/foo/bar.jpg'));
|
939 |
|
940 | axios.post('https://example.com', form)
|
941 | ```
|
942 |
|
943 | ## Semver
|
944 |
|
945 | 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.
|
946 |
|
947 | ## Promises
|
948 |
|
949 | axios depends on a native ES6 Promise implementation to be [supported](http://caniuse.com/promises).
|
950 | If your environment doesn't support ES6 Promises, you can [polyfill](https://github.com/jakearchibald/es6-promise).
|
951 |
|
952 | ## TypeScript
|
953 |
|
954 | axios includes [TypeScript](http://typescriptlang.org) definitions and a type guard for axios errors.
|
955 |
|
956 | ```typescript
|
957 | let user: User = null;
|
958 | try {
|
959 | const { data } = await axios.get('/user?ID=12345');
|
960 | user = data.userDetails;
|
961 | } catch (error) {
|
962 | if (axios.isAxiosError(error)) {
|
963 | handleAxiosError(error);
|
964 | } else {
|
965 | handleUnexpectedError(error);
|
966 | }
|
967 | }
|
968 | ```
|
969 |
|
970 | ## Online one-click setup
|
971 |
|
972 | You can use Gitpod an online IDE(which is free for Open Source) for contributing or running the examples online.
|
973 |
|
974 | [![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/axios/axios/blob/master/examples/server.js)
|
975 |
|
976 |
|
977 | ## Resources
|
978 |
|
979 | * [Changelog](https://github.com/axios/axios/blob/master/CHANGELOG.md)
|
980 | * [Upgrade Guide](https://github.com/axios/axios/blob/master/UPGRADE_GUIDE.md)
|
981 | * [Ecosystem](https://github.com/axios/axios/blob/master/ECOSYSTEM.md)
|
982 | * [Contributing Guide](https://github.com/axios/axios/blob/master/CONTRIBUTING.md)
|
983 | * [Code of Conduct](https://github.com/axios/axios/blob/master/CODE_OF_CONDUCT.md)
|
984 |
|
985 | ## Credits
|
986 |
|
987 | axios is heavily inspired by the [$http service](https://docs.angularjs.org/api/ng/service/$http) provided in [AngularJS](https://angularjs.org/). Ultimately axios is an effort to provide a standalone `$http`-like service for use outside of AngularJS.
|
988 |
|
989 | ## License
|
990 |
|
991 | [MIT](LICENSE)
|