# @eggjs/session > session plugin for egg Latest version **5.1.0** (published 2026-10-07) · MIT license · 0 weekly downloads ## Install ```sh npm install @eggjs/session pnpm add @eggjs/session yarn add @eggjs/session bun add @eggjs/session ``` ## Health **Score 75/100 (B)** — status: active. Positive: has types; esm support; no vulnerabilities; has provenance; recently updated; high maintenance score; popular repo. Warnings: low downloads. ## Facts | | | |---|---| | Version | 5.1.0 | | Published | 2026-10-07 | | First published | 2025-01-19 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | bundled | | Module format | ESM | | Node | >= 22.18.0 | | Dependencies | 2 | | Unpacked size | 11.8 KB | | Known vulnerabilities | 0 | | Install scripts | no | | Provenance | attested (GitHub Actions) | | GitHub stars | 18984 | | Author | dead_horse | | Maintainers | gxkl, eggjs-admin, fengmk2, atian25, hyj1991, killagu, coolme200, akitasummer, elrrrrrrr, niania | | Keywords | cookie, egg, egg-plugin, eggPlugin, session | ## Links - npm: https://www.npmjs.com/package/@eggjs/session - Repository: https://github.com/eggjs/egg - Homepage: https://github.com/eggjs/egg/tree/next/plugins/session#readme - Issues: https://github.com/eggjs/egg/issues - npm.io page: https://npm.io/package/@eggjs/session ## Dependencies (2) - [zod](https://npm.io/package/zod.md) ^3.24.1 - [koa-session](https://npm.io/package/koa-session.md) ^7.0.2 ## Alternatives - [@clerk/clerk-expo](https://npm.io/package/@clerk/clerk-expo.md) — 133.6K weekly downloads - [@pothos/plugin-authz](https://npm.io/package/@pothos/plugin-authz.md) — 12.4K weekly downloads - [@bounded-sh/client](https://npm.io/package/@bounded-sh/client.md) — 3.2K weekly downloads - [@luigi-project/plugin-auth-oauth2](https://npm.io/package/@luigi-project/plugin-auth-oauth2.md) — 2.3K weekly downloads - [@nocobase/plugin-verification](https://npm.io/package/@nocobase/plugin-verification.md) — 2.0K weekly downloads ## Recent versions - 5.1.0 (latest) — 2026-10-07 - 5.0.2-rc.1 (rc) — 2026-10-06 - 5.0.2-beta.27 (beta) — 2026-09-20 - 5.0.2 — 2026-10-06 - 5.0.2-rc.0 — 2026-09-23 - 5.0.2-beta.26 — 2026-08-07 - 5.0.2-beta.25 — 2026-07-13 - 5.0.2-beta.24 — 2026-07-12 - 5.0.2-beta.23 — 2026-07-11 - 5.0.2-beta.22 — 2026-07-11 - 5.0.2-beta.20 — 2026-07-09 - 5.0.2-beta.19 — 2026-06-29 - 5.0.2-beta.17 — 2026-06-28 - 5.0.2-beta.16 — 2026-06-26 - 5.0.2-beta.15 — 2026-06-26 - … 39 more at https://npm.io/package/@eggjs/session/versions ## README # @eggjs/session [![NPM version][npm-image]][npm-url] [![Known Vulnerabilities][snyk-image]][snyk-url] [![npm download][download-image]][download-url] [![Node.js Version](https://img.shields.io/node/v/@eggjs/session.svg?style=flat)](https://nodejs.org/en/download/) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://makeapullrequest.com) ![CodeRabbit Pull Request Reviews](https://img.shields.io/coderabbit/prs/github/eggjs/session) [npm-image]: https://img.shields.io/npm/v/@eggjs/session.svg?style=flat-square [npm-url]: https://npmjs.org/package/@eggjs/session [snyk-image]: https://snyk.io/test/npm/@eggjs/session/badge.svg?style=flat-square [snyk-url]: https://snyk.io/test/npm/@eggjs/session [download-image]: https://img.shields.io/npm/dm/@eggjs/session.svg?style=flat-square [download-url]: https://npmjs.org/package/@eggjs/session Session plugin for egg, based on [koa-session](https://github.com/koajs/session). ## Usage `session` is a built-in plugin in egg and enabled by default. ```js // {app_root}/config/plugin.js exports.session = true; // enable by default ``` ### External Store egg-session support external store, you can store your sessions in redis, memcached or other databases. For example, if you want to store session in redis, you must: 1. Dependent [@eggjs/redis](https://github.com/eggjs/egg/tree/next/plugins/redis) ```bash npm i --save @eggjs/redis ``` 2. Import `@eggjs/redis` as a plugin and set the configuration ```js // config/plugin.js exports.redis = { enable: true, package: '@eggjs/redis', }; ``` ```js // config/config.default.js exports.redis = { // your redis configurations }; ``` 3. Implement a session store with redis ```js // app.js module.exports = (app) => { // set redis session store // session store must have 3 methods // define sessionStore in `app.js` so you can access `app.redis` app.sessionStore = { async get(key) { const res = await app.redis.get(key); if (!res) return null; return JSON.parse(res); }, async set(key, value, maxAge) { // maxAge not present means session cookies // we can't exactly know the maxAge and just set an appropriate value like one day if (!maxAge) maxAge = 24 * 60 * 60 * 1000; value = JSON.stringify(value); await app.redis.set(key, value, 'PX', maxAge); }, async destroy(key) { await app.redis.del(key); }, }; // session store can be a session store class // app.sessionStore = class Store { // constructor(app) { // this.app = app; // } // async get() {} // async set() {} // async destroy() {} // }; }; ``` Once you use external session store, session is strong dependent on your external store, you can't access session if your external store is down. **Use external session stores only if necessary, avoid use session as a cache, keep session lean and stored by cookie!** ## Configuration Support all configurations in [koa-session](https://github.com/koajs/session). - logValue ```bash Support not to print the session value when session event trigger log. Default to be true. ``` [View the default configurations](https://github.com/eggjs/egg/tree/next/plugins/session/src/config/config.default.ts) ## Questions & Suggestions Please open an issue [here](https://github.com/eggjs/egg/issues). ## License [MIT](LICENSE) ## Contributors [![Contributors](https://contrib.rocks/image?repo=eggjs/egg)](https://github.com/eggjs/egg/graphs/contributors) Made with [contributors-img](https://contrib.rocks). --- _Source: https://npm.io/package/@eggjs/session · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._