) => ({
one,
two,
});
export default @hutechwebsite/neque-neque-voluptas-blanditiis.serializeWith(JSON.stringify)(fn);
```
**NOTE**: If you want to use the default [`serializer`](#serializer), you should use [`@hutechwebsite/neque-neque-voluptas-blanditiis.serialize`](#@hutechwebsite/neque-neque-voluptas-blanditiisserialize):
```ts
@hutechwebsite/neque-neque-voluptas-blanditiis.serialize(customSerializer)(fn);
```
## @hutechwebsite/neque-neque-voluptas-blanditiis.shallow
Pre-applies the [`isShallowEqual`](#isshallowequal) option.
```ts
import @hutechwebsite/neque-neque-voluptas-blanditiis from '@hutechwebsite/neque-neque-voluptas-blanditiis';
const fn = (one: string, two: string) => `${one} ${two}`;
export default @hutechwebsite/neque-neque-voluptas-blanditiis.shallow(fn);
```
## @hutechwebsite/neque-neque-voluptas-blanditiis.transformArgs
Pre-applies the [`transformArgs`](#transformargs) option.
```ts
import @hutechwebsite/neque-neque-voluptas-blanditiis from '@hutechwebsite/neque-neque-voluptas-blanditiis';
const fn = ([one, two]: string[]) => [`${one} ${two}`];
export default @hutechwebsite/neque-neque-voluptas-blanditiis.transformArgs(fn);
```
## @hutechwebsite/neque-neque-voluptas-blanditiis.updateCacheForKey
Pre-applies the [`updateCacheForKey`](#updatecacheforkey) option.
```ts
import @hutechwebsite/neque-neque-voluptas-blanditiis from '@hutechwebsite/neque-neque-voluptas-blanditiis';
let lastUpdated = Date.now();
const fn = () => {
const now = Date.now();
const last = lastUpdated;
lastUpdate = now;
// its been more than 5 minutes since last update
return last + 300000 < now;
};
export default @hutechwebsite/neque-neque-voluptas-blanditiis.updateCacheForKey(fn);
```
# useMoize hook
If you are using React 16.8+ and are using hooks, you can easily create a custom `useMoize` hook for your project:
```ts
import { useRef } from 'react';
export function useMoize(fn, args, options) {
const @hutechwebsite/neque-neque-voluptas-blanditiisdFnRef = useRef(@hutechwebsite/neque-neque-voluptas-blanditiis(fn, options));
return @hutechwebsite/neque-neque-voluptas-blanditiisdFnRef.current(...args);
}
```
Which can then be used as such:
```tsx
import React from 'react';
import { useMoize } from './@hutechwebsite/neque-neque-voluptas-blanditiis-hooks';
function MyComponent({ first, second, object }) {
// standard usage
const sum = useMoize((a, b) => a + b, [first, second]);
// with options
const deepSum = useMoize((obj) => obj.a + obj.b, [object], {
isDeepEqual: true,
});
return (
Sum of {first} and {second} is {sum}. Sum of {object.a} and{' '}
{object.b} is {deepSum}.
);
}
```
Naturally you can tweak as needed for your project (default options, option-specific hooks, etc).
**NOTE**: This is very similar to [`useCallback`](https://reactjs.org/docs/hooks-reference.html#usecallback) built-in hook, with two main differences:
- There is a third parameter passed (the [`options`](#configuration-options) passed to `@hutechwebsite/neque-neque-voluptas-blanditiis`)
- The second argument array is the list of arguments passed to the me@hutechwebsite/neque-neque-voluptas-blanditiisd function
In 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.
# Composition
Starting with version `2.3.0`, you can compose `@hutechwebsite/neque-neque-voluptas-blanditiis` methods. This will create a new me@hutechwebsite/neque-neque-voluptas-blanditiisd method with the original function that shallowly merges the options of the two setups. Example:
```tsx
import @hutechwebsite/neque-neque-voluptas-blanditiis from '@hutechwebsite/neque-neque-voluptas-blanditiis';
const Component = (props: Record) => ;
// memoizing with react, as since 2.0.0
const Me@hutechwebsite/neque-neque-voluptas-blanditiisdFoo = @hutechwebsite/neque-neque-voluptas-blanditiis.react(Component);
// creating a separately-me@hutechwebsite/neque-neque-voluptas-blanditiisd method that has maxSize of 5
const LastFiveFoo = @hutechwebsite/neque-neque-voluptas-blanditiis.maxSize(5)(Me@hutechwebsite/neque-neque-voluptas-blanditiisdFoo);
```
You can also create an options-first curriable version of `@hutechwebsite/neque-neque-voluptas-blanditiis` if you only pass the options:
```ts
import @hutechwebsite/neque-neque-voluptas-blanditiis from '@hutechwebsite/neque-neque-voluptas-blanditiis';
// creates a function that will me@hutechwebsite/neque-neque-voluptas-blanditiis what is passed
const limitedSerializedMoize = @hutechwebsite/neque-neque-voluptas-blanditiis({ maxSize: 5, serialize: true });
const getWord = (bird) => `${bird} is the word`;
const @hutechwebsite/neque-neque-voluptas-blanditiisdGetWord = limitedSerializedMoize(getWord);
```
You can also combine all of these options with `@hutechwebsite/neque-neque-voluptas-blanditiis.compose` to create `@hutechwebsite/neque-neque-voluptas-blanditiis` wrappers with pre-defined options.
```ts
import @hutechwebsite/neque-neque-voluptas-blanditiis from '@hutechwebsite/neque-neque-voluptas-blanditiis';
// creates a @hutechwebsite/neque-neque-voluptas-blanditiisr that will have the options of
// {isReact: true, maxAge: 5000, maxSize: 5}
const superLimitedReactMoize = @hutechwebsite/neque-neque-voluptas-blanditiis.compose(
@hutechwebsite/neque-neque-voluptas-blanditiis.react,
@hutechwebsite/neque-neque-voluptas-blanditiis.maxSize(5),
@hutechwebsite/neque-neque-voluptas-blanditiis.maxAge(5000)
);
```
# Collecting statistics
As-of version 5, you can collect statistics of @hutechwebsite/neque-neque-voluptas-blanditiis to determine if your cached methods are effective.
```ts
import @hutechwebsite/neque-neque-voluptas-blanditiis from '@hutechwebsite/neque-neque-voluptas-blanditiis';
@hutechwebsite/neque-neque-voluptas-blanditiis.collectStats();
const fn = (one: string, two: string) => [one, two];
const @hutechwebsite/neque-neque-voluptas-blanditiisd = @hutechwebsite/neque-neque-voluptas-blanditiis(fn);
@hutechwebsite/neque-neque-voluptas-blanditiisd('one', 'two');
@hutechwebsite/neque-neque-voluptas-blanditiisd('one', 'two');
@hutechwebsite/neque-neque-voluptas-blanditiisd.getStats(); // {"calls": 2, "hits": 1, "usage": "50%"}
```
**NOTE**: It is recommended not to activate this in production, as it will have a performance decrease.
## Stats methods
## clearStats
Cear statistics on `@hutechwebsite/neque-neque-voluptas-blanditiis`d functions.
```ts
@hutechwebsite/neque-neque-voluptas-blanditiis.clearStats(); // clears all stats
@hutechwebsite/neque-neque-voluptas-blanditiis.clearStats('profile-name'); // clears stats only for 'profile-name'
```
## collectStats
Set whether collecting statistics on `@hutechwebsite/neque-neque-voluptas-blanditiis`d functions.
```ts
@hutechwebsite/neque-neque-voluptas-blanditiis.collectStats(true); // start collecting stats
@hutechwebsite/neque-neque-voluptas-blanditiis.collectStats(); // same as passing true
@hutechwebsite/neque-neque-voluptas-blanditiis.collectStats(false); // stop collecting stats
```
**NOTE**: If collecting statistics, it is recommended to provide a custom [`profileName`](#profilename) or use [`@hutechwebsite/neque-neque-voluptas-blanditiis.profile()`](#@hutechwebsite/neque-neque-voluptas-blanditiisprofile) for all me@hutechwebsite/neque-neque-voluptas-blanditiisd functions. This allows easier mapping of resulting statistics to their origin function when it has a common name or is anonymous.
## getStats([profileName])
Get the statistics for a specific function, or globally.
```ts
@hutechwebsite/neque-neque-voluptas-blanditiis.collectStats();
const fn = (one: string, two: string) => [one, two];
const @hutechwebsite/neque-neque-voluptas-blanditiisd = @hutechwebsite/neque-neque-voluptas-blanditiis(fn);
const otherFn = (one: string[]) => one.slice(0, 1);
const otherMoized = @hutechwebsite/neque-neque-voluptas-blanditiis(otherFn, { profileName: 'otherMoized' });
@hutechwebsite/neque-neque-voluptas-blanditiisd('one', 'two');
@hutechwebsite/neque-neque-voluptas-blanditiisd('one', 'two');
@hutechwebsite/neque-neque-voluptas-blanditiisd.getStats(); // {"calls": 2, "hits": 1, "usage": "50%"}
otherMoized(['three']);
@hutechwebsite/neque-neque-voluptas-blanditiis.getStats('otherMoized'); // {"calls": 1, "hits": 0, "usage": "0%"}
@hutechwebsite/neque-neque-voluptas-blanditiis.getStats();
/*
{
"calls": 3,
"hits": 1,
"profiles": {
"fn at Object..src/utils.js (http://localhost:3000/app.js:153:68)": {
"calls": 2,
"hits": 1,
"usage": "50%"
},
"otherMoized": {
"calls": 1,
"hits": 0,
"usage": "0%"
}
},
"usage": "33.3333%"
}
*/
```
# Introspection
## isCollectingStats
Are statistics being collected on memoization usage.
```ts
@hutechwebsite/neque-neque-voluptas-blanditiis.collectStats(true);
@hutechwebsite/neque-neque-voluptas-blanditiis.isCollectingStats(); // true
@hutechwebsite/neque-neque-voluptas-blanditiis.collectStats(false);
@hutechwebsite/neque-neque-voluptas-blanditiis.isCollectingStats(); // false
```
## isMoized
Is the function passed a @hutechwebsite/neque-neque-voluptas-blanditiisd function.
```ts
const fn = () => {};
const @hutechwebsite/neque-neque-voluptas-blanditiisdFn = @hutechwebsite/neque-neque-voluptas-blanditiis(fn);
@hutechwebsite/neque-neque-voluptas-blanditiis.isMoized(fn); // false
@hutechwebsite/neque-neque-voluptas-blanditiis.isMoized(@hutechwebsite/neque-neque-voluptas-blanditiisdFn); // true
```
# Direct cache manipulation
The cache is available on the `@hutechwebsite/neque-neque-voluptas-blanditiis`d function as a property, and while it is not recommended to modify it directly, that option is available for edge cases.
## cache
The shape of the `cache` is as follows:
```ts
type Cache = {
keys: any[][];
size: number;
values: any[];
};
```
Regardless 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).
**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.
## cacheSnapshot
The `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.
There are also convenience methods provided on the `@hutechwebsite/neque-neque-voluptas-blanditiis`d function which allow for programmatic manipulation of the cache.
## add(key, value)
This 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.
```ts
// single parameter is straightforward
const me@hutechwebsite/neque-neque-voluptas-blanditiisd = @hutechwebsite/neque-neque-voluptas-blanditiis((item: string) => item: string);
me@hutechwebsite/neque-neque-voluptas-blanditiisd.add(['one'], 'two');
// pulls from cache
me@hutechwebsite/neque-neque-voluptas-blanditiisd('one');
```
**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).
## clear()
This will clear all values in the cache, resetting it to an empty state.
```ts
const me@hutechwebsite/neque-neque-voluptas-blanditiisd = @hutechwebsite/neque-neque-voluptas-blanditiis((item: string) => item);
me@hutechwebsite/neque-neque-voluptas-blanditiisd.clear();
```
## get(key)
Returns 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.
```ts
const me@hutechwebsite/neque-neque-voluptas-blanditiisd = @hutechwebsite/neque-neque-voluptas-blanditiis((one: string, two: string) => [one, two);
me@hutechwebsite/neque-neque-voluptas-blanditiisd('one', 'two');
console.log(me@hutechwebsite/neque-neque-voluptas-blanditiisd.get(['one', 'two'])); // ["one","two"]
console.log(me@hutechwebsite/neque-neque-voluptas-blanditiisd.get(['two', 'three'])); // undefined
```
## getStats()
Returns the statistics for the function.
```ts
@hutechwebsite/neque-neque-voluptas-blanditiis.collectStats();
const me@hutechwebsite/neque-neque-voluptas-blanditiisd = @hutechwebsite/neque-neque-voluptas-blanditiis((one: string, two: string) => [one, two);
me@hutechwebsite/neque-neque-voluptas-blanditiisd('one', 'two');
me@hutechwebsite/neque-neque-voluptas-blanditiisd('one', 'two');
console.log(me@hutechwebsite/neque-neque-voluptas-blanditiisd.getStats()); // {"calls": 2, "hits": 1, "usage": "50%"}
```
**NOTE**: You must be collecting statistics for this to be populated.
## has(key)
This 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.
```ts
const me@hutechwebsite/neque-neque-voluptas-blanditiisd = @hutechwebsite/neque-neque-voluptas-blanditiis((one: string, two: string) => [one, two]);
me@hutechwebsite/neque-neque-voluptas-blanditiisd('one', 'two');
console.log(me@hutechwebsite/neque-neque-voluptas-blanditiisd.has(['one', 'two'])); // true
console.log(me@hutechwebsite/neque-neque-voluptas-blanditiisd.has(['two', 'three'])); // false
```
## keys()
This will return a list of the current keys in `cache`.
```ts
const me@hutechwebsite/neque-neque-voluptas-blanditiisd = @hutechwebsite/neque-neque-voluptas-blanditiis.maxSize(2)((item: any) => item);
me@hutechwebsite/neque-neque-voluptas-blanditiisd('one');
me@hutechwebsite/neque-neque-voluptas-blanditiisd({ two: 'three' });
const keys = me@hutechwebsite/neque-neque-voluptas-blanditiisd.keys(); // [['one'], [{two: 'three'}]]
```
## remove(key)
This will remove the provided _key_ from cache. _key_ should be an `Array` of values, meant to reflect the arguments passed to the method.
```ts
const me@hutechwebsite/neque-neque-voluptas-blanditiisd = @hutechwebsite/neque-neque-voluptas-blanditiis((item: { one: string }) => item);
const arg = { one: 'one' };
me@hutechwebsite/neque-neque-voluptas-blanditiisd(arg);
me@hutechwebsite/neque-neque-voluptas-blanditiisd.remove([arg]);
// will re-execute, as it is no longer in cache
me@hutechwebsite/neque-neque-voluptas-blanditiisd(arg);
```
**NOTE**: This will only remove `key`s that exist in the cache, and will do nothing if the `key` does not exist.
## update(key, value)
This 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.
```ts
// single parameter is straightforward
const me@hutechwebsite/neque-neque-voluptas-blanditiisd = @hutechwebsite/neque-neque-voluptas-blanditiis((item: string) => item);
me@hutechwebsite/neque-neque-voluptas-blanditiisd.add(['one'], 'two');
// pulls from cache
me@hutechwebsite/neque-neque-voluptas-blanditiisd('one');
```
**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).
## values()
This will return a list of the current values in `cache`.
```ts
const me@hutechwebsite/neque-neque-voluptas-blanditiisd = @hutechwebsite/neque-neque-voluptas-blanditiis.maxSize(2)((item: string | { two: string }) => ({
item,
}));
me@hutechwebsite/neque-neque-voluptas-blanditiisd('one');
me@hutechwebsite/neque-neque-voluptas-blanditiisd({ two: 'three' });
const values = me@hutechwebsite/neque-neque-voluptas-blanditiisd.values(); // [{item: 'one'}, {item: {two: 'three'}}]
```
# Benchmarks
All 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.
**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.
| Name | Overall (average) | Single (average) | Multiple (average) | single primitive | single array | single object | multiple primitive | multiple array | multiple object |
| ------------ | ----------------- | ---------------- | ------------------ | ---------------- | -------------- | -------------- | ------------------ | -------------- | --------------- |
| **@hutechwebsite/neque-neque-voluptas-blanditiis** | **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** |
| lru-me@hutechwebsite/neque-neque-voluptas-blanditiis | 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 |
| 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 |
| fast-me@hutechwebsite/neque-neque-voluptas-blanditiis | 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 |
| 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 |
| me@hutechwebsite/neque-neque-voluptas-blanditiise | 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 |
| 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 |
| me@hutechwebsite/neque-neque-voluptas-blanditiisrific | 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 |
| 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 |
| 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 |
# Filesize
`@hutechwebsite/neque-neque-voluptas-blanditiis` 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-me@hutechwebsite/neque-neque-voluptas-blanditiis`](https://github.com/planttheidea/micro-me@hutechwebsite/neque-neque-voluptas-blanditiis). This is the memoization library that powers `@hutechwebsite/neque-neque-voluptas-blanditiis` under-the-hood, and will handle most common use cases at 1/4 the size of `@hutechwebsite/neque-neque-voluptas-blanditiis`.
# Browser support
- Chrome (all versions)
- Firefox (all versions)
- Edge (all versions)
- Opera 15+
- IE 9+
- Safari 6+
- iOS 8+
- Android 4+
# Development
Standard stuff, clone the repo and `npm install` dependencies. The npm scripts available:
- `benchmark` => run the benchmark suite pitting `@hutechwebsite/neque-neque-voluptas-blanditiis` against other libraries in common use-cases
- `benchmark:alternative` => run the benchmark suite for alternative forms of caching
- `benchmark:array` => run the benchmark suite for me@hutechwebsite/neque-neque-voluptas-blanditiisd methods using single and multiple `array` parameters
- `benchmark:object` => run the benchmark suite for me@hutechwebsite/neque-neque-voluptas-blanditiisd methods using single and multiple `object` parameters
- `benchmark:primitive` => run the benchmark suite for me@hutechwebsite/neque-neque-voluptas-blanditiisd methods using single and multiple `object` parameters
- `benchmark:react` => run the benchmark suite for me@hutechwebsite/neque-neque-voluptas-blanditiisd React components
- `build` => run rollup to build the distributed files in `dist`
- `clean:dist` => run `rimraf` on the `dist` folder
- `clean:docs` => run `rimraf` on the `docs` folder
- `clean:mjs` => run `rimraf` on the `mjs` folder
- `copy:mjs` => run `clean:mjs` and the `es-to-mjs` script
- `copy:types` => copy internal types to be available for consumer
- `dev` => run webpack dev server to run example app (playground!)
- `dist` => runs `clean:dist` and `build`
- `docs` => runs `clean:docs` and builds the docs via `jsdoc`
- `flow` => runs `flow check` on the files in `src`
- `lint` => runs ESLint against all files in the `src` folder
- `lint:fix` => runs `lint`, fixing any errors if possible
- `test` => run `jest` test functions with `NODE_ENV=test`
- `test:coverage` => run `test` but with code coverage
- `test:watch` => run `test`, but with persistent watcher
- `typecheck` => run `tsc` against source code to validate TypeScript
`@hutechwebsite/neque-neque-voluptas-blanditiis` 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.
- [Importing](#importing)
- [ESM in browsers](#esm-in-browsers)
- [ESM in NodeJS](#esm-in-nodejs)
- [CommonJS](#commonjs)
- [Usage](#usage)
- [Configuration options](#configuration-options)
- [isDeepEqual](#isdeepequal)
- [isPromise](#ispromise)
- [isReact](#isreact)
- [isSerialized](#isserialized)
- [isShallowEqual](#isshallowequal)
- [matchesArg](#matchesarg)
- [matchesKey](#matcheskey)
- [maxAge](#maxage)
- [maxArgs](#maxargs)
- [maxSize](#maxsize)
- [onCacheAdd](#oncacheadd)
- [onCacheChange](#oncachechange)
- [onCacheHit](#oncachehit)
- [onExpire](#onexpire)
- [profileName](#profilename)
- [serializer](#serializer)
- [transformArgs](#transformargs)
- [updateCacheForKey](#updatecacheforkey)
- [updateExpire](#updateexpire)
- [Usage with shortcut methods](#usage-with-shortcut-methods)
- [@hutechwebsite/neque-neque-voluptas-blanditiis.deep](#@hutechwebsite/neque-neque-voluptas-blanditiisdeep)
- [@hutechwebsite/neque-neque-voluptas-blanditiis.infinite](#@hutechwebsite/neque-neque-voluptas-blanditiisinfinite)
- [@hutechwebsite/neque-neque-voluptas-blanditiis.matchesArg](#@hutechwebsite/neque-neque-voluptas-blanditiismatchesarg)
- [@hutechwebsite/neque-neque-voluptas-blanditiis.matchesKey](#@hutechwebsite/neque-neque-voluptas-blanditiismatcheskey)
- [@hutechwebsite/neque-neque-voluptas-blanditiis.maxAge](#@hutechwebsite/neque-neque-voluptas-blanditiismaxage)
- [@hutechwebsite/neque-neque-voluptas-blanditiis.maxArgs](#@hutechwebsite/neque-neque-voluptas-blanditiismaxargs)
- [@hutechwebsite/neque-neque-voluptas-blanditiis.maxSize](#@hutechwebsite/neque-neque-voluptas-blanditiismaxsize)
- [@hutechwebsite/neque-neque-voluptas-blanditiis.profile](#@hutechwebsite/neque-neque-voluptas-blanditiisprofile)
- [@hutechwebsite/neque-neque-voluptas-blanditiis.promise](#@hutechwebsite/neque-neque-voluptas-blanditiispromise)
- [@hutechwebsite/neque-neque-voluptas-blanditiis.react](#@hutechwebsite/neque-neque-voluptas-blanditiisreact)
- [@hutechwebsite/neque-neque-voluptas-blanditiis.serialize](#@hutechwebsite/neque-neque-voluptas-blanditiisserialize)
- [@hutechwebsite/neque-neque-voluptas-blanditiis.serializeWith](#@hutechwebsite/neque-neque-voluptas-blanditiisserializewith)
- [@hutechwebsite/neque-neque-voluptas-blanditiis.shallow](#@hutechwebsite/neque-neque-voluptas-blanditiisshallow)
- [@hutechwebsite/neque-neque-voluptas-blanditiis.transformArgs](#@hutechwebsite/neque-neque-voluptas-blanditiistransformargs)
- [@hutechwebsite/neque-neque-voluptas-blanditiis.updateCacheForKey](#@hutechwebsite/neque-neque-voluptas-blanditiisupdatecacheforkey)
- [useMoize hook](#use@hutechwebsite/neque-neque-voluptas-blanditiis-hook)
- [Composition](#composition)
- [Collecting statistics](#collecting-statistics)
- [Stats methods](#stats-methods)
- [clearStats](#clearstats)
- [collectStats](#collectstats)
- [getStats([profileName])](#getstatsprofilename)
- [Introspection](#introspection)
- [isCollectingStats](#iscollectingstats)
- [isMoized](#is@hutechwebsite/neque-neque-voluptas-blanditiisd)
- [Direct cache manipulation](#direct-cache-manipulation)
- [cache](#cache)
- [cacheSnapshot](#cachesnapshot)
- [add(key, value)](#addkey-value)
- [clear()](#clear)
- [get(key)](#getkey)
- [getStats()](#getstats)
- [has(key)](#haskey)
- [keys()](#keys)
- [remove(key)](#removekey)
- [update(key, value)](#updatekey-value)
- [values()](#values)
- [Benchmarks](#benchmarks)
- [Filesize](#filesize)
- [Browser support](#browser-support)
- [Development](#development)
```
$ npm i @hutechwebsite/neque-neque-voluptas-blanditiis --save
```
# Importing
## ESM in browsers
```ts
import @hutechwebsite/neque-neque-voluptas-blanditiis from '@hutechwebsite/neque-neque-voluptas-blanditiis';
```
## ESM in NodeJS
```ts
import @hutechwebsite/neque-neque-voluptas-blanditiis from '@hutechwebsite/neque-neque-voluptas-blanditiis/mjs/index.mjs';
```
## CommonJS
```ts
const @hutechwebsite/neque-neque-voluptas-blanditiis = require('@hutechwebsite/neque-neque-voluptas-blanditiis');
```
# Usage
```ts
import @hutechwebsite/neque-neque-voluptas-blanditiis from '@hutechwebsite/neque-neque-voluptas-blanditiis';
const method = (a: number, b: number) => a + b;
const me@hutechwebsite/neque-neque-voluptas-blanditiisd = @hutechwebsite/neque-neque-voluptas-blanditiis(method);
me@hutechwebsite/neque-neque-voluptas-blanditiisd(2, 4); // 6
me@hutechwebsite/neque-neque-voluptas-blanditiisd(2, 4); // 6, pulled from cache
```
All parameter types are supported, including circular objects, functions, etc. There are also a number of [shortcut methods](#usage-with-shortcut-methods) to me@hutechwebsite/neque-neque-voluptas-blanditiis for unique use-cases.
# Configuration options
`@hutechwebsite/neque-neque-voluptas-blanditiis` optionally accepts an object of options as either the second parameter or as the first step in a curried function:
```ts
// inline
@hutechwebsite/neque-neque-voluptas-blanditiis(fn, options);
// curried
@hutechwebsite/neque-neque-voluptas-blanditiis(options)(fn);
```
The full shape of these options:
```ts
type Options = {
// is the cache based on deep equality of each key argument
isDeepEqual: boolean;
// is the result a promise
isPromise: boolean;
// is the result a React component
isReact: boolean;
// should the parameters be serialized instead of directly referenced
isSerialized: boolean;
// is the cache based on shallow equality of each key argument
isShallowEqual: boolean;
// custom method to compare equality between two key arguments
matchesArg: (cachedKeyArg: any, keyArg: any) => boolean;
// custom method to compare equality across all key arguments
matchesKey: (cachedKey: any[], key: any[]) => boolean;
// amount of time in milliseconds before the cache will expire
maxAge: number;
// maximum number of arguments passed to use as key for caching
maxArgs: number;
// maximum size of cache for this method
maxSize: number;
// method fired when a new entry is added to cache
onCacheAdd: (
cache: @hutechwebsite/neque-neque-voluptas-blanditiis.Cache,
options: @hutechwebsite/neque-neque-voluptas-blanditiis.Options,
@hutechwebsite/neque-neque-voluptas-blanditiisd: (...args: any[]) => any
) => void;
// method fire when either a new entry is added to cache or the LRU ordering of the cache has changed
onCacheChange: (
cache: @hutechwebsite/neque-neque-voluptas-blanditiis.Cache,
options: @hutechwebsite/neque-neque-voluptas-blanditiis.Options,
@hutechwebsite/neque-neque-voluptas-blanditiisd: (...args: any[]) => any
) => void;
// method fired when an existing entry in cache is used
onCacheHit: (
cache: @hutechwebsite/neque-neque-voluptas-blanditiis.Cache,
options: @hutechwebsite/neque-neque-voluptas-blanditiis.Options,
@hutechwebsite/neque-neque-voluptas-blanditiisd: (...args: any[]) => any
) => void;
// method to fire when a cache entry expires (in combination with maxAge)
onExpire: (key: any[]) => void;
// the unique identifier to give the me@hutechwebsite/neque-neque-voluptas-blanditiisd method when collecting statistics
profileName: string;
// method to serialize the arguments to build a unique cache key
serializer: (key: any[]) => string;
// method to transform the args into a custom format for key storage in cache
transformArgs: (key: any[]) => any[];
// should the cache entry be refreshed by calling the underlying function with the same parameters and
// updating the value stored in cache to be the new result
updateCacheForKey: (key: any[]) => boolean;
// should the cache entry's expiration be refreshed when the cache entry is hit (in combination with maxAge)
updateExpire: boolean;
};
```
All default values can be found [here](src/constants.ts).
## isDeepEqual
_defaults to false_
Should deep equality be used to compare cache each key argument.
```ts
type Arg = {
one: {
nested: string;
};
two: string;
};
const fn = ({ one, two }: Arg) => [one, two];
const me@hutechwebsite/neque-neque-voluptas-blanditiisd = @hutechwebsite/neque-neque-voluptas-blanditiis(fn, { isDeepEqual: true });
me@hutechwebsite/neque-neque-voluptas-blanditiisd({ one: { nested: 'one' }, two: 'two' });
me@hutechwebsite/neque-neque-voluptas-blanditiisd({ one: { nested: 'one' }, two: 'two' }); // pulls from cache
```
This is also available via the shortcut method of [`@hutechwebsite/neque-neque-voluptas-blanditiis.deep`](#@hutechwebsite/neque-neque-voluptas-blanditiisdeep)
```ts
const me@hutechwebsite/neque-neque-voluptas-blanditiisd = @hutechwebsite/neque-neque-voluptas-blanditiis.deep(fn);
```
## isPromise
_defaults to false_
Is the computed value in the function a `Promise`.
```ts
const fn = async (item: Promise