benhurdavies/node-cache-engine

High performing caching package for node/javascript

node-cache-engine (supports browser and node)

Simple and High performing cache engine package for node/javascript. It using default cache replacement is LRU (Least Recently Used) cache engine and hash table as javascript Map Object.

Installation

npm install --save node-cache-engine

import { createCache } from 'node-cache-engine';

const cache = createCache(); // creating instance of cache with default configuration

cache.add('key', 'value'); // add into cache
cache.get('key'); // get from cache
cache.has('key'); // checking from key is existing in cache
cache.remove('key'); // removing from cache
cache.size(); // get the size of cache

Option for creating cache instance

import { createCache } from 'node-cache-engine';

const cache = createCache({
  size: 100, // Maximum size for the cache. default value is Number.MAX_SAFE_INTEGER
  engine: 'LRU', // cache replacement engine default is LRU (Least Recently Used)
  HashTable: YourCustomHashTable, // for custom hash Table. default hashTable is 'src/dataStructure/HashTable.js'
});

Supported cache replacement engines and options

Engines Name	key	supported options
Least Recently Used	LRU	HashTable, size
Least Frequently Used	LFU	HashTable, size

Time complexity of engine methods

Engine	Method	Time complexity
LRU/LFU	add	O(1)
	get	O(1)
	has	O(1)
	remove	O(1)
	size	O(1)

Methods available on cache engines

Methods	LRU	LFU
add	✅	✅
get	✅	✅
has	✅	✅
remove	✅	✅
size	✅	✅
clearAll	✅	❌
toArray	✅	❌

Creating Custom HashTable

When and Why you should create custom hash table?
The default hash table implemented with Map. If you want much more performance than default you can implement your own (like node wrapped c++ hash table). I think 1 to 5 million cache entry default hash table is fine if your use case is more than this go for custom hash table.

To implement custom hashTable you have to use methods with symbols name provided from the package. example

Next?

• TTL engine
• TTL combining with LRU engine

Contribute

Contributions to this project are always welcome.
Please read CONTRIBUTING.md for a How-to.

node-cache-engine's Issues

TTL engine

Add TypeScript support

Update CI to support full test process

See husky commit hook to see all the tests that should be also done in CI

Least frequently used

Could you please implement 'least frequently used' cache replacement algorithm?

Improve eslint / prettify support

Automatic changelog support

Improve test coverage

TTL with LRU / LFU

Update CI to remove deprecation warnings