@jsxiaosi/utils

Appearance

On this page

Cookies 操作工具 ​

设置、获取和删除 cookie。

ts
import { cookies } from '@jsxiaosi/utils';

设置cookie ​

ts
import { cookies } from '@jsxiaosi/utils'; 

// 设置一个名为 'myCookie' 的 cookie，值为 'myValue'，路径为 '/'，在 https 下才会被发送，且在跨站请求时也会被发送
cookies.set('myCookie', 'myValue', { days: 7, path: '/', secure: true, sameSite: 'None' });

参数:

参数描述类型默认值
namecookie 的名称string无
valuecookie 的值string无
optionscookie 选项配置CookieOptions无

获取cookie ​

ts
import { cookies } from '@jsxiaosi/utils'; 

// 获取名为 'myCookie' 的 cookie 的值
let myCookieValue = cookies.get('myCookie');

// 获取所有的 cookie
let allCookies = cookies.get();

参数:

参数描述类型默认值
name可选的 cookie 名称string无

返回值:

类型描述
string | null | { [key: string]: string }如果提供了 name 参数，那么返回该 cookie 的值；如果没有提供 name 参数，那么返回一个包含所有 cookie 的对象；如果找不到指定的 cookie，那么返回 null。

删除cookie ​

ts
import { cookies } from '@jsxiaosi/utils'; 

// 删除名为 'myCookie' 的 cookie
cookies.remove('myCookie');

// 删除所有的 cookie
cookies.remove();

参数:

参数描述类型默认值
name可选的 cookie 名称string无
optionscookie 选项配置CookieOptions无

类型 ​

CookieOptions ​

参数描述类型
expires有效期number
path路径string
domaincookie所在的域string
secure是否启用安全协议传输boolean
sameSite同站策略string