https://github.com/requarks/connect-loki

A Loki.js session store for Connect/Express
https://github.com/requarks/connect-loki

Last synced: about 1 year ago
JSON representation

A Loki.js session store for Connect/Express

• Host: GitHub
• URL: https://github.com/requarks/connect-loki
• Owner: requarks
• License: mit
• Created: 2016-08-21T18:21:25.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2023-01-07T04:13:20.000Z (over 3 years ago)
• Last Synced: 2025-05-09T02:59:03.420Z (about 1 year ago)
• Language: JavaScript
• Size: 951 KB
• Stars: 50
• Watchers: 3
• Forks: 11
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# connect-loki

[![NPM version](http://img.shields.io/npm/v/connect-loki.svg)](https://www.npmjs.com/package/connect-loki)

[![Build Status](https://travis-ci.org/Requarks/connect-loki.svg?branch=master)](https://travis-ci.org/Requarks/connect-loki)

[![Codacy Badge](https://api.codacy.com/project/badge/Grade/97c0f52f6fcc471caeccf45827ff3361)](https://www.codacy.com/app/Requarks/connect-loki)

[![Known Vulnerabilities](https://snyk.io/test/github/requarks/connect-loki/badge.svg)](https://snyk.io/test/github/requarks/connect-loki)

[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/requarks/connect-loki/blob/master/LICENSE)

##### A Loki.js session store for Connect/Express

### Setup

```shell

npm install connect-loki express-session

```

Pass the `express-session` store into `connect-loki` to create a `LokiStore` constructor.

```js

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

var LokiStore = require('connect-loki')(session);

var options = {}; // See available options below

app.use(session({

    store: new LokiStore(options),

    secret: 'keyboard cat'

}));

```

### Options

Setting the `path` to the database file is optional but recommended.

Available parameters:

-	`path` Path to the database file. Defaults to `./session-store.db`

-	`autosave` Set `false` to disable save to disk. Defaults to `true`

- `ttl` Duration in seconds to keep stale sessions. Set to `0` to disable TTL. Defaults to `1209600` (14 days)

-	`logErrors` Whether or not to log client errors. Defaults to `false`

	-	If `true`, a default logging function (`console.error`) is provided.

	-	If a function, it is called anytime an error occurs (useful for custom logging)

	-	If `false`, no logging occurs.

### License

MIT