Class Cookies

Cookies class extends the CookieJar class from the "tough-cookie" library. It provides methods to manage cookies for a specific URL.

Hierarchy

  • CookieJar
    • Cookies

Constructors

constructor

Methods

clone cloneSync fetchAllCookies fetchCookiesList fetchCookiesObject getCookieString getCookieStringSync getCookies getCookiesSync getSetCookieStrings getSetCookieStringsSync mergeCookies removeAllCookies removeAllCookiesSync serialize serializeSync setCookie setCookieSync syncCookies toJSON deserialize deserializeSync fromJSON

Constructors

constructor

  • new Cookies(): Cookies

  • Constructor for the Cookies class. It calls the constructor of the parent class CookieJar.

    Returns Cookies

Methods

clone

  • clone(store?): Promise<CookieJar>

  • Parameters

    • Optional store: Store

    Returns Promise<CookieJar>

  • clone(store, cb): void

  • Parameters

    • store: Store
    • cb: ((err, newJar) => void)
        • (err, newJar): void

        • Parameters

          • err: null | Error
          • newJar: CookieJar

          Returns void

    Returns void

  • clone(cb): void

  • Parameters

    • cb: ((err, newJar) => void)
        • (err, newJar): void

        • Parameters

          • err: null | Error
          • newJar: CookieJar

          Returns void

    Returns void

cloneSync

  • cloneSync(store?): CookieJar

  • Parameters

    • Optional store: Store

    Returns CookieJar

fetchAllCookies

  • fetchAllCookies(): Serialized

  • Fetches all cookies and organizes them by URL.

    This method serializes cookies and groups them by their domain and path, constructing a URL as the key and an object of cookies as key-value pairs.

    Returns Serialized

    An object where keys are URLs and values are objects containing cookies as key-value pairs.

    Example

    {
       *    "https://example.com/": {
       *      "cookie1": "value1",
       *      "cookie2": "value2"
       *    },
       *    "https://anotherdomain.com/": {
       *      "cookieA": "valueA",
       *      "cookieB": "valueB"
       *    }
       *  }

fetchCookiesList

  • fetchCookiesList(url): {
        name: string;
        value: string;
    }[]

  • Fetches the cookies for a given URL as an array of objects. Each object contains the name and value of a cookie.

    Parameters

    • url: string

      The URL from which cookies are to be fetched.

    Returns {
        name: string;
        value: string;
    }[]

    An array of objects, each containing the name and value of a cookie.

    Example

    fetchSequence('http://example.com')

fetchCookiesObject

  • fetchCookiesObject(url): Record<string, string>

  • Fetches the cookies for a given URL as an object.

    Parameters

    • url: string

      The URL from which cookies are to be fetched.

    Returns Record<string, string>

    An object containing cookies as key-value pairs.

    Example

    fetchJSON('http://example.com')

getCookieString

  • getCookieString(currentUrl, options?): Promise<string>

  • Parameters

    • currentUrl: string
    • Optional options: GetCookiesOptions

    Returns Promise<string>

  • getCookieString(currentUrl, options, cb): void

  • Parameters

    • currentUrl: string
    • options: GetCookiesOptions
    • cb: ((err, cookies) => void)
        • (err, cookies): void

        • Parameters

          • err: null | Error
          • cookies: string

          Returns void

    Returns void

  • getCookieString(currentUrl, cb): void

  • Parameters

    • currentUrl: string
    • cb: ((err, cookies) => void)
        • (err, cookies): void

        • Parameters

          • err: null | Error
          • cookies: string

          Returns void

    Returns void

getCookieStringSync

  • getCookieStringSync(currentUrl, options?): string

  • Parameters

    • currentUrl: string
    • Optional options: GetCookiesOptions

    Returns string

getCookies

  • getCookies(currentUrl, options?): Promise<Cookie[]>

  • Parameters

    • currentUrl: string
    • Optional options: GetCookiesOptions

    Returns Promise<Cookie[]>

  • getCookies(currentUrl, options, cb): void

  • Parameters

    • currentUrl: string
    • options: GetCookiesOptions
    • cb: ((err, cookies) => void)
        • (err, cookies): void

        • Parameters

          • err: null | Error
          • cookies: Cookie[]

          Returns void

    Returns void

  • getCookies(currentUrl, cb): void

  • Parameters

    • currentUrl: string
    • cb: ((err, cookies) => void)
        • (err, cookies): void

        • Parameters

          • err: null | Error
          • cookies: Cookie[]

          Returns void

    Returns void

getCookiesSync

  • getCookiesSync(currentUrl, options?): Cookie[]

  • Parameters

    • currentUrl: string
    • Optional options: GetCookiesOptions

    Returns Cookie[]

getSetCookieStrings

  • getSetCookieStrings(currentUrl, options?): Promise<string[]>

  • Parameters

    • currentUrl: string
    • Optional options: GetCookiesOptions

    Returns Promise<string[]>

  • getSetCookieStrings(currentUrl, options, cb): void

  • Parameters

    • currentUrl: string
    • options: GetCookiesOptions
    • cb: ((err, cookies) => void)
        • (err, cookies): void

        • Parameters

          • err: null | Error
          • cookies: string[]

          Returns void

    Returns void

  • getSetCookieStrings(currentUrl, cb): void

  • Parameters

    • currentUrl: string
    • cb: ((err, cookies) => void)
        • (err, cookies): void

        • Parameters

          • err: null | Error
          • cookies: string[]

          Returns void

    Returns void

getSetCookieStringsSync

  • getSetCookieStringsSync(currentUrl, options?): string[]

  • Parameters

    • currentUrl: string
    • Optional options: GetCookiesOptions

    Returns string[]

mergeCookies

  • mergeCookies(cookies, url): {
        name: string;
        value: string;
    }[]

  • Merges the provided cookies with the existing cookies for a given URL according to request payload.

    Parameters

    • cookies: Record<string, string>

      An object containing cookies as key-value pairs.

    • url: string

      The URL for which cookies are to be set.

    Returns {
        name: string;
        value: string;
    }[]

    An array of objects, each containing the name and value of a cookie.

    Example

    merge({ 'cookie1': 'value1', 'cookie2': 'value2' }, 'http://example.com')

removeAllCookies

  • removeAllCookies(): Promise<void>

  • Returns Promise<void>

  • removeAllCookies(cb): void

  • Parameters

    • cb: ((err) => void)
        • (err): void

        • Parameters

          • err: null | Error

          Returns void

    Returns void

removeAllCookiesSync

  • removeAllCookiesSync(): void

  • Returns void

serialize

  • serialize(): Promise<Serialized>

  • Returns Promise<Serialized>

  • serialize(cb): void

  • Parameters

    • cb: ((err, serializedObject) => void)
        • (err, serializedObject): void

        • Parameters

          • err: null | Error
          • serializedObject: Serialized

          Returns void

    Returns void

serializeSync

  • serializeSync(): Serialized

  • Returns Serialized

setCookie

  • setCookie(cookieOrString, currentUrl, options?): Promise<Cookie>

  • Parameters

    • cookieOrString: string | Cookie
    • currentUrl: string
    • Optional options: SetCookieOptions

    Returns Promise<Cookie>

  • setCookie(cookieOrString, currentUrl, options, cb): void

  • Parameters

    • cookieOrString: string | Cookie
    • currentUrl: string
    • options: SetCookieOptions
    • cb: ((err, cookie) => void)
        • (err, cookie): void

        • Parameters

          • err: null | Error
          • cookie: Cookie

          Returns void

    Returns void

  • setCookie(cookieOrString, currentUrl, cb): void

  • Parameters

    • cookieOrString: string | Cookie
    • currentUrl: string
    • cb: ((err, cookie) => void)
        • (err, cookie): void

        • Parameters

          • err: null | Error
          • cookie: Cookie

          Returns void

    Returns void

setCookieSync

  • setCookieSync(cookieOrString, currentUrl, options?): Cookie

  • Parameters

    • cookieOrString: string | Cookie
    • currentUrl: string
    • Optional options: SetCookieOptions

    Returns Cookie

syncCookies

  • syncCookies(cookies, url): Record<string, string>

  • Checks and sets cookies for a given URL.

    Parameters

    • cookies: Record<string, string>

      An object containing cookies as key-value pairs.

    • url: string

      The URL for which cookies are to be set.

    Returns Record<string, string>

    An object containing cookies as key-value pairs.

    Example

    check({ 'cookie1': 'value1', 'cookie2': 'value2' }, 'http://example.com')

toJSON

  • toJSON(): Serialized

  • Returns Serialized

Static deserialize

  • deserialize(serialized, store?): Promise<CookieJar>

  • Parameters

    • serialized: string | Serialized
    • Optional store: Store

    Returns Promise<CookieJar>

  • deserialize(serialized, store, cb): void

  • Parameters

    • serialized: string | Serialized
    • store: Store
    • cb: ((err, object) => void)
        • (err, object): void

        • Parameters

          • err: null | Error
          • object: CookieJar

          Returns void

    Returns void

  • deserialize(serialized, cb): void

  • Parameters

    • serialized: string | Serialized
    • cb: ((err, object) => void)
        • (err, object): void

        • Parameters

          • err: null | Error
          • object: CookieJar

          Returns void

    Returns void

Static deserializeSync

  • deserializeSync(serialized, store?): CookieJar

  • Parameters

    • serialized: string | Serialized
    • Optional store: Store

    Returns CookieJar

Static fromJSON

  • fromJSON(string): CookieJar

  • Parameters

    • string: string

    Returns CookieJar

Settings

Member Visibility

Theme

On This Page

constructorclonecloneSyncfetchAllCookiesfetchCookiesListfetchCookiesObjectgetCookieStringgetCookieStringSyncgetCookiesgetCookiesSyncgetSetCookieStringsgetSetCookieStringsSyncmergeCookiesremoveAllCookiesremoveAllCookiesSyncserializeserializeSyncsetCookiesetCookieSyncsyncCookiestoJSONdeserializedeserializeSyncfromJSON