https://github.com/fabioricali/incache
Powerful key/value in-memory storage or on disk to persist data
https://github.com/fabioricali/incache
cache cache-storage global http-response in-memory javascript memory-storage node-cache nodejs session-management singleton storage window
Last synced: 9 months ago
JSON representation
Powerful key/value in-memory storage or on disk to persist data
- Host: GitHub
- URL: https://github.com/fabioricali/incache
- Owner: fabioricali
- Created: 2017-08-12T15:53:05.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2020-09-04T16:40:49.000Z (over 5 years ago)
- Last Synced: 2025-05-06T22:45:34.409Z (9 months ago)
- Topics: cache, cache-storage, global, http-response, in-memory, javascript, memory-storage, node-cache, nodejs, session-management, singleton, storage, window
- Language: JavaScript
- Homepage:
- Size: 534 KB
- Stars: 15
- Watchers: 4
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
Powerful key/value in-memory storage or on disk to persist data
## What does?
InCache is a module that store any info in memory, it can be used for example for storing **server sessions**, **caching http response** or **sharing singleton object** in your apps.
It also give you the possibility to save data on disk so you can avoid the data loss when the process exit or restart. In a browser scenario all data is saved on localStorage through a key.
## Installation
### Node.js
```
npm install incache --save
```
## Examples
### Basic
```javascript
const InCache = require('incache');
const store = new InCache();
// Create a record with key 'my key'
store.set('my key', 'my value');
// Update 'my key'
store.set('my key', {a: 1, b: 2});
// Get key
store.get('my key');
// Remove 'my key'
store.remove('my key');
// Clear
store.clear();
// Expires after 2 seconds
store.set('my string', 'hello world', {maxAge: 2000});
// Or expires on...
store.set('my string', 'hello world', {expires: '2028-08-22 12:00:00'});
```
### Auto remove expired records
```javascript
const store = new InCache({
autoRemovePeriod: 2 //checks every 2 seconds
});
store.set('my string', 'hello world', {maxAge: 4000});
setTimeout(()=>{
console.log(store.count()) //=> 0
}, 6000);
```
### Max cache size
```javascript
const store = new InCache({
maxRecordNumber: 5
});
store.set('k0', 'v0');
store.set('k1', 'v1');
store.set('k2', 'v2');
store.set('k3', 'v3');
store.set('k4', 'v4');
store.set('k5', 'v5');
console.log(store.count()); //=> 5
console.log(store.has('k0')); //=> false
```
### Load manually
```javascript
const store = new InCache({
autoLoad: false
});
// This method returns a Promise
store.load('my-path/my-store.json').then(() => {
console.log('loaded');
}).catch(err => {
console.log(err);
});
```
### Save on disk
By default this operation is running before the process is terminated
```javascript
const store = new InCache({
autoSave: true
});
```
Save when data is changed
```javascript
const store = new InCache({
autoSave: true,
autoSaveMode: 'timer'
});
```
### Save manually
```javascript
const store = new InCache({
filePath: 'my-path/my-store.json'
});
store.set('a key', 'a value');
// This method returns a Promise
store.save();
// or specify a path
store.save('a-path/a-file.json').then(()=>{
console.log('saved');
store.load('a-path/a-file.json');
}).catch(err => {
console.log(err);
});
```
### Browser scenario
In browser environment the file path becomes a string key for localStorage interface:
```javascript
store.load('myLocalStorageKey');
store.save('myLocalStorageKey');
```
### Events
```javascript
// Triggered when a record has been deleted
incache.on('remove', key => {
console.log(key);
});
// Triggered before create/update
incache.on('beforeSet', (key, value) => {
console.log(key, value);
if(foo)
return false;
});
// Triggered when a record has been created
incache.on('create', (key, record) => {
console.log(key, record);
});
//Triggered when a record has been updated
incache.on('update', (key, record) => {
console.log(key, record);
});
//Triggered when the cache is saved on disk
incache.on('save', () => {
console.log('saved on disk');
});
//Triggered when the cache exceed max size
incache.on('exceed', (diff) => {
console.log(`exceeded for ${diff}`);
});
//... for more events see the documentation
```
### API
Please see the **full documentation** for more details.
### Browser
#### Local
```html
```
#### CDN unpkg
```html
```
#### CDN jsDeliver
```html
```
## Changelog
You can view the changelog here
## License
InCache is open-sourced software licensed under the MIT license
## Author
Fabio Ricali
## Contributor
Davide Polano