@cloudcome/utils-browser/dist/cookie.d.ts

cloudcome utils for browser

import { DateValue } from '@cloudcome/utils-core/date';
/**
 * 获取指定名称的 Cookie 值。
 * @param {string} name - Cookie 的名称。
 * @returns {string} - 返回对应的 Cookie 值，如果不存在则返回空字符串。
 */
export declare function cookieGet(name: string): string;
/**
 * 设置 Cookie。
 * @param {string} name - Cookie 的名称。
 * @param {string} value - Cookie 的值。
 * @param {CookieOptions} [options] - 可选的 Cookie 配置项。
 */
export type CookieOptions = {
    /**
     * Cookie 的过期时间，可以是日期字符串、时间戳或 `Date` 对象。
     */
    expires?: DateValue;
    /**
     * Cookie 的路径，默认为当前路径。
     */
    path?: string;
    /**
     * Cookie 的域名，默认为当前域名。
     */
    domain?: string;
    /**
     * 是否启用安全传输（HTTPS）。
     */
    secure?: boolean;
    /**
     * SameSite 属性，可选值为 `'strict'`、`'lax'` 或 `'none'`。
     */
    sameSite?: 'strict' | 'lax' | 'none';
    /**
     * 是否启用 HttpOnly 标志，防止 JavaScript 访问。
     */
    httpOnly?: boolean;
    /**
     * Cookie 的最大存活时间（秒）。
     */
    maxAge?: number;
};
/**
 * 设置 Cookie。
 * @param {string} name - Cookie 的名称。
 * @param {string} value - Cookie 的值。
 * @param {CookieOptions} [options] - 可选的 Cookie 配置项。
 */
export declare function cookieSet(name: string, value: string, options?: CookieOptions): void;
/**
 * 删除指定名称的 Cookie。
 * @param {string} name - 要删除的 Cookie 名称。
 */
export declare function cookieDel(name: string): void;