0.0.3 • Published 9 years ago

short-term-memory v0.0.3

Weekly downloads
3
License
MIT
Repository
github
Last release
9 years ago

short-term-memory

MIT License Build Status Code Climate Coverage Status NPM Downloads NPM Dependencies Code Documentation

In-memory short-term single-get key-value-store.

Installation

Basic: npm install short-term-memory

As Dependency: npm install short-term-memory --save

Require in Node: var ShortTermMemory = require('short-term-memory');

Purpose

Short-term-memory is mostly used to store tokens, as the in-memory database is automatically deleting entries after a configurable time. In addition to that entries are deleted when accessed once. So you don't need to worry about tokens being used multiple times. An example for this usage can be found in one of my projects.

Usage

Initialization

var ShortTermMemory = require('short-term-memory');
var myStore = new ShortTermMemory({
    duration: 60000
}); // delete entries after 60 seconds

Add entry

myStore.add('unique token you generated or other key', {
    some: 'object',
    string: 'or',
    other: 'data'
});

Retrieve entry

var token = myStore.get('unique token you generated or other key');
if (token !== false) {
    // token is valid and automatically removed from myStore
} else {
    // token invalid or already used
}