@robotsandpencils/axios-cookiejar-support

axios-cookiejar-support

Add tough-cookie support to axios.

---

Install

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

-- OR --

$ npm i axios axios-cookiejar-support # Same as above

Note | If you don't mind to use a scoped library, please use the scoped library. To put my account name in your dependencies is my pleasure :)

Usage

const axios = require('axios').default;
const axiosCookieJarSupport = require('@3846masa/axios-cookiejar-support').default;
// const axiosCookieJarSupport = require('axios-cookiejar-support').default;
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