Skip to main content

Class: Cookies

Defined in: src/http/cookies.ts:36

Cookies - HTTP cookie jar with domain and path matching

Implements​

Constructors​

Constructor​

new Cookies(init?): Cookies

Defined in: src/http/cookies.ts:39

Parameters​

init?​

CookiesInit

Returns​

Cookies

Accessors​

size​

Get Signature​

get size(): number

Defined in: src/http/cookies.ts:451

Get number of cookies

Returns​

number

Methods​

[iterator]()​

[iterator](): IterableIterator<Cookie>

Defined in: src/http/cookies.ts:417

Iterate over all cookies

Returns​

IterableIterator<Cookie>

Implementation of​

Iterable.[iterator]

clear()​

clear(domain?, path?): void

Defined in: src/http/cookies.ts:162

Clear all cookies, optionally filtering by domain/path

Parameters​

domain?​

string

path?​

string

Returns​

void

clone()​

clone(): Cookies

Defined in: src/http/cookies.ts:469

Create a copy

Returns​

Cookies

delete()​

delete(name, domain?, path?): boolean

Defined in: src/http/cookies.ts:133

Delete a cookie

Parameters​

name​

string

domain?​

string

path?​

string

Returns​

boolean

entries()​

entries(): IterableIterator<[string, string]>

Defined in: src/http/cookies.ts:442

Get name-value entries

Returns​

IterableIterator<[string, string]>

get()​

get(name, domain?, path?): string | null

Defined in: src/http/cookies.ts:77

Get a cookie value

Parameters​

name​

string

domain?​

string

path?​

string

Returns​

string | null

getCookie()​

getCookie(name, domain?, path?): Cookie | null

Defined in: src/http/cookies.ts:106

Get a cookie object

Parameters​

name​

string

domain?​

string

path?​

string

Returns​

Cookie | null

getForUrl()​

getForUrl(url): Cookie[]

Defined in: src/http/cookies.ts:218

Get cookies matching a URL

Parameters​

url​

string | URL

Returns​

Cookie[]

has()​

has(name, domain?, path?): boolean

Defined in: src/http/cookies.ts:184

Check if a cookie exists

Parameters​

name​

string

domain?​

string

path?​

string

Returns​

boolean

keys()​

keys(): IterableIterator<string>

Defined in: src/http/cookies.ts:424

Get all cookie names

Returns​

IterableIterator<string>

set()​

set(name, value, options?): void

Defined in: src/http/cookies.ts:57

Set a cookie

Parameters​

name​

string

value​

string

options?​

CookieOptions

Returns​

void

toCookieHeader()​

toCookieHeader(url?): string

Defined in: src/http/cookies.ts:297

Convert to Cookie header value

Parameters​

url?​

string | URL

Returns​

string

toNetscapeFormat()​

toNetscapeFormat(): string

Defined in: src/http/cookies.ts:305

Convert to Netscape cookie file format (for curl)

Returns​

string

toObject()​

toObject(): Record<string, string>

Defined in: src/http/cookies.ts:458

Convert to plain object

Returns​

Record<string, string>

update()​

update(init): void

Defined in: src/http/cookies.ts:191

Update cookies from another source

Parameters​

init​

CookiesInit

Returns​

void

values()​

values(): IterableIterator<string>

Defined in: src/http/cookies.ts:433

Get all cookie values

Returns​

IterableIterator<string>

fromNetscapeFormat()​

static fromNetscapeFormat(text): Cookies

Defined in: src/http/cookies.ts:388

Parse Netscape cookie file format

Parameters​

text​

string

Returns​

Cookies

parseSetCookie()​

static parseSetCookie(setCookie, requestUrl?): Cookie

Defined in: src/http/cookies.ts:328

Parse Set-Cookie header

Parameters​

setCookie​

string

requestUrl?​

URL

Returns​

Cookie