diff options
author | Florian Dold <florian.dold@gmail.com> | 2017-08-27 04:19:34 +0200 |
---|---|---|
committer | Florian Dold <florian.dold@gmail.com> | 2017-08-27 04:19:34 +0200 |
commit | 665e88c72b568bf25ff0ec8a14109e2504f99aa8 (patch) | |
tree | c380e91e40efa8a47dea9ff833415f17e273d106 /node_modules/axios/lib/adapters/README.md | |
parent | 24181bdf20e0d23ec5ec5d2eaa08ae1cfb905f0f (diff) |
node_modules
Diffstat (limited to 'node_modules/axios/lib/adapters/README.md')
-rw-r--r-- | node_modules/axios/lib/adapters/README.md | 37 |
1 files changed, 37 insertions, 0 deletions
diff --git a/node_modules/axios/lib/adapters/README.md b/node_modules/axios/lib/adapters/README.md new file mode 100644 index 000000000..68f111895 --- /dev/null +++ b/node_modules/axios/lib/adapters/README.md @@ -0,0 +1,37 @@ +# axios // adapters + +The modules under `adapters/` are modules that handle dispatching a request and settling a returned `Promise` once a response is received. + +## Example + +```js +var settle = require('./../core/settle'); + +module.exports = function myAdapter(config) { + // At this point: + // - config has been merged with defaults + // - request transformers have already run + // - request interceptors have already run + + // Make the request using config provided + // Upon response settle the Promise + + return new Promise(function(resolve, reject) { + + var response = { + data: responseData, + status: request.status, + statusText: request.statusText, + headers: responseHeaders, + config: config, + request: request + }; + + settle(resolve, reject, response); + + // From here: + // - response transformers will run + // - response interceptors will run + }); +} +``` |