Class CookieJar

Index

Constructors

Methods

clear delete fromJSON getAll getCookieString setCookie toJSON

Constructors

constructor

new CookieJar(_options?: CookieJarOptions): CookieJar
Parameters
- _options: CookieJarOptions = {}
Returns CookieJar
- Defined in src/plugins/cookies.ts:103

Methods

clear

clear(): void
Clear all cookies.

Returns void
- Defined in src/plugins/cookies.ts:176

delete

delete(name: string, domain?: string, path?: string): void
Remove a specific cookie.
Parameters
- name: string
- Optionaldomain: string
- Optionalpath: string
Returns void
- Defined in src/plugins/cookies.ts:183

fromJSON

fromJSON(cookies: CookieAttributes[]): void
Restore from serialized JSON.
Parameters
- cookies: CookieAttributes[]
Returns void
- Defined in src/plugins/cookies.ts:198

getAll

getAll(): CookieAttributes[]
Get all stored cookies.

Returns CookieAttributes[]
- Defined in src/plugins/cookies.ts:169

getCookieString

getCookieString(requestUrl: string): string
Get cookies applicable for a given URL as a Cookie header string.
Parameters
- requestUrl: string
Returns string
- Defined in src/plugins/cookies.ts:131

setCookie

setCookie(setCookieHeader: string | string[], requestUrl: string): void
Store cookies from a Set-Cookie response header.
Parameters
- setCookieHeader: string | string[]
- requestUrl: string
Returns void
- Defined in src/plugins/cookies.ts:108

toJSON

toJSON(): CookieAttributes[]
Serialize to JSON for persistence.

Returns CookieAttributes[]
- Defined in src/plugins/cookies.ts:191