https://github.com/eggjs/session
session plugin for egg
https://github.com/eggjs/session
egg egg-plugin egg-session session
Last synced: about 2 months ago
JSON representation
session plugin for egg
- Host: GitHub
- URL: https://github.com/eggjs/session
- Owner: eggjs
- License: mit
- Created: 2016-07-14T09:40:54.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2025-01-21T16:43:26.000Z (about 1 year ago)
- Last Synced: 2025-12-03T15:30:01.633Z (3 months ago)
- Topics: egg, egg-plugin, egg-session, session
- Language: TypeScript
- Homepage:
- Size: 62.5 KB
- Stars: 49
- Watchers: 7
- Forks: 9
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-egg - egg-session - Session 实现。   (仓库 / [内置插件](https://eggjs.org/zh-cn/basics/plugin.html#%E6%8F%92%E4%BB%B6%E5%88%97%E8%A1%A8))
README
# @eggjs/session
[![NPM version][npm-image]][npm-url]
[](https://github.com/eggjs/session/actions/workflows/nodejs.yml)
[![Test coverage][codecov-image]][codecov-url]
[![Known Vulnerabilities][snyk-image]][snyk-url]
[![npm download][download-image]][download-url]
[](https://nodejs.org/en/download/)
[](https://makeapullrequest.com)
[npm-image]: https://img.shields.io/npm/v/@eggjs/session.svg?style=flat-square
[npm-url]: https://npmjs.org/package/@eggjs/session
[codecov-image]: https://codecov.io/gh/eggjs/session/branch/master/graph/badge.svg
[codecov-url]: https://codecov.io/gh/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).
## Install
```bash
npm i @eggjs/session
```
## Usage
egg-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/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-session/blob/master/config/config.default.js)
## Questions & Suggestions
Please open an issue [here](https://github.com/eggjs/egg/issues).
## License
[MIT](LICENSE)
## Contributors
[](https://github.com/eggjs/session/graphs/contributors)
Made with [contributors-img](https://contrib.rocks).