blai / axios-cookiejar-support

Add tough-cookie support to axios.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

axios-cookiejar-support

Add tough-cookie support to axios.


NPM LICENSE CircleCI

dependencies peerdependencies devdependencies

Install

$ npm i axios @3846masa/axios-cookiejar-support

Usage

const axios = require('axios');
const axiosCookieJarSupport = require('@3846masa/axios-cookiejar-support');
const tough = require('tough-cookie');

axiosCookieJarSupport(axios);

const cookieJar = new tough.CookieJar();

axios.get('https://google.com', {
  jar: cookieJar, // tough.CookieJar or boolean
  withCredentials: true // If true, send cookie stored in jar
})
.then(() => {
  console.log(cookieJar);
});

See examples.

Extended Request Config

c.f.) https://github.com/mzabriskie/axios#request-config

{
  // `jar` is tough.CookieJar instance or boolean.
  // If true, axios create CookieJar automatically.
  jar: undefined, // default

  // **IMPORTANT**
  // If false, axios DONOT send cookies from cookiejar.
  withCredentials: false // default
}

Browser

Running on browser, this library becomes noop (config.jar might be ignored).

Contribution

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

LICENSE

MIT License

Author

3846masa icon 3846masa

About

Add tough-cookie support to axios.

License:MIT License


Languages

Language:JavaScript 100.0%