axios-cookiejar-support

Add tough-cookie support to axios.

---

Install

1$ npm i axios tough-cookie axios-cookiejar-support

-- OR --

1$ npm i axios tough-cookie @3846masa/axios-cookiejar-support # Same as above

TypeScript

If you want to use it with TypeScript, add @types/tough-cookie.

1npm i @types/tough-cookie

Usage

1const axios = require('axios').default;
2const axiosCookieJarSupport = require('axios-cookiejar-support').default;
3const tough = require('tough-cookie');
4
5axiosCookieJarSupport(axios);
6
7const cookieJar = new tough.CookieJar();
8
9axios
10  .get('https://google.com', {
11    jar: cookieJar, // tough.CookieJar or boolean
12    withCredentials: true, // If true, send cookie stored in jar
13  })
14  .then(() => {
15    console.log(cookieJar);
16  });

See examples.

Notice: Set default cookiejar

axios@>=0.19.0 cannot assign defaults.jar via axios.create() before wrapping instance. When you want to set defaults.jar, please set directly after wrapping instance.

1const axios = require('axios').default;
2const axiosCookieJarSupport = require('axios-cookiejar-support').default;
3const tough = require('tough-cookie');
4
5const instance = axios.create({
6  // WARNING: This value will be ignored.
7  jar: new tough.CookieJar(),
8});
9
10// Set directly after wrapping instance.
11axiosCookieJarSupport(instance);
12instance.defaults.jar = new tough.CookieJar();

Extended Request Config

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

1{
2  // `jar` is tough.CookieJar instance or boolean.
3  // If true, axios create CookieJar automatically.
4  jar: undefined, // default
5
6  // Silently ignore things like parse cookie errors and invalid domains.
7  // See also https://github.com/salesforce/tough-cookie
8  ignoreCookieErrors: false // default
9
10  // **IMPORTANT**
11  // If false, axios DONOT send cookies from cookiejar.
12  withCredentials: false // default
13}

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

---

Donate

Paypal.me (Onetime donate)