Miss any of our Open RFC calls?Watch the recordings here! »

trie-memoize

1.2.0 • Public • Published

trie-memoize

Bundlephobia Types Code coverage Build status NPM Version MIT License

npm i trie-memoize

A memoization algorithm in which each function argument represents a new key in a mapping, creating a trie of caches - the depth of which defined by your setup. It is very quick with its O(n arguments) lookup performance and is memory-efficient, particularly when WeakMaps are used.

This memoization function only works for functions where the exact number of arguments is known and constant.

Quick Start

const m1 = memoize([{}], (v) => v.toUpperCase())
m1('foo') // FOO uncached
m1('foo') // FOO cached
 
const m2 = memoize([{}, Map], (v1, v2) => `${v1}-${v2}`)
m2('foo', 'bar') // foo-bar, uncached
m2('foo', 'bar') // foo-bar, cached
 
const m3 = memoize(
  [WeakMap, Map, WeakMap],
  (v1, v2, v3) =>
    `${JSON.stringify(v1)}-${JSON.stringify(v1)}-${JSON.stringify(v3)}`
)
 
const v1 = {}
const v2 = 'foo'
const v3 = {}
m3(v1, v2, v3) // {}-"foo"-{} uncached
m3(v1, v2, v3) // {}-"foo"-{} cached

API

memoize(caches, fn)

Argument Type Description
caches CacheConstructor[] An array of plain objects or map-like constructors (Map, WeakMap, some custom map w/ get + set methods) used for caching each level of the tree. The first array element will be the cache for the first argument of the function, call, and so on. Therefore, the length of this array must be the same as the length of arguments your memoized function accepts, or at least as deep as you'd like to cache.
fn (...args: T) => U The function you'd like to memoize

Types

CacheConstructor

export type CacheConstructor = 
  | MapConstructor
  | WeakMapConstructor
  | MapLike
  | Record<any, any>

LICENSE

MIT

Install

npm i trie-memoize

DownloadsWeekly Downloads

612

Version

1.2.0

License

MIT

Unpacked Size

26.6 kB

Total Files

20

Last publish

Collaborators

  • avatar