node-localcache/README.md

LocalStorage with optional json file cache

# Node LocalCache [![Build Status][ci-img]][ci]
[ci-img]:  https://travis-ci.org/glebmachine/node-localcache.svg
[ci]:      https://travis-ci.org/glebmachine/node-localcache

Module, allows to save application data between launches in json data file. Api most liked as LocalStorage API

## Usage

```js
var LocalCache = require('node-localcache');

cache = new LocalCache('.cache/filetocache.json');
cache.setItem('key', 'value');
cache.getItem('key'); // value
```

## Options
```js
new LocalCache(fileName, skipFileCaching);
```
- `fileName` - (optional with `skipFileCaching`: `true`) Path to cache file, also used as store `id`
- `skipFileCaching` - (optional) disable file cache, default `false`

## FS Perfomance
All manipulation agregating and applying 1 time per second. But, don't panic, on nodejs exit, everything will be saved into file.