Options
All
  • Public
  • Public/Protected
  • All
Menu

express-session-etcd3

CircleCI

An ETCD v3 store adapter for express-session using etcd3 client.

Setup

Install this package with all necessary peer dependencies:

npm install express-session-etcd3 express-session etcd3

Pass the necessary configuration to access your etcd v3 base into the Etcd3Store constructor as options:

var session = require('express-session');
var Etcd3Store = require('express-session-etcd3');

app.use(session({
    store: new Etcd3Store(options),
    secret: 'keyboard cat',
    resave: false
}));

Options

You can find all the available options at the documentation.

Documentation

Our TypeDoc docs are available here.

Our test cases are also quite readable.

Contributing

You can find all the steps at the Contributing Guide.

Credits

This project was easily bootstrapped with TypeScript library starter, thanks for sharing it!

License

MIT

Index

Variables

Const defaultOptions

defaultOptions: Etcd3StoreOptions = Object.freeze({prefix: 'sess',hosts: '127.0.0.1:2379',skipTouch: false})

Default configuration values for the etcd v3 options

Const maxTTL

maxTTL: 6442450 = 6442450

Max TTL time to leasing on ETCD3 Client in seconds.

Const oneDay

oneDay: 86400 = 86400

One day in seconds.

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc