node-tls-client-kgb/typings/lib/Cookie.d.ts

Advanced library based on node-fetch and tls-client.

import { CookieJar } from "tough-cookie";
export declare class Cookies extends CookieJar {
    constructor();
    /**
     * 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 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"
     *    }
     *  }
     */
    fetchAllCookies(): import("tough-cookie").Cookie.Serialized;
    /**
     * Fetches the cookies for a given URL as an object.
     *
     * @param url - The URL from which cookies are to be fetched.
     * @returns An object containing cookies as key-value pairs.
     *
     * @example
     * fetchCookiesObject('http://example.com')
     */
    fetchCookiesObject(url: string): Record<string, string>;
    /**
     * Fetches the cookies for a given URL as an array of objects.
     * Each object contains the name and value of a cookie.
     *
     * @param url - The URL from which cookies are to be fetched.
     * @returns An array of objects, each containing the name and value of a cookie.
     *
     * @example
     * fetchCookiesList('http://example.com')
     */
    fetchCookiesList(url: string): {
        name: string;
        value: string;
    }[];
    /**
     * Checks and sets cookies for a given URL.
     *
     * @param cookies - An object containing cookies as key-value pairs.
     * @param url - The URL for which cookies are to be set.
     * @returns An object containing cookies as key-value pairs.
     *
     * @example
     * syncCookies({ 'cookie1': 'value1', 'cookie2': 'value2' }, 'http://example.com')
     */
    syncCookies(cookies: Record<string, string>, url: string): Record<string, string>;
    /**
     * Merges the provided cookies with the existing cookies for a given URL according to request payload.
     *
     * @param cookies - An object containing cookies as key-value pairs.
     * @param url - The URL for which cookies are to be set.
     * @returns An array of objects, each containing the name and value of a cookie.
     *
     * @example
     * mergeCookies({ 'cookie1': 'value1', 'cookie2': 'value2' }, 'http://example.com')
     */
    mergeCookies(cookies: Record<string, string>, url: string): {
        name: string;
        value: string;
    }[];
}