npm 包 egg-cookies 使用教程

介绍

egg-cookies 是一个基于 Egg.js 框架的 Cookie 插件，它提供了一些非常方便的 API，可以轻松地设置、获取和删除 Cookie。在前端开发中，Cookie 是一个非常重要的部分，它可以用于保存用户信息、用户偏好设置等。

安装

使用 npm 安装：

npm install egg-cookies

引入插件

在 config/plugin.js 中添加以下代码：

exports.cookies = {
  enable: true,
  package: 'egg-cookies',
};

使用示例

设置 Cookie

const ctx = this.ctx;
ctx.cookies.set('name', 'value');

我们可以将第三个参数传递给 set 方法，该参数是一个对象，可以配置其他选项。例如：

• expires - 过期时间，以毫秒为单位。
• path - Cookie 路径，默认为 '/'。
• domain - Cookie 域名。
• httpOnly - 是否只能通过 HTTP 访问 Cookie，默认为 true。
• secure - 是否只能通过 HTTPS 访问 Cookie，默认为 false。
• signed - 是否启用签名，以防止篡改 Cookie 默认为 false。

const ctx = this.ctx;
ctx.cookies.set('name', 'value', {
  expires: new Date('2023-01-01'),
  path: '/my-path',
  httpOnly: false,
  secure: true,
  signed: true,
});

获取 Cookie

const ctx = this.ctx;
const value = ctx.cookies.get('name');

如果要获取所有可用的 Cookie，可以使用 ctx.cookies.getAll() 方法。

删除 Cookie

const ctx = this.ctx;
ctx.cookies.set('name', null);

总结

egg-cookies 是一个非常方便的插件，它提供了一些操作 Cookie 的简单 API。在前端开发中，Cookie 是一个非常重要的部分，对于保护用户隐私和存储用户信息都有很大的作用。希望本文能够对您有所帮助！

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/45111