All Projects → eggjs → egg-session

eggjs / egg-session

Licence: MIT License
session plugin for egg

Programming Languages

javascript
184084 projects - #8 most used programming language

Projects that are alternatives of or similar to egg-session

egg-weapp-sdk
Egg的微信小程序登录会话管理SDK
Stars: ✭ 111 (+131.25%)
Mutual labels:  session, egg, egg-plugin
egg-session-redis
redis store for egg session
Stars: ✭ 41 (-14.58%)
Mutual labels:  session, egg, egg-plugin
egg-kafkajs
☎️kafka plugin for eggjs
Stars: ✭ 26 (-45.83%)
Mutual labels:  egg, egg-plugin
egg-vue-webpack-dev
基于egg + vue2 + webpack2 的前后端集成开发编译构建插件
Stars: ✭ 29 (-39.58%)
Mutual labels:  egg, egg-plugin
egg-elasticsearch
elasticsearch client for egg.js
Stars: ✭ 22 (-54.17%)
Mutual labels:  egg, egg-plugin
egg-oracle
OracleDB plugin for egg
Stars: ✭ 23 (-52.08%)
Mutual labels:  egg, egg-plugin
egg-grpc
grpc plugin for egg
Stars: ✭ 79 (+64.58%)
Mutual labels:  egg, egg-plugin
egg-view-react
egg view plugin for react
Stars: ✭ 89 (+85.42%)
Mutual labels:  egg, egg-plugin
egg-rbac
Role Based Access Control for eggjs
Stars: ✭ 32 (-33.33%)
Mutual labels:  egg, egg-plugin
egg-view-vue-ssr
Egg Vue Server Side Render (SSR) Plugin
Stars: ✭ 90 (+87.5%)
Mutual labels:  egg, egg-plugin
egg-userservice
userservice plugin for egg
Stars: ✭ 21 (-56.25%)
Mutual labels:  egg, egg-plugin
egg-swagger
swagger-ui plugin for egg ,Demo:
Stars: ✭ 26 (-45.83%)
Mutual labels:  egg, egg-plugin
egg-aop
AOP plugin for eggjs, add DI, AOP support.
Stars: ✭ 44 (-8.33%)
Mutual labels:  egg, egg-plugin
egg-sentry
Sentry Plugin For Egg.js
Stars: ✭ 18 (-62.5%)
Mutual labels:  egg, egg-plugin
egg-y-validator
☯️ Egg Magic Validator (Egg 魔法验证工具)
Stars: ✭ 30 (-37.5%)
Mutual labels:  egg, egg-plugin
egg-mailer
🥚 mailer plugin for egg
Stars: ✭ 23 (-52.08%)
Mutual labels:  egg, egg-plugin
egg-kafka-node
kafka plugin for egg.js
Stars: ✭ 36 (-25%)
Mutual labels:  egg, egg-plugin
egg-exporter
Egg.js 的 Prometheus 指标收集插件,附带 Grafana 看板。
Stars: ✭ 24 (-50%)
Mutual labels:  egg, egg-plugin
egg-view-pug
egg view plugin for pug.
Stars: ✭ 24 (-50%)
Mutual labels:  egg, egg-plugin
egg-rest
Restful API plugin for egg
Stars: ✭ 106 (+120.83%)
Mutual labels:  egg, egg-plugin

egg-session

NPM version build status Test coverage David deps Known Vulnerabilities npm download

Session plugin for egg, based on koa-session.

Install

$ npm i egg-session --save

Usage

egg-session is a built-in plugin in egg and enabled by default.

// {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 egg-redis
npm i --save egg-redis
  1. Import egg-redis as a plugin and set the configuration
// config/plugin.js
exports.redis = {
  enable: true,
  package: 'egg-redis',
};
// config/config.default.js
exports.redis = {
  // your redis configurations
};
  1. Implement a session store with redis
// 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.

  • logValue
Support not to print the session value when session event trigger log. Default to be true.

View the default configurations

Questions & Suggestions

Please open an issue here.

License

MIT

Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].