diff --git a/COOKBOOK.md b/COOKBOOK.md index 3f4debd3a5..6ce5b10eb0 100644 --- a/COOKBOOK.md +++ b/COOKBOOK.md @@ -4,10 +4,10 @@ This cookbook contains recipes for some commonly requested features. In order to keep axios as lightweight as possible, it is often necessary to say no to feature requests. Many of these use cases can be supported by augmenting axios with other libraries. -### Promise.prototype.done +## Promise.prototype.done ```bash -$ npm install axios promise --save +> npm install axios promise --save ``` ```js @@ -23,10 +23,10 @@ axios .done(); ``` -### Promise.prototype.finally +## Promise.prototype.finally ```bash -$ npm install axios promise.prototype.finally --save +> npm install axios promise.prototype.finally --save ``` ```js @@ -44,10 +44,10 @@ axios }); ``` -### Inflate/Deflate +## Inflate/Deflate ```bash -$ npm install axios pako --save +> npm install axios pako --save ``` ```js @@ -107,10 +107,10 @@ const server = http.createServer((req, res) => { server.listen(3333); ``` -### JSONP +## JSONP ```bash -$ npm install jsonp --save +> npm install jsonp --save ``` ```js diff --git a/ECOSYSTEM.md b/ECOSYSTEM.md index 8e2176f00a..9e55bc21db 100644 --- a/ECOSYSTEM.md +++ b/ECOSYSTEM.md @@ -11,14 +11,14 @@ This is a list of axios related libraries and resources. If you have a suggestio * [axios-method-override](https://github.com/jacobbuck/axios-method-override) - Axios http request method override plugin * [axios-cache-plugin](https://github.com/jin5354/axios-cache-plugin) - Help you cache GET request when using axios. * [axios-extensions](https://github.com/kuitos/axios-extensions) - A collection of axios extensions, including throttle and cache GET request plugin. -* [axios-fetch](https://github.com/lifeomic/axios-fetch) - A WebAPI Fetch implementation backed by an Axios client +* [axios-fetch](https://github.com/lifeomic/axios-fetch) - A WebAPI Fetch implementation backed by an Axios client * [axios-actions](https://github.com/davestewart/axios-actions) - Bundle endpoints as callable, reusable services * [axios-api-versioning](https://weffe.github.io/axios-api-versioning) - Add easy to manage api versioning to axios * [axios-data-unpacker](https://github.com/anubhavsrivastava/axios-data-unpacker) - Axios interceptor that unpacks HTTP responses so that you can focus on actual server data. * [r2curl](https://github.com/uyu423/r2curl) - Extracts the cURL command string from the Axios object. (AxiosResponse, AxiosRequestConfig) * [swagger-taxos-codegen](https://github.com/michalzaq12/swagger-taxos-codegen) - Axios based Swagger Codegen (tailored for typescript) -* [axios-endpoints](https://github.com/renancaraujo/axios-endpoints) - Axios endpoints helps you to create a more concise endpoint mapping with axios. -* [axios-multi-api](https://github.com/MattCCC/axios-multi-api) - Easy API handling whenever there are many endpoints to add. It helps to make Axios requests in an easy and declarative manner. +* [axios-endpoints](https://github.com/renancaraujo/axios-endpoints) - Axios endpoints helps you to create a more concise endpoint mapping with axios. +* [axios-multi-api](https://github.com/MattCCC/axios-multi-api) - Easy API handling whenever there are many endpoints to add. It helps to make Axios requests in an easy and declarative manner. * [axios-url-template](https://github.com/rafw87/axios-url-template) - Axios interceptor adding support for URL templates. ### Logging and debugging diff --git a/SECURITY.md b/SECURITY.md index f8e5e92f73..7b96aaab8a 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -1,4 +1,4 @@ -## Reporting a Vulnerability +# Reporting a Vulnerability If you discover a security vulnerability within axios, please submit a report via [huntr.dev](https://huntr.dev/bounties/?target=https%3A%2F%2Fgithub.com%2Faxios%2Faxios). Bounties and CVEs are automatically managed and allocated via the platform. diff --git a/UPGRADE_GUIDE.md b/UPGRADE_GUIDE.md index fdcff1a6b8..52a022d400 100644 --- a/UPGRADE_GUIDE.md +++ b/UPGRADE_GUIDE.md @@ -1,20 +1,20 @@ # Upgrade Guide -### 0.18.x -> 0.19.0 +## 0.18.x -> 0.19.0 -#### HTTPS Proxies +### HTTPS Proxies Routing through an https proxy now requires setting the `protocol` attribute of the proxy configuration to `https` -### 0.15.x -> 0.16.0 +## 0.15.x -> 0.16.0 -#### `Promise` Type Declarations +### `Promise` Type Declarations The `Promise` type declarations have been removed from the axios typings in favor of the built-in type declarations. If you use axios in a TypeScript project that targets `ES5`, please make sure to include the `es2015.promise` lib. Please see [this post](https://blog.mariusschulz.com/2016/11/25/typescript-2-0-built-in-type-declarations) for details. -### 0.13.x -> 0.14.0 +## 0.13.x -> 0.14.0 -#### TypeScript Definitions +### TypeScript Definitions The axios TypeScript definitions have been updated to match the axios API and use the ES2015 module syntax. @@ -28,7 +28,7 @@ axios.get('/foo') .catch(error => console.log(error)); ``` -#### `agent` Config Option +### `agent` Config Option The `agent` config option has been replaced with two new options: `httpAgent` and `httpsAgent`. Please use them instead. @@ -41,7 +41,7 @@ The `agent` config option has been replaced with two new options: `httpAgent` an } ``` -#### `progress` Config Option +### `progress` Config Option The `progress` config option has been replaced with the `onUploadProgress` and `onDownloadProgress` options. @@ -59,11 +59,11 @@ The `progress` config option has been replaced with the `onUploadProgress` and ` } ``` -### 0.12.x -> 0.13.0 +## 0.12.x -> 0.13.0 The `0.13.0` release contains several changes to custom adapters and error handling. -#### Error Handling +### Error Handling Previous to this release an error could either be a server response with bad status code or an actual `Error`. With this release Promise will always reject with an `Error`. In the case that a response was received, the `Error` will also include the response. @@ -77,7 +77,7 @@ axios.get('/user/12345') }); ``` -#### Request Adapters +### Request Adapters This release changes a few things about how request adapters work. Please take note if you are using your own custom adapter. @@ -121,14 +121,15 @@ function myAdapter(config) { ``` See the related commits for more details: + - [Response transformers](https://github.com/axios/axios/commit/10eb23865101f9347570552c04e9d6211376e25e) - [Request adapter Promise](https://github.com/axios/axios/commit/157efd5615890301824e3121cc6c9d2f9b21f94a) -### 0.5.x -> 0.6.0 +## 0.5.x -> 0.6.0 The `0.6.0` release contains mostly bug fixes, but there are a couple things to be aware of when upgrading. -#### ES6 Promise Polyfill +### ES6 Promise Polyfill Up until the `0.6.0` release ES6 `Promise` was being polyfilled using [es6-promise](https://github.com/jakearchibald/es6-promise). With this release, the polyfill has been removed, and you will need to supply it yourself if your environment needs it. @@ -139,7 +140,7 @@ var axios = require('axios'); This will polyfill the global environment, and only needs to be done once. -#### `axios.success`/`axios.error` +### `axios.success`/`axios.error` The `success`, and `error` aliases were deprecated in [0.4.0](https://github.com/axios/axios/blob/master/CHANGELOG.md#040-oct-03-2014). As of this release they have been removed entirely. Instead please use `axios.then`, and `axios.catch` respectively. @@ -153,7 +154,7 @@ axios.get('some/url') }); ``` -#### UMD +### UMD Previous versions of axios shipped with an AMD, CommonJS, and Global build. This has all been rolled into a single UMD build.