Skip to content
Add tough-cookie support to axios.
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci Support v0.19.x (#188) Jun 15, 2019
workspaces Fix david badge in README Jun 15, 2019
.eslintrc.yml Async-await (#117) Nov 30, 2017
.gitignore Support v0.19.x (#188) Jun 15, 2019
.npmignore Add .npmignore (#118) Dec 2, 2017
README.md Support v0.19.x (#188) Jun 15, 2019
package.json Add workspaces Jun 15, 2019
yarn.lock Support v0.19.x (#188) Jun 15, 2019

README.md

axios-cookiejar-support

Add tough-cookie support to axios.


NPM LICENSE CircleCI

dependencies peerdependencies devdependencies

Install

$ npm i axios axios-cookiejar-support

-- OR --

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

Usage

const axios = require('axios').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.

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.

const axios = require('axios').default;
const axiosCookieJarSupport = require('axios-cookiejar-support').default;
const tough = require('tough-cookie');

const instance = axios.create({
  // WARNING: This value will be ignored.
  jar: new tough.CookieJar(),
});

// Set directly after wrapping instance.
axiosCookieJarSupport(instance);
instance.defaults.jar = new tough.CookieJar();

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


Donate

Paypal.me (Onetime donate)

You can’t perform that action at this time.