cache

3.0.0 • Public • Published

Cache - A simple caching object with TTL

Copyright 2017 Sleepless Software Inc. All rights reserved.

Install

npm install cache

Usage

Cache = require("cache");

c = new Cache(10 * 1000);    // Create a cache with 10 second TTL

key = "foo";
val = "something";    // any object

c.put(key, val);      // put it in the cache.
                      // Optional 3rd arg is TTL for just this
					  // key, e.g.;  c.put(key, val, 5 * 1000);

c.get(key);           // "something" (less than 10 secs have passed)

// 11 seconds later ...
setTimeout(function() {

	c.get(key);       // expired out of cache

}, 11 * 1000);

More

You can also do some other stuff.

c.del(key)            // delete key/val before expiry

You can create a cache that will write its contents to a file in JSON form (not recommended for production purposes):

c = new Cache(10 * 1000, "data.json");

Now, when do anything that changes the contents of the cache, it will write it to the file "data.json":

c.put(key, val);		// data.json appears

Also, the cache will be preloaded from the file when you instantiate it, if the file is present.

Readme

Keywords

none

Package Sidebar

Install

npm i cache

Weekly Downloads

6,018

Version

3.0.0

License

ISC

Unpacked Size

3.45 kB

Total Files

4

Last publish

Collaborators

  • sleeplessinc