@sophat/cookies/dist/cookie/index.d.ts

This project provides a set of utility functions for interacting with browser cookies. The `Cookies` class offers methods to set, get, update, remove, and clear cookies, as well as retrieve all cookie keys.

import { CookieOptions } from "../interfaces/cookie-options";
export declare class Cookies {
    /**
     * Sets a cookie with the specified name, value, and options.
     *
     * @param name - The name of the cookie to set
     * @param value - The value to store in the cookie
     * @param options - Optional configuration object for the cookie
     * @param options.expires - Expiration date of the cookie (as Date object or number of days)
     * @param options.path - Path on the server where the cookie will be accessible
     * @param options.domain - Domain where the cookie will be accessible
     * @param options.secure - If true, cookie will only be transmitted over secure HTTPS
     * @param options.sameSite - Controls how the cookie is sent with cross-site requests
     *
     * @example
     * ```typescript
     * // Set a cookie that expires in 7 days
     * Cookie.setItem('userToken', 'abc123', { expires: 7 });
     *
     * // Set a secure cookie with specific domain
     * Cookie.setItem('sessionId', '12345', {
     *   secure: true,
     *   domain: 'example.com',
     *   sameSite: 'strict'
     * });
     * ```
     */
    static setItem(name: string, value: string, options?: CookieOptions): void;
    /**
     * Returns the value of the cookie with the specified name.
     *
     * @param name - The name of the cookie to retrieve
     *
     * @example
     * ```typescript
     * const userToken = Cookie.getItem('userToken');
     * console.log(userToken); // 'abc123'
     * ```
     */
    static getItem(name: string): string | null;
    /**
     * Removes the cookie with the specified name.
     *
     * @param name - The name of the cookie to remove
     * @param options - Optional configuration object for the cookie
     * @param options.path - Path on the server where the cookie is accessible
     * @param options.domain - Domain where the cookie is accessible
     *
     * @example
     * ```typescript
     * Cookie.removeItem('userToken');
     * ```
     */
    static removeItem(name: string, options?: CookieOptions): void;
    /**
     * Returns an array of all cookie names.
     *
     * @example
     * ```typescript
     * const cookieNames = Cookie.getKeys();
     * console.log(cookieNames); // ['userToken', 'sessionId']
     * ```
     */
    static getKeys(): string[];
    /**
     * Has the cookie with the specified name been set?
     * Returns true if the cookie is set, and false otherwise.
     *
     * @param name - The name of the cookie to check
     *
     * @example
     * ```typescript
     * const hasUserToken = Cookie.hasItem('userToken');
     * console.log(hasUserToken); // true
     * ```
     */
    static hasItem(name: string): boolean;
}
export type { CookieOptions };
export default Cookies;