) => ({\n one,\n two,\n});\n\nexport default moize.serializeWith(JSON.stringify)(fn);\n```\n\n**NOTE**: If you want to use the default [`serializer`](#serializer), you should use [`moize.serialize`](#moizeserialize):\n\n```ts\nmoize.serialize(customSerializer)(fn);\n```\n\n## moize.shallow\n\nPre-applies the [`isShallowEqual`](#isshallowequal) option.\n\n```ts\nimport moize from 'moize';\n\nconst fn = (one: string, two: string) => `${one} ${two}`;\n\nexport default moize.shallow(fn);\n```\n\n## moize.transformArgs\n\nPre-applies the [`transformArgs`](#transformargs) option.\n\n```ts\nimport moize from 'moize';\n\nconst fn = ([one, two]: string[]) => [`${one} ${two}`];\n\nexport default moize.transformArgs(fn);\n```\n\n## moize.updateCacheForKey\n\nPre-applies the [`updateCacheForKey`](#updatecacheforkey) option.\n\n```ts\nimport moize from 'moize';\n\nlet lastUpdated = Date.now();\n\nconst fn = () => {\n const now = Date.now();\n const last = lastUpdated;\n\n lastUpdate = now;\n\n // its been more than 5 minutes since last update\n return last + 300000 < now;\n};\n\nexport default moize.updateCacheForKey(fn);\n```\n\n# useMoize hook\n\nIf you are using React 16.8+ and are using hooks, you can easily create a custom `useMoize` hook for your project:\n\n```ts\nimport { useRef } from 'react';\n\nexport function useMoize(fn, args, options) {\n const moizedFnRef = useRef(moize(fn, options));\n\n return moizedFnRef.current(...args);\n}\n```\n\nWhich can then be used as such:\n\n```tsx\nimport React from 'react';\n\nimport { useMoize } from './moize-hooks';\n\nfunction MyComponent({ first, second, object }) {\n // standard usage\n const sum = useMoize((a, b) => a + b, [first, second]);\n // with options\n const deepSum = useMoize((obj) => obj.a + obj.b, [object], {\n isDeepEqual: true,\n });\n\n return (\n \n Sum of {first} and {second} is {sum}. Sum of {object.a} and{' '}\n {object.b} is {deepSum}.\n
\n );\n}\n```\n\nNaturally you can tweak as needed for your project (default options, option-specific hooks, etc).\n\n**NOTE**: This is very similar to [`useCallback`](https://reactjs.org/docs/hooks-reference.html#usecallback) built-in hook, with two main differences:\n\n- There is a third parameter passed (the [`options`](#configuration-options) passed to `moize`)\n- The second argument array is the list of arguments passed to the memoized function\n\nIn both `useCallback` and `useMemo`, the array is a list of _dependencies_ which determine whether the funciton is called. These can be different than the arguments, although in general practice they are equivalent. The decision to use them directly was both for this common use-case reasons, but also because the implementation complexity would have increased substantially if not.\n\n# Composition\n\nStarting with version `2.3.0`, you can compose `moize` methods. This will create a new memoized method with the original function that shallowly merges the options of the two setups. Example:\n\n```tsx\nimport moize from 'moize';\n\nconst Component = (props: Record) => ;\n\n// memoizing with react, as since 2.0.0\nconst MemoizedFoo = moize.react(Component);\n\n// creating a separately-memoized method that has maxSize of 5\nconst LastFiveFoo = moize.maxSize(5)(MemoizedFoo);\n```\n\nYou can also create an options-first curriable version of `moize` if you only pass the options:\n\n```ts\nimport moize from 'moize';\n\n// creates a function that will memoize what is passed\nconst limitedSerializedMoize = moize({ maxSize: 5, serialize: true });\n\nconst getWord = (bird) => `${bird} is the word`;\n\nconst moizedGetWord = limitedSerializedMoize(getWord);\n```\n\nYou can also combine all of these options with `moize.compose` to create `moize` wrappers with pre-defined options.\n\n```ts\nimport moize from 'moize';\n\n// creates a moizer that will have the options of\n// {isReact: true, maxAge: 5000, maxSize: 5}\nconst superLimitedReactMoize = moize.compose(\n moize.react,\n moize.maxSize(5),\n moize.maxAge(5000)\n);\n```\n\n# Collecting statistics\n\nAs-of version 5, you can collect statistics of moize to determine if your cached methods are effective.\n\n```ts\nimport moize from 'moize';\n\nmoize.collectStats();\n\nconst fn = (one: string, two: string) => [one, two];\n\nconst moized = moize(fn);\n\nmoized('one', 'two');\nmoized('one', 'two');\n\nmoized.getStats(); // {\"calls\": 2, \"hits\": 1, \"usage\": \"50%\"}\n```\n\n**NOTE**: It is recommended not to activate this in production, as it will have a performance decrease.\n\n## Stats methods\n\n## clearStats\n\nCear statistics on `moize`d functions.\n\n```ts\nmoize.clearStats(); // clears all stats\nmoize.clearStats('profile-name'); // clears stats only for 'profile-name'\n```\n\n## collectStats\n\nSet whether collecting statistics on `moize`d functions.\n\n```ts\nmoize.collectStats(true); // start collecting stats\nmoize.collectStats(); // same as passing true\nmoize.collectStats(false); // stop collecting stats\n```\n\n**NOTE**: If collecting statistics, it is recommended to provide a custom [`profileName`](#profilename) or use [`moize.profile()`](#moizeprofile) for all memoized functions. This allows easier mapping of resulting statistics to their origin function when it has a common name or is anonymous.\n\n## getStats([profileName])\n\nGet the statistics for a specific function, or globally.\n\n```ts\nmoize.collectStats();\n\nconst fn = (one: string, two: string) => [one, two];\n\nconst moized = moize(fn);\n\nconst otherFn = (one: string[]) => one.slice(0, 1);\n\nconst otherMoized = moize(otherFn, { profileName: 'otherMoized' });\n\nmoized('one', 'two');\nmoized('one', 'two');\n\nmoized.getStats(); // {\"calls\": 2, \"hits\": 1, \"usage\": \"50%\"}\n\notherMoized(['three']);\n\nmoize.getStats('otherMoized'); // {\"calls\": 1, \"hits\": 0, \"usage\": \"0%\"}\n\nmoize.getStats();\n/*\n {\n \"calls\": 3,\n \"hits\": 1,\n \"profiles\": {\n \"fn at Object..src/utils.js (http://localhost:3000/app.js:153:68)\": {\n \"calls\": 2,\n \"hits\": 1,\n \"usage\": \"50%\"\n },\n \"otherMoized\": {\n \"calls\": 1,\n \"hits\": 0,\n \"usage\": \"0%\"\n }\n },\n \"usage\": \"33.3333%\"\n }\n */\n```\n\n# Introspection\n\n## isCollectingStats\n\nAre statistics being collected on memoization usage.\n\n```ts\nmoize.collectStats(true);\nmoize.isCollectingStats(); // true\nmoize.collectStats(false);\nmoize.isCollectingStats(); // false\n```\n\n## isMoized\n\nIs the function passed a moized function.\n\n```ts\nconst fn = () => {};\nconst moizedFn = moize(fn);\n\nmoize.isMoized(fn); // false\nmoize.isMoized(moizedFn); // true\n```\n\n# Direct cache manipulation\n\nThe cache is available on the `moize`d function as a property, and while it is not recommended to modify it directly, that option is available for edge cases.\n\n## cache\n\nThe shape of the `cache` is as follows:\n\n```ts\ntype Cache = {\n keys: any[][];\n size: number;\n values: any[];\n};\n```\n\nRegardless of how the key is transformed, it is always stored as an array (if the value returned is not an array, it is coalesced to one).\n\n**NOTE**: The order of `keys` and `values` should always align, so be aware when manually manipulating the cache that you need to manually keep in sync any changes to those arrays.\n\n## cacheSnapshot\n\nThe `cache` is mutated internally for performance reasons, so logging out the cache at a specific step in the workflow may not give you the information you need. As such, to help with debugging you can request the `cacheSnapshot`, which has the same shape as the `cache` but is a shallow clone of each property for persistence.\n\nThere are also convenience methods provided on the `moize`d function which allow for programmatic manipulation of the cache.\n\n## add(key, value)\n\nThis will manually add the _value_ at _key_ in cache if _key_ does not already exist. _key_ should be an `Array` of values, meant to reflect the arguments passed to the method.\n\n```ts\n// single parameter is straightforward\nconst memoized = moize((item: string) => item: string);\n\nmemoized.add(['one'], 'two');\n\n// pulls from cache\nmemoized('one');\n```\n\n**NOTE**: This will only add `key`s that do not exist in the cache, and will do nothing if the `key` already exists. If you want to update keys that already exist, use [`update`](#updatekey-value).\n\n## clear()\n\nThis will clear all values in the cache, resetting it to an empty state.\n\n```ts\nconst memoized = moize((item: string) => item);\n\nmemoized.clear();\n```\n\n## get(key)\n\nReturns the value in cache if the key matches, else returns `undefined`. _key_ should be an `Array` of values, meant to reflect the arguments passed to the method.\n\n```ts\nconst memoized = moize((one: string, two: string) => [one, two);\n\nmemoized('one', 'two');\n\nconsole.log(memoized.get(['one', 'two'])); // [\"one\",\"two\"]\nconsole.log(memoized.get(['two', 'three'])); // undefined\n```\n\n## getStats()\n\nReturns the statistics for the function.\n\n```ts\nmoize.collectStats();\n\nconst memoized = moize((one: string, two: string) => [one, two);\n\nmemoized('one', 'two');\nmemoized('one', 'two');\n\nconsole.log(memoized.getStats()); // {\"calls\": 2, \"hits\": 1, \"usage\": \"50%\"}\n```\n\n**NOTE**: You must be collecting statistics for this to be populated.\n\n## has(key)\n\nThis will return `true` if a cache entry exists for the _key_ passed, else will return `false`. _key_ should be an `Array` of values, meant to reflect the arguments passed to the method.\n\n```ts\nconst memoized = moize((one: string, two: string) => [one, two]);\n\nmemoized('one', 'two');\n\nconsole.log(memoized.has(['one', 'two'])); // true\nconsole.log(memoized.has(['two', 'three'])); // false\n```\n\n## keys()\n\nThis will return a list of the current keys in `cache`.\n\n```ts\nconst memoized = moize.maxSize(2)((item: any) => item);\n\nmemoized('one');\nmemoized({ two: 'three' });\n\nconst keys = memoized.keys(); // [['one'], [{two: 'three'}]]\n```\n\n## remove(key)\n\nThis will remove the provided _key_ from cache. _key_ should be an `Array` of values, meant to reflect the arguments passed to the method.\n\n```ts\nconst memoized = moize((item: { one: string }) => item);\n\nconst arg = { one: 'one' };\n\nmemoized(arg);\n\nmemoized.remove([arg]);\n\n// will re-execute, as it is no longer in cache\nmemoized(arg);\n```\n\n**NOTE**: This will only remove `key`s that exist in the cache, and will do nothing if the `key` does not exist.\n\n## update(key, value)\n\nThis will manually update the _value_ at _key_ in cache if _key_ exists. _key_ should be an `Array` of values, meant to reflect the arguments passed to the method.\n\n```ts\n// single parameter is straightforward\nconst memoized = moize((item: string) => item);\n\nmemoized.add(['one'], 'two');\n\n// pulls from cache\nmemoized('one');\n```\n\n**NOTE**: This will only update `key`s that exist in the cache, and will do nothing if the `key` does not exist. If you want to add keys that do not already exist, use [`add`](#addkey-value).\n\n## values()\n\nThis will return a list of the current values in `cache`.\n\n```ts\nconst memoized = moize.maxSize(2)((item: string | { two: string }) => ({\n item,\n}));\n\nmemoized('one');\nmemoized({ two: 'three' });\n\nconst values = memoized.values(); // [{item: 'one'}, {item: {two: 'three'}}]\n```\n\n# Benchmarks\n\nAll values provided are the number of operations per second calculated by the [Benchmark suite](https://benchmarkjs.com/), where a higher value is better. Each benchmark was performed using the default configuration of the library, with a fibonacci calculation based on a starting parameter of `35`, using single and multiple parameters with different object types. The results were averaged to determine overall speed across possible usage.\n\n**NOTE**: `lodash`, `ramda`, and `underscore` do not support multiple-parameter memoization without use of a `resolver` function. For consistency in comparison, each use the same `resolver` that returns the result of `JSON.stringify` on the arguments.\n\n| Name | Overall (average) | Single (average) | Multiple (average) | single primitive | single array | single object | multiple primitive | multiple array | multiple object |\n| ------------ | ----------------- | ---------------- | ------------------ | ---------------- | -------------- | -------------- | ------------------ | -------------- | --------------- |\n| **moize** | **71,177,801** | **98,393,482** | **43,962,121** | **139,808,786** | **97,571,202** | **57,800,460** | **44,509,528** | **44,526,039** | **42,850,796** |\n| lru-memoize | 48,391,839 | 64,270,849 | 32,512,830 | 77,863,436 | 59,876,764 | 55,072,348 | 29,917,027 | 33,308,028 | 34,313,435 |\n| mem | 42,348,320 | 83,158,473 | 1,538,166 | 128,731,510 | 73,473,478 | 47,270,433 | 2,012,120 | 1,565,253 | 1,037,126 |\n| fast-memoize | 33,145,713 | 64,942,152 | 1,349,274 | 190,677,799 | 2,149,467 | 1,999,192 | 1,718,229 | 1,297,911 | 1,031,683 |\n| lodash | 25,700,293 | 49,941,573 | 1,459,013 | 67,513,655 | 48,874,559 | 33,436,506 | 1,861,982 | 1,402,532 | 1,112,527 |\n| memoizee | 21,546,499 | 27,447,855 | 15,645,143 | 29,701,124 | 27,294,197 | 25,348,244 | 15,359,792 | 15,855,421 | 15,720,217 |\n| ramda | 18,804,380 | 35,919,033 | 1,689,727 | 101,557,928 | 1,895,956 | 4,303,215 | 2,305,025 | 1,597,131 | 1,167,025 |\n| memoizerific | 6,745,058 | 7,382,030 | 6,108,086 | 8,488,885 | 6,427,832 | 7,229,375 | 5,772,461 | 6,278,344 | 6,273,453 |\n| underscore | 6,701,695 | 11,698,265 | 1,705,126 | 18,249,423 | 4,695,658 | 12,149,714 | 2,310,412 | 1,630,769 | 1,174,197 |\n| addy-osmani | 4,926,732 | 6,370,152 | 3,483,311 | 12,506,809 | 3,568,399 | 3,035,249 | 6,898,542 | 2,009,089 | 1,542,304 |\n\n# Filesize\n\n`moize` is fairly small (~3.86KB when minified and gzipped), however it provides a large number of configuration options to satisfy a number of edge cases. If filesize is a concern, you may consider using [`micro-memoize`](https://github.com/planttheidea/micro-memoize). This is the memoization library that powers `moize` under-the-hood, and will handle most common use cases at 1/4 the size of `moize`.\n\n# Browser support\n\n- Chrome (all versions)\n- Firefox (all versions)\n- Edge (all versions)\n- Opera 15+\n- IE 9+\n- Safari 6+\n- iOS 8+\n- Android 4+\n\n# Development\n\nStandard stuff, clone the repo and `npm install` dependencies. The npm scripts available:\n\n- `benchmark` => run the benchmark suite pitting `moize` against other libraries in common use-cases\n- `benchmark:alternative` => run the benchmark suite for alternative forms of caching\n- `benchmark:array` => run the benchmark suite for memoized methods using single and multiple `array` parameters\n- `benchmark:object` => run the benchmark suite for memoized methods using single and multiple `object` parameters\n- `benchmark:primitive` => run the benchmark suite for memoized methods using single and multiple `object` parameters\n- `benchmark:react` => run the benchmark suite for memoized React components\n- `build` => run rollup to build the distributed files in `dist`\n- `clean:dist` => run `rimraf` on the `dist` folder\n- `clean:docs` => run `rimraf` on the `docs` folder\n- `clean:mjs` => run `rimraf` on the `mjs` folder\n- `copy:mjs` => run `clean:mjs` and the `es-to-mjs` script\n- `copy:types` => copy internal types to be available for consumer\n- `dev` => run webpack dev server to run example app (playground!)\n- `dist` => runs `clean:dist` and `build`\n- `docs` => runs `clean:docs` and builds the docs via `jsdoc`\n- `flow` => runs `flow check` on the files in `src`\n- `lint` => runs ESLint against all files in the `src` folder\n- `lint:fix` => runs `lint`, fixing any errors if possible\n- `test` => run `jest` test functions with `NODE_ENV=test`\n- `test:coverage` => run `test` but with code coverage\n- `test:watch` => run `test`, but with persistent watcher\n- `typecheck` => run `tsc` against source code to validate TypeScript\n","readmeFilename":"README.md","users":{"samobo":true,"tracker1":true}}![](\"https://img.shields.io/badge/build-passing-brightgreen.svg\"/){kind=icon}
\n![](\"https://img.shields.io/badge/coverage-100%25-brightgreen.svg\"/){kind=icon}
\n![](\"https://img.shields.io/badge/license-MIT-blue.svg\"/){kind=icon}
\n\n`moize` is a [consistently blazing fast](#benchmarks) memoization library for JavaScript. It handles multiple parameters (including default values) without any additional configuration, and offers a large number of options to satisfy any number of potential use-cases.\n\n- [Importing](#importing)\n - [ESM in browsers](#esm-in-browsers)\n - [ESM in NodeJS](#esm-in-nodejs)\n - [CommonJS](#commonjs)\n- [Usage](#usage)\n- [Configuration options](#configuration-options)\n - [isDeepEqual](#isdeepequal)\n - [isPromise](#ispromise)\n - [isReact](#isreact)\n - [isSerialized](#isserialized)\n - [isShallowEqual](#isshallowequal)\n - [matchesArg](#matchesarg)\n - [matchesKey](#matcheskey)\n - [maxAge](#maxage)\n - [maxArgs](#maxargs)\n - [maxSize](#maxsize)\n - [onCacheAdd](#oncacheadd)\n - [onCacheChange](#oncachechange)\n - [onCacheHit](#oncachehit)\n - [onExpire](#onexpire)\n - [profileName](#profilename)\n - [serializer](#serializer)\n - [transformArgs](#transformargs)\n - [updateCacheForKey](#updatecacheforkey)\n - [updateExpire](#updateexpire)\n- [Usage with shortcut methods](#usage-with-shortcut-methods)\n - [moize.deep](#moizedeep)\n - [moize.infinite](#moizeinfinite)\n - [moize.matchesArg](#moizematchesarg)\n - [moize.matchesKey](#moizematcheskey)\n - [moize.maxAge](#moizemaxage)\n - [moize.maxArgs](#moizemaxargs)\n - [moize.maxSize](#moizemaxsize)\n - [moize.profile](#moizeprofile)\n - [moize.promise](#moizepromise)\n - [moize.react](#moizereact)\n - [moize.serialize](#moizeserialize)\n - [moize.serializeWith](#moizeserializewith)\n - [moize.shallow](#moizeshallow)\n - [moize.transformArgs](#moizetransformargs)\n - [moize.updateCacheForKey](#moizeupdatecacheforkey)\n- [useMoize hook](#usemoize-hook)\n- [Composition](#composition)\n- [Collecting statistics](#collecting-statistics)\n - [Stats methods](#stats-methods)\n - [clearStats](#clearstats)\n - [collectStats](#collectstats)\n - [getStats([profileName])](#getstatsprofilename)\n- [Introspection](#introspection)\n - [isCollectingStats](#iscollectingstats)\n - [isMoized](#ismoized)\n- [Direct cache manipulation](#direct-cache-manipulation)\n - [cache](#cache)\n - [cacheSnapshot](#cachesnapshot)\n - [add(key, value)](#addkey-value)\n - [clear()](#clear)\n - [get(key)](#getkey)\n - [getStats()](#getstats)\n - [has(key)](#haskey)\n - [keys()](#keys)\n - [remove(key)](#removekey)\n - [update(key, value)](#updatekey-value)\n - [values()](#values)\n- [Benchmarks](#benchmarks)\n- [Filesize](#filesize)\n- [Browser support](#browser-support)\n- [Development](#development)\n\n```\n$ npm i moize --save\n```\n\n# Importing\n\n## ESM in browsers\n\n```ts\nimport moize from 'moize';\n```\n\n## ESM in NodeJS\n\n```ts\nimport moize from 'moize/mjs/index.mjs';\n```\n\n## CommonJS\n\n```ts\nconst moize = require('moize');\n```\n\n# Usage\n\n```ts\nimport moize from 'moize';\n\nconst method = (a: number, b: number) => a + b;\n\nconst memoized = moize(method);\n\nmemoized(2, 4); // 6\nmemoized(2, 4); // 6, pulled from cache\n```\n\nAll parameter types are supported, including circular objects, functions, etc. There are also a number of [shortcut methods](#usage-with-shortcut-methods) to memoize for unique use-cases.\n\n# Configuration options\n\n`moize` optionally accepts an object of options as either the second parameter or as the first step in a curried function:\n\n```ts\n// inline\nmoize(fn, options);\n\n// curried\nmoize(options)(fn);\n```\n\nThe full shape of these options:\n\n```ts\ntype Options = {\n // is the cache based on deep equality of each key argument\n isDeepEqual: boolean;\n // is the result a promise\n isPromise: boolean;\n // is the result a React component\n isReact: boolean;\n // should the parameters be serialized instead of directly referenced\n isSerialized: boolean;\n // is the cache based on shallow equality of each key argument\n isShallowEqual: boolean;\n // custom method to compare equality between two key arguments\n matchesArg: (cachedKeyArg: any, keyArg: any) => boolean;\n // custom method to compare equality across all key arguments\n matchesKey: (cachedKey: any[], key: any[]) => boolean;\n // amount of time in milliseconds before the cache will expire\n maxAge: number;\n // maximum number of arguments passed to use as key for caching\n maxArgs: number;\n // maximum size of cache for this method\n maxSize: number;\n // method fired when a new entry is added to cache\n onCacheAdd: (\n cache: moize.Cache,\n options: moize.Options,\n moized: (...args: any[]) => any\n ) => void;\n // method fire when either a new entry is added to cache or the LRU ordering of the cache has changed\n onCacheChange: (\n cache: moize.Cache,\n options: moize.Options,\n moized: (...args: any[]) => any\n ) => void;\n // method fired when an existing entry in cache is used\n onCacheHit: (\n cache: moize.Cache,\n options: moize.Options,\n moized: (...args: any[]) => any\n ) => void;\n // method to fire when a cache entry expires (in combination with maxAge)\n onExpire: (key: any[]) => void;\n // the unique identifier to give the memoized method when collecting statistics\n profileName: string;\n // method to serialize the arguments to build a unique cache key\n serializer: (key: any[]) => string;\n // method to transform the args into a custom format for key storage in cache\n transformArgs: (key: any[]) => any[];\n // should the cache entry be refreshed by calling the underlying function with the same parameters and\n // updating the value stored in cache to be the new result\n updateCacheForKey: (key: any[]) => boolean;\n // should the cache entry's expiration be refreshed when the cache entry is hit (in combination with maxAge)\n updateExpire: boolean;\n};\n```\n\nAll default values can be found [here](src/constants.ts).\n\n## isDeepEqual\n\n_defaults to false_\n\nShould deep equality be used to compare cache each key argument.\n\n```ts\ntype Arg = {\n one: {\n nested: string;\n };\n two: string;\n};\n\nconst fn = ({ one, two }: Arg) => [one, two];\n\nconst memoized = moize(fn, { isDeepEqual: true });\n\nmemoized({ one: { nested: 'one' }, two: 'two' });\nmemoized({ one: { nested: 'one' }, two: 'two' }); // pulls from cache\n```\n\nThis is also available via the shortcut method of [`moize.deep`](#moizedeep)\n\n```ts\nconst memoized = moize.deep(fn);\n```\n\n## isPromise\n\n_defaults to false_\n\nIs the computed value in the function a `Promise`.\n\n```ts\nconst fn = async (item: Promise