axios-cookiejar-support
v5.0.3
Published
Add tough-cookie support to axios.
Downloads
1,070,557
Maintainers
Readme
axios-cookiejar-support
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.