Home

Awesome

stats-map Build Status

Mem cache map that keeps track of the hits and misses

Install

$ npm install --save stats-map

Usage

const StatsMap = require('./');
const mem = require('mem');

let i = 0;
const counter = () => ++i;

const cache = new StatsMap();
const memoized = mem(counter, {cache});

memoized('foo');
//=> 1

// cached as it's the same argument
memoized('foo');
//=> 1

// not cached anymore as the argument changed
memoized('bar');
//=> 2

memoized('bar');
//=> 2

console.log(cache.stats);
//=> {hits: 2, misses: 2}

API

StatsMap([iterable])

Inherits from Map.

.stats

Type: object

The statistics of the map like the hits and misses.

Related

License

MIT © Sam Verschueren