memoize-one

memoizeOne

A memoization library which only remembers the latest invocation

Rationale

Cache invalidation is hard:

There are only two hard things in Computer Science: cache invalidation and naming things.

Phil Karlton

So keep things simple and just use a cache size of one.

Unlike other memoization libraries, memoizeOne only remembers the latest arguments and result. No need to worry about cache busting mechanisms such as maxAge, maxSize, exclusions and so on which can be prone to memory leaks. memoizeOne simply remembers the last arguments, and if the function is next called with the same arguments then it returns the previous result.

Usage

Standard usage

import memoizeOne from 'memoize-one';

const add = (a, b) => a + b;
const memoizedAdd = memoizeOne(add);

memoizedAdd(1, 2); // 3

memoizedAdd(1, 2); // 3
// Add function is not executed: previous result is returned

memoizedAdd(2, 3); // 5
// Add function is called to get new value

memoizedAdd(2, 3); // 5
// Add function is not executed: previous result is returned

memoizedAdd(1, 2); // 3
// Add function is called to get new value.
// While this was previously cached,
// it is not the latest so the cached result is lost

Play with this example

Custom equality function

You can also pass in a custom function for checking the equality of two items.

import memoizeOne from 'memoize-one';
import deepEqual from 'lodash.isEqual';

const identity = x => x;

const defaultMemoization = memoizeOne(identity);
const customMemoization = memoizeOne(identity, deepEqual);

const result1 = defaultMemoization({foo: 'bar'});
const result2 = defaultMemoization({foo: 'bar'});

result1 === result2 // false - difference reference

const result3 = customMemoization({foo: 'bar'});
const result4 = customMemoization({foo: 'bar'});

result3 === result4 // true - arguments are deep equal

Play with this example

Equality function type signature

Here is the expected flow type signature for a custom equality function:

type EqualityFn = (a: any, b: any) => boolean;

Dynamic properties

The result function will have the same .length property as the provided function.

const add = (a, b) => a + b;
const memoizedAdd = memoizeOne(add);

memoizedAdd.length === 2; // true

• For debug purposes we add a .name property to the result function. If provided function has a name then the name will be memoized_${yourFunction.name}. Otherwise it will be memoized_fn. This assists in debugging memoized functions.

// function has a name
const add = (a, b) => a + b;

// the original name is 'add'
add.name === 'add'; // true

// our new memoizedAdd function has a prefixed name
const memoizedAdd = memoizeOne(add);
memoizedAdd.name === 'memoized_add'; // true

// function does not have a name
const memoizedInline = memoizeOne((a, b) => a + b);
memoizedInline.name === 'memoized_fn';

Installation

# yarn
yarn add memoize-one

# npm
npm install memoize-one --save

Module usage

ES6 module

import memoizeOne from 'memoize-one';

CommonJS

If you are in a CommonJS environment (eg Node), then you will need to add .default to your import:

const memoizeOne = require('memoize-one').default;

this

memoizeOne correctly respects this control

This library takes special care to maintain, and allow control over the the this context for both the original function being memoized as well as the returned memoized function. Both the original function and the memoized function's this context respect all the this controlling techniques:

• new bindings (new)
• explicit binding (call, apply, bind);
• implicit binding (call site: obj.foo());
• default binding (window or undefined in strict mode);
• fat arrow binding (binding to lexical this)
• ignored this (pass null as this to explicit binding)

Changes to this is considered an argument change

Changes to the running context (this) of a function can result in the function returning a different value even though its arguments have stayed the same:

function getA() {
  return this.a;
}

const temp1 = {
  a: 20,
};
const temp2 = {
  a: 30,
}

getA.call(temp1); // 20
getA.call(temp2); // 30

Therefore, in order to prevent against unexpected results, memoizeOne takes into account the current execution context (this) of the memoized function. If this is different to the previous invocation then it is considered a change in argument. further discussion.

Generally this will be of no impact if you are not explicity controlling the this context of functions you want to memoize with explicit binding or implicit binding. memoizeOne will detect when you are manipulating this and will then consider the this context as an argument. If this changes, it will re-execute the original function even if the arguments have not changed.

Performance :rocket:

Tiny

memoizeOne is super lightweight at 457 bytes minified and 299 bytes gzipped. (1kb = 1000 bytes)

Extremely fast

memoizeOne performs better or on par with than other popular memoization libraries for the purpose of remembering the latest invocation.

Results

• simple arguments
• complex arguments

The comparisions are not exhaustive and are primiarly to show that memoizeOne accomplishes remembering the latest invocation really fast. The benchmarks do not take into account the differences in feature sets, library sizes, parse time, and so on.

Code health :thumbsup:

• Tested with all built in JavaScript types.
• 100% code coverage
• Continuous integration to run tests and type checks.
• Flow types for safer internal execution and external consumption. Also allows for editor autocompletion.
• Follows Semantic versioning (2.0) for safer consumption.
• No dependencies