cookie

Cookie 操作工具。

导入

import { cookieGet, cookieSet, cookieDel } from '@cloudcome/utils-browser/cookie';
import type { CookieOptions } from '@cloudcome/utils-browser/cookie';

类型定义

CookieOptions

interface CookieOptions {
  expires?: DateValue;
  path?: string;
  domain?: string;
  secure?: boolean;
  sameSite?: 'strict' | 'lax' | 'none';
  maxAge?: number;
}

属性说明

属性	类型	描述
expires	DateValue	过期时间
path	string	Cookie 路径
domain	string	Cookie 域名
secure	boolean	是否只在 HTTPS 下传输
sameSite	'strict' | 'lax' | 'none'	SameSite 属性
maxAge	number	最大存活时间（秒）

函数

cookieGet

获取指定名称的 Cookie 值。

function cookieGet(name: string): string;

参数

参数	类型	描述
name	string	Cookie 名称

返回值

string - Cookie 值，如果不存在则返回空字符串

边界情况

• Cookie 值经过 decodeURIComponent 解码，如果解码失败（如包含非法编码），则返回原始未解码的值

示例

cookieGet('username'); // 'john'
cookieGet('nonexistent'); // ''

cookieSet

设置 Cookie。

function cookieSet(name: string, value: string, options?: CookieOptions): void;

参数

参数	类型	描述
name	string	Cookie 名称
value	string	Cookie 值
options	CookieOptions	可选配置

返回值

void

示例

// 基本用法
cookieSet('username', 'john');

// 设置过期时间（7 天）
cookieSet('username', 'john', { expires: 7 });

// 设置路径和域名
cookieSet('username', 'john', { path: '/', domain: '.example.com' });

// 设置 SameSite
cookieSet('username', 'john', { sameSite: 'strict' });

// 设置最大存活时间（秒）
cookieSet('username', 'john', { maxAge: 3600 });

cookieDel

删除指定名称的 Cookie。

function cookieDel(name: string): void;

参数

参数	类型	描述
name	string	Cookie 名称

返回值

void

示例

cookieDel('username');

实现细节

• 内部通过 cookieSet(name, '', { expires: 0 }) 实现，将 Cookie 值设为空并设置过期时间为 Unix 纪元（1970-01-01），使浏览器立即删除该 Cookie