Skip to content

jeromeetienne/MicroCache.js

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

microcache.js is a micro library to handle in-memory cache (works in node+browser).

Install it

To install it on node

npm install microcache

To install the browser version, download it and include it like that

<script src="microcache.js"></script>   

API

To instanciate a cache, do the following. You can have as many instances you want.

var microcache = new MicroCache();

.get(key)

To get a cached asset which is in the cache. Each cached element has a unique key to identify it.

microcache.get('foo');

.set(key, value)

To set a element value in the cache.

microcache.set('foo', 'bar');

.contains(key)

To know if a given asset is currently in the cache.

microcache.contains('foo');

.values()

To return all the elements currently in the cache

microcache.values();

.getSet(key, value)

To get an element from the cache, if it isnt already present, store it then return it.

microcache.getSet(key, value);

If second parameter is a function, it is called only if the key isnt contained in the cache. Thus the value isn't instanciated without need.

microcache.getSet(key, function(){ return value });

FAQ

  • Q. what about plain var microcache = {} ? isnt this wrapper overengineering ?
  • A. i was thinking so too at first. but the syntax of a .getSet() without wrapper was too ugly for my taste :) var a = cache[key] = (cache[key] || value) from @floriancargoet

About

micro library to handle in-memory cache (works in node+browser)

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published