CookieJar

Cookie jar contract, structurally compatible with tough-cookie's CookieJar — which is what backs Session by default — so @crawlee/types does not have to depend on tough-cookie for it.

Index

Methods

• clone
• getCookies
• getCookieString
• getSetCookieStrings
• serialize
• setCookie
• toJSON

Methods

clone

• clone(): Promise<CookieJar>

• Returns Promise<CookieJar>

getCookies

• getCookies(url, options): Promise<SessionCookie[]>

• Parameters

  • url: string | URL

  • optionaloptions: CookieJarGetCookiesOptions

  Returns Promise<SessionCookie[]>

getCookieString

• getCookieString(url, options): Promise<string>

• Parameters

  • url: string | URL

  • optionaloptions: CookieJarGetCookiesOptions

  Returns Promise<string>

getSetCookieStrings

• getSetCookieStrings(url, options): Promise<undefined | string[]>

• Parameters

  • url: string | URL

  • optionaloptions: CookieJarGetCookiesOptions

  Returns Promise<undefined | string[]>

serialize

• serialize(): Promise<SerializedCookieJar>

• Returns Promise<SerializedCookieJar>

setCookie

• setCookie(cookie, url, options): Promise<undefined | SessionCookie>

• Parameters

  • cookie: string | SessionCookie

  • url: string | URL

  • optionaloptions: CookieJarSetCookieOptions

  Returns Promise<undefined | SessionCookie>

toJSON

• toJSON(): undefined | SerializedCookieJar

• Returns undefined | SerializedCookieJar