Adding Cookbook

2026-06-02 16:04:10 +03:00 · 2015-03-12 15:41:24 -06:00
parent 6c52a82a9d
commit c899c8742f
1 changed files with 127 additions and 0 deletions
@@ -0,0 +1,127 @@
+# Cookbook
+
+In an effort to keep axios as light weight as possible, and to avoid a rats nest of code for supporting every possible integration, it is often necessary to say no to feature requests. This doesn't mean that those use cases aren't legitimate, but rather that they are easily supported by augmenting axios with other libraries.
+
+The following are the recipes for some of the commonly requested features.
+
+### Promise.prototype.done
+
+```bash
+$ npm install axios promise --save
+```
+
+```js
+var axios = require('axios');
+require('promise/polyfill-done');
+
+axios
+  .get('http://www.example.com/user')
+  .then(function (response) {
+    console.log(response.data);
+    return response;
+  })
+  .done();
+```
+
+### Promise.prototype.finally
+
+```bash
+$ npm install axios promise.prototype.finally --save
+```
+
+```js
+var axios = require('axios');
+require('promise.prototype.finally');
+
+axios
+  .get('http://www.example.com/user')
+  .then(function (response) {
+    console.log(response.data);
+    return response;
+  })
+  .finally(function () {
+    console.log('this will always be called');
+  });
+```
+
+### Inflate/Defalte
+
+```bash
+$ npm install axios pako --save
+```
+
+```js
+// client.js
+var axios = require('axios');
+var pako = require('pako');
+
+var user = {
+  firstName: 'Fred',
+  lastName: 'Flintstone'
+};
+
+var data = pako.deflate(JSON.stringify(user), { to: 'string' });
+
+axios
+  .post('http://127.0.0.1:3333/user', data)
+  .then(function (response) {
+    response.data = JSON.parse(pako.inflate(response.data, { to: 'string' }));
+    console.log(response.data);
+    return response;
+  });
+```
+
+```js
+// server.js
+var pako = require('pako');
+var http = require('http');
+var url = require('url');
+var server;
+
+server = http.createServer(function (req, res) {
+  req.setEncoding('utf8');
+
+  var parsed = url.parse(req.url, true);
+  var pathname = parsed.pathname;
+
+  if (pathname === '/user') {
+    var data = '';
+    req.on('data', function (chunk) {
+      data += chunk;
+    });
+
+    req.on('end', function () {
+      var user = JSON.parse(pako.inflate(data, { to: 'string' }));
+      console.log(user);
+
+      res.writeHead(200, {
+        'Content-Type': 'application/json'
+      });
+      res.end(pako.deflate(JSON.stringify({result: 'success'}), { to: 'string' }));
+    });
+  } else {
+    res.writeHead(404);
+    res.end(pako.deflate(JSON.stringify({result: 'error'}), { to: 'string' }));
+  }
+});
+
+server.listen(3333);
+```
+
+### JSONP
+
+```bash
+$ npm install jsonp --save
+```
+
+```js
+var jsonp = require('jsonp');
+
+jsonp('http://www.example.com/foo', null, function (err, data) {
+  if (err) {
+    console.error(error.message);
+  } else {
+    console.log(data);
+  }
+});
+```