@midwayjs/session

Session component for @midwayjs/koa and @midwayjs/faas

Install

1$ npm i @midwayjs/session --save

Usage

@midwayjs/koa has enabled this component by default, @midwayjs/faas needs to be manually enabled.

1// src/configuration.ts
2
3import { join } from 'path';
4import * as faas from '@midwayjs/faas';
5import * as session from '@midwayjs/session';
6
7@Configuration({
8  imports: [
9    faas,
10    session,
11  ],
12  // ...
13})
14export class ContainerLifeCycle implements ILifeCycle {}
15

Config

You can configure session in your config.*.ts.

default value.

1export const session = {
2  maxAge: 24 * 3600 * 1000, // ms
3  key: 'mw.sess',
4  httpOnly: true,
5  encrypt: true,
6  // sameSite: null,
7  logValue: true,
8};

you can use all config from koa-session.

Custom Session Store

Write a session store class first, extends abstract SessionStore class.

1import { SessionStore } from '@midwayjs/session';
2
3@Provide()
4@Scope(ScopeEnum.Singleton)
5export class MemorySessionStore extends SessionStore {
6  sessions = {};
7  async get(key) {
8    return this.sessions[key];
9  }
10
11  async set(key, value) {
12    this.sessions[key] = value;
13  }
14
15  async destroy(key) {
16    this.sessions[key] = undefined;
17  }
18}

add custom sessionStore to session component.

1import { MemorySessionStore } from './store';
2import * as session from '@midwayjs/session';
3
4@Configuration({
5  imports: [
6    koa,
7    session,
8  ],
9  //...
10})
11export class AutoConfiguration {
12  @Inject()
13  memoryStore: MemorySessionStore;
14
15  @Inject()
16  sessionStoreManager: session.SessionStoreManager;
17
18  async onReady() {
19    this.sessionStoreManager.setSessionStore(this.memoryStore);
20  }
21}

Questions & Suggestions

Please open an issue here.

License

MIT