egg-cookies

2.10.0 • Public • Published

egg-cookies

NPM version build status Test coverage npm download

Extends pillarjs/cookies to adapt koa and egg with some additional features.

Encrypt

egg-cookies provide an alternative encrypt mode like signed. An encrypt cookie's value will be encrypted base on keys. Anyone who don't have the keys are unable to know the original cookie's value.

const Cookies = require('egg-cookies');
const cookies = new Cookies(ctx, keys[, defaultCookieOptions]);

cookies.set('foo', 'bar', { encrypt: true });
cookies.get('foo', { encrypt: true });

Note: you should both indicating in get and set in pairs.

Cookie Length Check

Browsers all had some limitation in cookie's length, so if set a cookie with an extremely long value(> 4093), egg-cookies will emit an cookieLimitExceed event. You can listen to this event and record.

const Cookies = require('egg-cookies');
const cookies = new Cookies(ctx, keys);

cookies.on('cookieLimitExceed', { name, value } => {
  // log
});

cookies.set('foo', longText);

License

MIT

Contributors


fengmk2


dead-horse


semantic-release-bot


atian25


whxaxes


xyeric


jedmeng


Junyan


beliefgp


snapre


popomore


tang-xy


ziyunfei


brizer


xuezier


onlylovermb

This project follows the git-contributor spec, auto updated at Mon Feb 19 2024 17:41:40 GMT+0800.

Readme

Keywords

none

Package Sidebar

Install

npm i egg-cookies

Weekly Downloads

22,222

Version

2.10.0

License

MIT

Unpacked Size

31.5 kB

Total Files

9

Last publish

Collaborators

  • atian25
  • dead_horse
  • wanghx
  • fengmk2
  • popomore