Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

axios-cookiejar-support

3846masa1.2mMIT6.0.2TypeScript support: included

Add tough-cookie support to axios.

axios, cookie, cookiejar, cookies, tough-cookie

readme

axios-cookiejar-support

axios-cookiejar-support

github sponsors npm license standard-readme compliant

Add tough-cookie support to axios.

Table of Contents

Install

npm install axios tough-cookie axios-cookiejar-support

Usage

import axios from 'axios';
import { wrapper } from 'axios-cookiejar-support';
import { CookieJar } from 'tough-cookie';

const jar = new CookieJar();
const client = wrapper(axios.create({ jar }));

await client.get('https://example.com');

See examples for more details.

Extended Request Config

import type { CookieJar } from 'tough-cookie';

declare module 'axios' {
  interface AxiosRequestConfig {
    jar?: CookieJar;
  }
}

See also https://github.com/axios/axios#request-config .

FAQ

  • Q. Why can't I assign the httpAgent / httpsAgent?
    • A. axios-cookiejar-support uses httpAgent / httpsAgent to read and write cookies. If other Agents are assigned, cookies cannot be read/written.
  • Q. I want to use it with another Agent (e.g., http-proxy-agent).
    • A. Consider using http-cookie-agent. axios-cookiejar-support also uses http-cookie-agent. Read http-cookie-agent's README for more details.

Contributing

PRs accepted.

License

MIT (c) 3846masa

changelog

6.0.2 (2025-04-26)

Bug Fixes

  • improve module resolution compatibility with bundlers (#1350) (4619c4d)

6.0.1 (2025-04-23)

Bug Fixes

  • restore main / types fields for npm ts badge (#1348) (0970328)

6.0.0 (2025-04-14)

Bug Fixes

  • npm: update dependency http-cookie-agent to v7 (#1342) (8f51516)

chore

Features

BREAKING CHANGES

  • Drop support for Node.js v18. See MIGRATION.md
  • CommonJS is no longer provided. See MIGRATION.md

5.0.5 (2024-12-16)

Bug Fixes

  • npm: update dependency http-cookie-agent to ^6.0.8 (#1211) (047a8b4)

5.0.4 (2024-12-14)

Bug Fixes

  • npm: update dependency http-cookie-agent to ^6.0.7 (#1209) (a6b8e5b)

5.0.3 (2024-09-26)

Bug Fixes

  • npm: update dependency http-cookie-agent to ^6.0.6 (#1119) (dec5f97)

5.0.2 (2024-05-05)

Bug Fixes

  • npm: update dependency http-cookie-agent to ^6.0.5 (#996) (5a16f9f)

5.0.1 (2024-04-07)

Bug Fixes

  • npm: update dependency http-cookie-agent to ^6.0.3 (#968) (4f0c06f)

5.0.0 (2024-01-14)

Features

BREAKING CHANGES

  • drop Node.js v14 and v16

4.0.7 (2023-06-22)

Bug Fixes

  • npm: update dependency http-cookie-agent to ^5.0.4 (#764) (c63b7bd)

4.0.6 (2023-01-01)

Bug Fixes

  • npm: update dependency http-cookie-agent to v5 (#655) (42cc5ee)

4.0.5 (2022-12-28)

Bug Fixes

4.0.4 (2022-12-26)

Bug Fixes

  • allow to reuse config (e.g. axios-retry) (#650) (86a759c)

4.0.3 (2022-07-26)

Bug Fixes

  • npm: update dependency http-cookie-agent to ^4.0.2 (#541) (6246253)

4.0.2 (2022-05-24)

Bug Fixes

  • npm: update dependency http-cookie-agent to ^4.0.1 (#494) (1c75dcf)

4.0.1 (2022-05-08)

Bug Fixes

  • npm: update dependency http-cookie-agent to ^4.0.0 (#485) (7b85d03)

4.0.0 (2022-05-07)

Features

  • npm: update dependency http-cookie-agent to ^3.0.0 (#482) (1dac53a)

BREAKING CHANGES

  • npm: an asynchronous Cookie store (e.g. redis-cookie-store) is no longer supported.

3.0.0 (2022-05-03)

Features

BREAKING CHANGES

  • drop Node.js v12 support, please use v14 or above

2.0.5 (2022-05-02)

2.0.4 (2022-02-27)

Bug Fixes

  • deps: update actions/setup-node action to v3 (#450) (0b6fca2)

2.0.3 (2021-10-14)

Bug Fixes

2.0.2 (2021-09-24)

Bug Fixes

  • change axios semver in peer dependencies (#411) (f58c4b4)

2.0.1 (2021-09-24)

Bug Fixes

  • send cookies even when target is same host but different port (#408) (b52126c)

2.0.0 (2021-09-17)

Features

BREAKING CHANGES

  • see MIGRATION.md