Secbone / Koa Session2
Licence: mit
Middleware for Koa2 to get/set session
Stars: ✭ 156
Programming Languages
javascript
184084 projects - #8 most used programming language
Projects that are alternatives of or similar to Koa Session2
Sactive Web
🚀 A dependency injection web framework for Node.js.
Stars: ✭ 143 (-8.33%)
Mutual labels: koa2
React Koa Login
koa2 + react + react-router(4.0) + redux + webpack + antd
Stars: ✭ 109 (-30.13%)
Mutual labels: koa2
Light Push
轻量级推送服务和实时在线监控平台,同时用于开发即时通信系统,基于node的socket.io,支持web、android、ios客户端,支持移动端离线推送,可进行分布式部署
Stars: ✭ 128 (-17.95%)
Mutual labels: koa2
Sentinel Crawler
Xenomorph Crawler, a Concise, Declarative and Observable Distributed Crawler(Node / Go / Java / Rust) For Web, RDB, OS, also can act as a Monitor(with Prometheus) or ETL for Infrastructure 💫 多语言执行器,分布式爬虫
Stars: ✭ 118 (-24.36%)
Mutual labels: koa2
Don Blog Backmanage
Don's blog的后台管理系统,基于Vue.js + Node.js + Koa.js + MySQL + Redis + WebSocket。
Stars: ✭ 112 (-28.21%)
Mutual labels: koa2
Strapi
🚀 Open source Node.js Headless CMS to easily build customisable APIs
Stars: ✭ 41,786 (+26685.9%)
Mutual labels: koa2
Yn
Yank Note 一款面向程序员的 Markdown 笔记应用。支持加密文档,代码片段运行,内置终端,图表嵌入,HTML 小工具。
Stars: ✭ 143 (-8.33%)
Mutual labels: koa2
Koa Mobx React Starter
A straightforward starter for Node javascript web projects. Using Koa, MobX and ReactJS (with universal / isomorphic server rendering)
Stars: ✭ 102 (-34.62%)
Mutual labels: koa2
koa-session2
Middleware for Koa2 to get/set session use with custom stores such as Redis or mongodb
Use native ES6(async/await) by Nodejs v7.6.0 +
Or you can use the old versions:
Require
node v7.6 +
Install
npm install koa-session2
Usage
const Koa = require("koa");
const session = require("koa-session2");
const app = new Koa();
app.use(session({
key: "SESSIONID", //default "koa:sess"
}));
Custom Stores
Store.js
const Redis = require("ioredis");
const { Store } = require("koa-session2");
class RedisStore extends Store {
constructor() {
super();
this.redis = new Redis();
}
async get(sid, ctx) {
let data = await this.redis.get(`SESSION:${sid}`);
return JSON.parse(data);
}
async set(session, { sid = this.getID(24), maxAge = 1000000 } = {}, ctx) {
try {
// Use redis set EX to automatically drop expired sessions
await this.redis.set(`SESSION:${sid}`, JSON.stringify(session), 'EX', maxAge / 1000);
} catch (e) {}
return sid;
}
async destroy(sid, ctx) {
return await this.redis.del(`SESSION:${sid}`);
}
}
module.exports = RedisStore;
main.js
const Koa = require("koa");
const session = require("koa-session2");
const Store = require("./Store.js");
const app = new Koa();
app.use(session({
store: new Store()
}));
app.use(ctx => {
let user = ctx.session.user;
ctx.session.view = "index";
});
app.use(ctx => {
// refresh session if set maxAge
ctx.session.refresh()
})
Options
Most options based on cookies
-
key
: a string for store session id in cookie -
store
: a class for custom store (extend {Store}, func: #get(sid), #set(session, opts), #destory(sid)) -
maxAge
: a number representing the milliseconds fromDate.now()
for expiry -
expires
: aDate
object indicating the cookie's expiration date (expires at the end of session by default). -
path
: a string indicating the path of the cookie (/
by default). -
domain
: a string indicating the domain of the cookie (no default). -
secure
: a boolean indicating whether the cookie is only to be sent over HTTPS (false
by default for HTTP,true
by default for HTTPS). -
httpOnly
: a boolean indicating whether the cookie is only to be sent over HTTP(S), and not made available to client JavaScript (true
by default). -
sameSite
: a boolean or string indicating whether the cookie is a "same site" cookie (false
by default). This can be set to'strict'
,'lax'
, ortrue
(which maps to'strict'
). -
signed
: a boolean indicating whether the cookie is to be signed (false
by default). If this is true, another cookie of the same name with the.sig
suffix appended will also be sent, with a 27-byte url-safe base64 SHA1 value representing the hash of cookie-name=cookie-value against the first Keygrip key. This signature key is used to detect tampering the next time a cookie is received. -
overwrite
: a boolean indicating whether to overwrite previously set cookies of the same name (false
by default). If this is true, all cookies set during the same request with the same name (regardless of path or domain) are filtered out of the Set-Cookie header when setting this cookie.
Methods
-
refresh()
: if you setmaxAge
in options, you can callctx.session.refresh()
to refresh session to your store
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].