node package manager
Stop writing boring code. Discover, share, and reuse within your team. Create a free org »

mem

mem Build Status

Memoize functions - An optimization used to speed up consecutive function calls by caching the result of calls with identical input

Install

$ npm install mem

Usage

const mem = require('mem');
 
let i = 0;
const counter = () => ++i;
const memoized = mem(counter);
 
memoized('foo');
//=> 1
 
// Cached as it's the same arguments
memoized('foo');
//=> 1
 
// Not cached anymore as the arguments changed
memoized('bar');
//=> 2
 
memoized('bar');
//=> 2
Works fine with promise returning functions
const mem = require('mem');
 
let i = 0;
const counter = () => Promise.resolve(++i);
const memoized = mem(counter);
 
memoized().then(a => {
    console.log(a);
    //=> 1
 
    memoized().then(b => {
        // The return value didn't increase as it's cached
        console.log(b);
        //=> 1
    });
});
const mem = require('mem');
const got = require('got');
const memGot = mem(got, {maxAge: 1000});
 
memGot('sindresorhus.com').then(() => {
    // This call is cached
    memGot('sindresorhus.com').then(() => {
        setTimeout(() => {
            // This call is not cached as the cache has expired
            memGot('sindresorhus.com').then(() => {});
        }, 2000);
    });
});

API

mem(fn, [options])

fn

Type: Function

Function to be memoized.

options

maxAge

Type: number
Default: Infinity

Milliseconds until the cache expires.

cacheKey

Type: Function

Determines the cache key for storing the result based on the function arguments. By default, if there's only one argument and it's a primitive, it's used directly as a key, otherwise it's all the function arguments JSON stringified as an array.

You could for example change it to only cache on the first argument x => JSON.stringify(x).

cache

Type: Object
Default: new Map()

Use a different cache storage. Must implement the following methods: .has(key), .get(key), .set(key, value), .delete(key), and optionally .clear(). You could for example use a WeakMap instead or quick-lru for a LRU cache.

cachePromiseRejection

Type: boolean
Default: false

Cache rejected promises.

mem.clear(fn)

Clear all cached data of a memoized function.

fn

Type: Function

Memoized function.

Tips

Cache statistics

If you want to know how many times your cache had a hit or a miss, you can make use of stats-map as a replacement for the default cache.

Example

const mem = require('mem');
const StatsMap = require('stats-map');
const got = require('got');
 
const cache = new StatsMap();
const memGot = mem(got, {cache});
 
memGot('sindresorhus.com')
    .then(() => memGot('sindresorhus.com'))
    .then(() => memGot('sindresorhus.com'));
 
console.log(cache.stats);
//=> {hits: 2, misses: 1}

Related

  • p-memoize - Memoize promise-returning & async functions

License

MIT © Sindre Sorhus