constructor

CookieMap.constructor

constructor CookieMap(
init?: string | string[][] | Record<string, string>

Creates a new CookieMap instance.

@param init

Optional initial data for the cookie map:

  • string: A cookie header string (e.g., "name=value; foo=bar")
  • string[][]: An array of name/value pairs (e.g., [["name", "value"], ["foo", "bar"]])
  • Record<string, string>: An object with cookie names as keys (e.g., { name: "value", foo: "bar" })

Referenced types

class CookieMap

A Map-like collection of cookies.

Iterable, so it works with for...of loops.

  • readonly size: number

    The number of cookies in the map.

  • [Symbol.iterator](): IterableIterator<[string, string]>;

    Returns the default iterator for the CookieMap. Used by for...of loops to iterate over all entries.

    @returns

    An iterator for the entries in the map

  • name: string
    ): void;

    Removes a cookie from the map.

    @param name

    The name of the cookie to delete

    options: CookieStoreDeleteOptions
    ): void;

    Removes a cookie from the map.

    @param options

    The options for the cookie to delete

    name: string,
    options: Omit<CookieStoreDeleteOptions, 'name'>
    ): void;

    Removes a cookie from the map.

    @param name

    The name of the cookie to delete

    @param options

    The options for the cookie to delete

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

    Returns an iterator of [name, value] pairs for every cookie in the map.

    @returns

    An iterator for the entries in the map

  • callback: (value: string, key: string, map: CookieMap) => void
    ): void;

    Executes a provided function once for each cookie in the map.

    @param callback

    Function to execute for each entry

  • name: string
    ): null | string;

    Gets the value of a cookie with the specified name.

    @param name

    The name of the cookie to retrieve

    @returns

    The cookie value as a string, or null if the cookie doesn't exist

  • name: string
    ): boolean;

    Checks if a cookie with the given name exists.

    @param name

    The name of the cookie to check

    @returns

    true if the cookie exists, false otherwise

  • keys(): IterableIterator<string>;

    Returns an iterator of all cookie names in the map.

    @returns

    An iterator for the cookie names

  • name: string,
    value: string,
    options?: CookieInit
    ): void;

    Adds or updates a cookie in the map.

    @param name

    The name of the cookie

    @param value

    The value of the cookie

    @param options

    Optional cookie attributes

    options: CookieInit
    ): void;

    Adds or updates a cookie in the map using a cookie options object.

    @param options

    Cookie options including name and value

  • toJSON(): Record<string, string>;

    Converts the cookie map to a serializable format.

    @returns

    An object mapping cookie names to values

  • toSetCookieHeaders(): string[];

    Returns the Set-Cookie header values that apply the changes made to this map.

    @returns

    An array of Set-Cookie header values

  • values(): IterableIterator<string>;

    Returns an iterator of all cookie values in the map.

    @returns

    An iterator for the cookie values