npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@hellomouse/session-pouchdb-store

v0.3.3

Published

PouchDB express session store. Can do realtime session data synchronization via PouchDB server

Downloads

13

Readme

session-pouchdb-store

A PouchDB session store for express.js.

Build Status

Features

  • Compatible with PouchDB and CouchDB (or any database that uses the CouchDB API).
  • Realtime session data synchronization between processes (if PouchDB/CouchDB server is used)
  • Default in-memory PouchDB instance.
  • Custom PouchDB instance.
  • Scavenge and purge invalid/expired sessions.

Installation

npm install session-pouchdb-store --save

This will install session-pouchdb-store and add it to your application's package.json file.

Important Notes

If you use a remote PouchDB server, make sure the database exists prior to start your application/s

Basic Usage

Use with your express session middleware, like this:

const
	express = require("express"),
	session = require("express-session"),
	PouchSession = require("session-pouchdb-store");

let app = express();

app.use(session({
  secret: 'thisismysecret',
  resave: false,
  saveUninitialized: true,
	store : new PouchSession()
}));

app.listen(3000, () => {
	console.log(`Server ${process.pid} started on port 3000`);
});

By default, PouchSession creates an in-memory database for testing purposes. You can pass your own instance or connect to a remote PouchDB/CouchDB server:

Remote PouchDB server

app.use(session({
  secret: 'thisismysecret',
  resave: false,
  saveUninitialized: true,
	store : new PouchSession('http://pouchdbserver:port/sessions')
}));

Custom instance

const PouchDB = require('pouchdb');

let db = new PouchDB("sessions",{adapter:'leveldb'});
app.use(session({
  secret: 'thisismysecret',
  resave: false,
  saveUninitialized: true,
	store : new PouchSession(db)
}));

Realtime synchronization

In order to synchronize session data, the current version of the store requires a remote PouchDB server, so multiple express processes can connect to the same database and perform synchronization.

API

new PouchSession(pouchInstance, options)

Creates a new store instance. The first argument can be one of the following:

  • null If no arguments is passed, a default in-memory instance is created.
  • PouchDB instance The PouchDB instance that will be used by the store.
  • URL string A URL string to a remote PouchDB/CouchDB server.

Options is an object that allows overriding some store behaviours:

  • maxIdle Max time in ms a session can go idle. When this time exceeds, the session is remove from the store cache. Note that a session can be idle and still be a valid session; session expiration is defined by the express-session module. The purpose of this parameter is to release from memory sessions that are not being used.
  • scavenge Interval time in ms that the store will search and release maxIdle sessions.
  • purge Interval time in ms that the the store will remove expired sessions from the database.

Default options are as follows:

Here is a list of all available options:

var options = {
	// Max idle time in ms
	maxIdle : 5*60*1000,
	// Scavenge period in ms
	scavenge : 1000,
	// Database purge period in ms					
	purge : 5*60*1000			
};