replace jest with ava
This commit is contained in:
Robert Brignull
parent
27cc8b23fe
commit
0347b72305
11775 changed files with 84546 additions and 1440575 deletions
108
node_modules/mem/index.d.ts
generated
vendored
Normal file
108
node_modules/mem/index.d.ts
generated
vendored
Normal file
|
|
@ -0,0 +1,108 @@
|
|||
declare namespace mem {
|
||||
interface CacheStorage<KeyType, ValueType> {
|
||||
has(key: KeyType): boolean;
|
||||
get(key: KeyType): ValueType | undefined;
|
||||
set(key: KeyType, value: ValueType): void;
|
||||
delete(key: KeyType): void;
|
||||
clear?: () => void;
|
||||
}
|
||||
|
||||
interface Options<
|
||||
ArgumentsType extends unknown[],
|
||||
CacheKeyType,
|
||||
ReturnType
|
||||
> {
|
||||
/**
|
||||
Milliseconds until the cache expires.
|
||||
|
||||
@default Infinity
|
||||
*/
|
||||
readonly maxAge?: number;
|
||||
|
||||
/**
|
||||
Determines the cache key for storing the result based on the function arguments. By default, __only the first argument is considered__ and it only works with [primitives](https://developer.mozilla.org/en-US/docs/Glossary/Primitive).
|
||||
|
||||
A `cacheKey` function can return any type supported by `Map` (or whatever structure you use in the `cache` option).
|
||||
|
||||
You can have it cache **all** the arguments by value with `JSON.stringify`, if they are compatible:
|
||||
|
||||
```
|
||||
import mem = require('mem');
|
||||
|
||||
mem(function_, {cacheKey: JSON.stringify});
|
||||
```
|
||||
|
||||
Or you can use a more full-featured serializer like [serialize-javascript](https://github.com/yahoo/serialize-javascript) to add support for `RegExp`, `Date` and so on.
|
||||
|
||||
```
|
||||
import mem = require('mem');
|
||||
import serializeJavascript = require('serialize-javascript');
|
||||
|
||||
mem(function_, {cacheKey: serializeJavascript});
|
||||
```
|
||||
|
||||
@default arguments_ => arguments_[0]
|
||||
@example arguments_ => JSON.stringify(arguments_)
|
||||
*/
|
||||
readonly cacheKey?: (arguments: ArgumentsType) => CacheKeyType;
|
||||
|
||||
/**
|
||||
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`](https://github.com/sindresorhus/quick-lru) for a LRU cache.
|
||||
|
||||
@default new Map()
|
||||
@example new WeakMap()
|
||||
*/
|
||||
readonly cache?: CacheStorage<CacheKeyType, {data: ReturnType; maxAge: number}>;
|
||||
}
|
||||
}
|
||||
|
||||
declare const mem: {
|
||||
/**
|
||||
[Memoize](https://en.wikipedia.org/wiki/Memoization) functions - An optimization used to speed up consecutive function calls by caching the result of calls with identical input.
|
||||
|
||||
@param fn - Function to be memoized.
|
||||
|
||||
@example
|
||||
```
|
||||
import 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
|
||||
```
|
||||
*/
|
||||
<
|
||||
ArgumentsType extends unknown[],
|
||||
ReturnType,
|
||||
CacheKeyType,
|
||||
FunctionToMemoize = (...arguments: ArgumentsType) => ReturnType
|
||||
>(
|
||||
fn: FunctionToMemoize,
|
||||
options?: mem.Options<ArgumentsType, CacheKeyType, ReturnType>
|
||||
): FunctionToMemoize;
|
||||
|
||||
/**
|
||||
Clear all cached data of a memoized function.
|
||||
|
||||
@param fn - Memoized function.
|
||||
*/
|
||||
clear<ArgumentsType extends unknown[], ReturnType>(
|
||||
fn: (...arguments: ArgumentsType) => ReturnType
|
||||
): void;
|
||||
};
|
||||
|
||||
export = mem;
|
||||
64
node_modules/mem/index.js
generated
vendored
Normal file
64
node_modules/mem/index.js
generated
vendored
Normal file
|
|
@ -0,0 +1,64 @@
|
|||
'use strict';
|
||||
const mimicFn = require('mimic-fn');
|
||||
const mapAgeCleaner = require('map-age-cleaner');
|
||||
|
||||
const cacheStore = new WeakMap();
|
||||
|
||||
const mem = (fn, options = {}) => {
|
||||
// Automatically use WeakMap unless the user provided their own cache
|
||||
const weakCache = options.cache || new WeakMap();
|
||||
const {
|
||||
cacheKey = ([firstArgument]) => firstArgument,
|
||||
cache = new Map(),
|
||||
maxAge
|
||||
} = options;
|
||||
|
||||
if (typeof maxAge === 'number') {
|
||||
mapAgeCleaner(cache);
|
||||
}
|
||||
|
||||
const memoized = function (...arguments_) {
|
||||
const key = cacheKey(arguments_);
|
||||
|
||||
// Prefer WeakMap if the key allows it
|
||||
const bestCache = key && (typeof key === 'object' || typeof key === 'function') ?
|
||||
weakCache :
|
||||
cache;
|
||||
|
||||
if (bestCache.has(key)) {
|
||||
return bestCache.get(key).data;
|
||||
}
|
||||
|
||||
const cacheItem = fn.apply(this, arguments_);
|
||||
|
||||
bestCache.set(key, {
|
||||
data: cacheItem,
|
||||
maxAge: maxAge ? Date.now() + maxAge : Infinity
|
||||
});
|
||||
|
||||
return cacheItem;
|
||||
};
|
||||
|
||||
try {
|
||||
// The below call will throw in some host environments
|
||||
// See https://github.com/sindresorhus/mimic-fn/issues/10
|
||||
mimicFn(memoized, fn);
|
||||
} catch (_) {}
|
||||
|
||||
cacheStore.set(memoized, cache);
|
||||
|
||||
return memoized;
|
||||
};
|
||||
|
||||
module.exports = mem;
|
||||
|
||||
module.exports.clear = fn => {
|
||||
if (!cacheStore.has(fn)) {
|
||||
throw new Error('Can\'t clear a function that was not memoized!');
|
||||
}
|
||||
|
||||
const cache = cacheStore.get(fn);
|
||||
if (typeof cache.clear === 'function') {
|
||||
cache.clear();
|
||||
}
|
||||
};
|
||||
9
node_modules/mem/license
generated
vendored
Normal file
9
node_modules/mem/license
generated
vendored
Normal file
|
|
@ -0,0 +1,9 @@
|
|||
MIT License
|
||||
|
||||
Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (sindresorhus.com)
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
56
node_modules/mem/node_modules/mimic-fn/index.d.ts
generated
vendored
Normal file
56
node_modules/mem/node_modules/mimic-fn/index.d.ts
generated
vendored
Normal file
|
|
@ -0,0 +1,56 @@
|
|||
declare namespace mimicFn {
|
||||
interface Options {
|
||||
/**
|
||||
Skip modifying [non-configurable properties](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/getOwnPropertyDescriptor#Description) instead of throwing an error.
|
||||
|
||||
@default false
|
||||
*/
|
||||
readonly ignoreNonConfigurable?: boolean;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
Modifies the `to` function to mimic the `from` function. Returns the `to` function.
|
||||
|
||||
`name`, `displayName`, and any other properties of `from` are copied. The `length` property is not copied. Prototype, class, and inherited properties are copied.
|
||||
|
||||
`to.toString()` will return the same as `from.toString()` but prepended with a `Wrapped with to()` comment.
|
||||
|
||||
@param to - Mimicking function.
|
||||
@param from - Function to mimic.
|
||||
@returns The modified `to` function.
|
||||
|
||||
@example
|
||||
```
|
||||
import mimicFn = require('mimic-fn');
|
||||
|
||||
function foo() {}
|
||||
foo.unicorn = '🦄';
|
||||
|
||||
function wrapper() {
|
||||
return foo();
|
||||
}
|
||||
|
||||
console.log(wrapper.name);
|
||||
//=> 'wrapper'
|
||||
|
||||
mimicFn(wrapper, foo);
|
||||
|
||||
console.log(wrapper.name);
|
||||
//=> 'foo'
|
||||
|
||||
console.log(wrapper.unicorn);
|
||||
//=> '🦄'
|
||||
```
|
||||
*/
|
||||
declare function mimicFn<
|
||||
ArgumentsType extends unknown[],
|
||||
ReturnType,
|
||||
FunctionType extends (...arguments: ArgumentsType) => ReturnType
|
||||
>(
|
||||
to: (...arguments: ArgumentsType) => ReturnType,
|
||||
from: FunctionType,
|
||||
options?: mimicFn.Options,
|
||||
): FunctionType;
|
||||
|
||||
export = mimicFn;
|
||||
70
node_modules/mem/node_modules/mimic-fn/index.js
generated
vendored
Normal file
70
node_modules/mem/node_modules/mimic-fn/index.js
generated
vendored
Normal file
|
|
@ -0,0 +1,70 @@
|
|||
'use strict';
|
||||
|
||||
const copyProperty = (to, from, property, ignoreNonConfigurable) => {
|
||||
// `Function#length` should reflect the parameters of `to` not `from` since we keep its body.
|
||||
// `Function#prototype` is non-writable and non-configurable so can never be modified.
|
||||
if (property === 'length' || property === 'prototype') {
|
||||
return;
|
||||
}
|
||||
|
||||
const toDescriptor = Object.getOwnPropertyDescriptor(to, property);
|
||||
const fromDescriptor = Object.getOwnPropertyDescriptor(from, property);
|
||||
|
||||
if (!canCopyProperty(toDescriptor, fromDescriptor) && ignoreNonConfigurable) {
|
||||
return;
|
||||
}
|
||||
|
||||
Object.defineProperty(to, property, fromDescriptor);
|
||||
};
|
||||
|
||||
// `Object.defineProperty()` throws if the property exists, is not configurable and either:
|
||||
// - one its descriptors is changed
|
||||
// - it is non-writable and its value is changed
|
||||
const canCopyProperty = function (toDescriptor, fromDescriptor) {
|
||||
return toDescriptor === undefined || toDescriptor.configurable || (
|
||||
toDescriptor.writable === fromDescriptor.writable &&
|
||||
toDescriptor.enumerable === fromDescriptor.enumerable &&
|
||||
toDescriptor.configurable === fromDescriptor.configurable &&
|
||||
(toDescriptor.writable || toDescriptor.value === fromDescriptor.value)
|
||||
);
|
||||
};
|
||||
|
||||
const changePrototype = (to, from) => {
|
||||
const fromPrototype = Object.getPrototypeOf(from);
|
||||
if (fromPrototype === Object.getPrototypeOf(to)) {
|
||||
return;
|
||||
}
|
||||
|
||||
Object.setPrototypeOf(to, fromPrototype);
|
||||
};
|
||||
|
||||
const wrappedToString = (withName, fromBody) => `/* Wrapped ${withName}*/\n${fromBody}`;
|
||||
|
||||
const toStringDescriptor = Object.getOwnPropertyDescriptor(Function.prototype, 'toString');
|
||||
const toStringName = Object.getOwnPropertyDescriptor(Function.prototype.toString, 'name');
|
||||
|
||||
// We call `from.toString()` early (not lazily) to ensure `from` can be garbage collected.
|
||||
// We use `bind()` instead of a closure for the same reason.
|
||||
// Calling `from.toString()` early also allows caching it in case `to.toString()` is called several times.
|
||||
const changeToString = (to, from, name) => {
|
||||
const withName = name === '' ? '' : `with ${name.trim()}() `;
|
||||
const newToString = wrappedToString.bind(null, withName, from.toString());
|
||||
// Ensure `to.toString.toString` is non-enumerable and has the same `same`
|
||||
Object.defineProperty(newToString, 'name', toStringName);
|
||||
Object.defineProperty(to, 'toString', {...toStringDescriptor, value: newToString});
|
||||
};
|
||||
|
||||
const mimicFn = (to, from, {ignoreNonConfigurable = false} = {}) => {
|
||||
const {name} = to;
|
||||
|
||||
for (const property of Reflect.ownKeys(from)) {
|
||||
copyProperty(to, from, property, ignoreNonConfigurable);
|
||||
}
|
||||
|
||||
changePrototype(to, from);
|
||||
changeToString(to, from, name);
|
||||
|
||||
return to;
|
||||
};
|
||||
|
||||
module.exports = mimicFn;
|
||||
9
node_modules/mem/node_modules/mimic-fn/license
generated
vendored
Normal file
9
node_modules/mem/node_modules/mimic-fn/license
generated
vendored
Normal file
|
|
@ -0,0 +1,9 @@
|
|||
MIT License
|
||||
|
||||
Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (sindresorhus.com)
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
42
node_modules/mem/node_modules/mimic-fn/package.json
generated
vendored
Normal file
42
node_modules/mem/node_modules/mimic-fn/package.json
generated
vendored
Normal file
|
|
@ -0,0 +1,42 @@
|
|||
{
|
||||
"name": "mimic-fn",
|
||||
"version": "3.0.0",
|
||||
"description": "Make a function mimic another one",
|
||||
"license": "MIT",
|
||||
"repository": "sindresorhus/mimic-fn",
|
||||
"author": {
|
||||
"name": "Sindre Sorhus",
|
||||
"email": "sindresorhus@gmail.com",
|
||||
"url": "sindresorhus.com"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">=8"
|
||||
},
|
||||
"scripts": {
|
||||
"test": "xo && ava && tsd"
|
||||
},
|
||||
"files": [
|
||||
"index.js",
|
||||
"index.d.ts"
|
||||
],
|
||||
"keywords": [
|
||||
"function",
|
||||
"mimic",
|
||||
"imitate",
|
||||
"rename",
|
||||
"copy",
|
||||
"inherit",
|
||||
"properties",
|
||||
"name",
|
||||
"func",
|
||||
"fn",
|
||||
"set",
|
||||
"infer",
|
||||
"change"
|
||||
],
|
||||
"devDependencies": {
|
||||
"ava": "^2.1.0",
|
||||
"tsd": "^0.7.1",
|
||||
"xo": "^0.24.0"
|
||||
}
|
||||
}
|
||||
95
node_modules/mem/node_modules/mimic-fn/readme.md
generated
vendored
Normal file
95
node_modules/mem/node_modules/mimic-fn/readme.md
generated
vendored
Normal file
|
|
@ -0,0 +1,95 @@
|
|||
<img src="media/logo.svg" alt="mimic-fn" width="400">
|
||||
<br>
|
||||
|
||||
[](https://travis-ci.org/sindresorhus/mimic-fn)
|
||||
|
||||
> Make a function mimic another one
|
||||
|
||||
Useful when you wrap a function in another function and like to preserve the original name and other properties.
|
||||
|
||||
|
||||
## Install
|
||||
|
||||
```
|
||||
$ npm install mimic-fn
|
||||
```
|
||||
|
||||
|
||||
## Usage
|
||||
|
||||
```js
|
||||
const mimicFn = require('mimic-fn');
|
||||
|
||||
function foo() {}
|
||||
foo.unicorn = '🦄';
|
||||
|
||||
function wrapper() {
|
||||
return foo();
|
||||
}
|
||||
|
||||
console.log(wrapper.name);
|
||||
//=> 'wrapper'
|
||||
|
||||
mimicFn(wrapper, foo);
|
||||
|
||||
console.log(wrapper.name);
|
||||
//=> 'foo'
|
||||
|
||||
console.log(wrapper.unicorn);
|
||||
//=> '🦄'
|
||||
|
||||
console.log(String(wrapper));
|
||||
//=> '/* Wrapped with wrapper() */\nfunction foo() {}'
|
||||
```
|
||||
|
||||
|
||||
## API
|
||||
|
||||
### mimicFn(to, from, options?)
|
||||
|
||||
Modifies the `to` function to mimic the `from` function. Returns the `to` function.
|
||||
|
||||
`name`, `displayName`, and any other properties of `from` are copied. The `length` property is not copied. Prototype, class, and inherited properties are copied.
|
||||
|
||||
`to.toString()` will return the same as `from.toString()` but prepended with a `Wrapped with to()` comment.
|
||||
|
||||
#### to
|
||||
|
||||
Type: `Function`
|
||||
|
||||
Mimicking function.
|
||||
|
||||
#### from
|
||||
|
||||
Type: `Function`
|
||||
|
||||
Function to mimic.
|
||||
|
||||
#### options
|
||||
|
||||
Type: `object`
|
||||
|
||||
##### ignoreNonConfigurable
|
||||
|
||||
Type: `boolean`<br>
|
||||
Default: `false`
|
||||
|
||||
Skip modifying [non-configurable properties](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/getOwnPropertyDescriptor#Description) instead of throwing an error.
|
||||
|
||||
## Related
|
||||
|
||||
- [rename-fn](https://github.com/sindresorhus/rename-fn) - Rename a function
|
||||
- [keep-func-props](https://github.com/ehmicky/keep-func-props) - Wrap a function without changing its name and other properties
|
||||
|
||||
|
||||
---
|
||||
|
||||
<div align="center">
|
||||
<b>
|
||||
<a href="https://tidelift.com/subscription/pkg/npm-mimic-fn?utm_source=npm-mimic-fn&utm_medium=referral&utm_campaign=readme">Get professional support for this package with a Tidelift subscription</a>
|
||||
</b>
|
||||
<br>
|
||||
<sub>
|
||||
Tidelift helps make open source sustainable for maintainers while giving companies<br>assurances about security, maintenance, and licensing for their dependencies.
|
||||
</sub>
|
||||
</div>
|
||||
46
node_modules/mem/package.json
generated
vendored
Normal file
46
node_modules/mem/package.json
generated
vendored
Normal file
|
|
@ -0,0 +1,46 @@
|
|||
{
|
||||
"name": "mem",
|
||||
"version": "6.1.0",
|
||||
"description": "Memoize functions - An optimization used to speed up consecutive function calls by caching the result of calls with identical input",
|
||||
"license": "MIT",
|
||||
"repository": "sindresorhus/mem",
|
||||
"author": {
|
||||
"name": "Sindre Sorhus",
|
||||
"email": "sindresorhus@gmail.com",
|
||||
"url": "sindresorhus.com"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">=8"
|
||||
},
|
||||
"scripts": {
|
||||
"test": "xo && ava && tsd"
|
||||
},
|
||||
"files": [
|
||||
"index.js",
|
||||
"index.d.ts"
|
||||
],
|
||||
"keywords": [
|
||||
"memoize",
|
||||
"function",
|
||||
"mem",
|
||||
"memoization",
|
||||
"cache",
|
||||
"caching",
|
||||
"optimize",
|
||||
"performance",
|
||||
"ttl",
|
||||
"expire",
|
||||
"promise"
|
||||
],
|
||||
"dependencies": {
|
||||
"map-age-cleaner": "^0.1.3",
|
||||
"mimic-fn": "^3.0.0"
|
||||
},
|
||||
"devDependencies": {
|
||||
"ava": "^2.4.0",
|
||||
"delay": "^4.1.0",
|
||||
"serialize-javascript": "^2.1.0",
|
||||
"tsd": "^0.11.0",
|
||||
"xo": "^0.25.3"
|
||||
}
|
||||
}
|
||||
255
node_modules/mem/readme.md
generated
vendored
Normal file
255
node_modules/mem/readme.md
generated
vendored
Normal file
|
|
@ -0,0 +1,255 @@
|
|||
# mem [](https://travis-ci.org/sindresorhus/mem)
|
||||
|
||||
> [Memoize](https://en.wikipedia.org/wiki/Memoization) functions - An optimization used to speed up consecutive function calls by caching the result of calls with identical input
|
||||
|
||||
Memory is automatically released when an item expires or the cache is cleared.
|
||||
|
||||
By default, **only the first argument is considered** and it only works with [primitives](https://developer.mozilla.org/en-US/docs/Glossary/Primitive). If you need to cache multiple arguments or cache `object`s *by value*, have a look at alternative [caching strategies](#caching-strategy) below.
|
||||
|
||||
|
||||
## Install
|
||||
|
||||
```
|
||||
$ npm install mem
|
||||
```
|
||||
|
||||
|
||||
## Usage
|
||||
|
||||
```js
|
||||
const mem = require('mem');
|
||||
|
||||
let i = 0;
|
||||
const counter = () => ++i;
|
||||
const memoized = mem(counter);
|
||||
|
||||
memoized('foo');
|
||||
//=> 1
|
||||
|
||||
// Cached as it's the same argument
|
||||
memoized('foo');
|
||||
//=> 1
|
||||
|
||||
// Not cached anymore as the argument changed
|
||||
memoized('bar');
|
||||
//=> 2
|
||||
|
||||
memoized('bar');
|
||||
//=> 2
|
||||
|
||||
// Only the first argument is considered by default
|
||||
memoized('bar', 'foo');
|
||||
//=> 2
|
||||
```
|
||||
|
||||
##### Works fine with promise returning functions
|
||||
|
||||
```js
|
||||
const mem = require('mem');
|
||||
|
||||
let i = 0;
|
||||
const counter = async () => ++i;
|
||||
const memoized = mem(counter);
|
||||
|
||||
(async () => {
|
||||
console.log(await memoized());
|
||||
//=> 1
|
||||
|
||||
// The return value didn't increase as it's cached
|
||||
console.log(await memoized());
|
||||
//=> 1
|
||||
})();
|
||||
```
|
||||
|
||||
```js
|
||||
const mem = require('mem');
|
||||
const got = require('got');
|
||||
const delay = require('delay');
|
||||
|
||||
const memGot = mem(got, {maxAge: 1000});
|
||||
|
||||
(async () => {
|
||||
await memGot('sindresorhus.com');
|
||||
|
||||
// This call is cached
|
||||
await memGot('sindresorhus.com');
|
||||
|
||||
await delay(2000);
|
||||
|
||||
// This call is not cached as the cache has expired
|
||||
await memGot('sindresorhus.com');
|
||||
})();
|
||||
```
|
||||
|
||||
### Caching strategy
|
||||
|
||||
By default, only the first argument is compared via exact equality (`===`) to determine whether a call is identical.
|
||||
|
||||
```js
|
||||
const power = mem((a, b) => Math.power(a, b));
|
||||
|
||||
power(2, 2); // => 4, stored in cache with the key 2 (number)
|
||||
power(2, 3); // => 4, retrieved from cache at key 2 (number), it's wrong
|
||||
```
|
||||
|
||||
You will have to use the `cache` and `cacheKey` options appropriate to your function. In this specific case, the following could work:
|
||||
|
||||
```js
|
||||
const power = mem((a, b) => Math.power(a, b), {
|
||||
cacheKey: arguments_ => arguments_.join(',')
|
||||
});
|
||||
|
||||
power(2, 2); // => 4, stored in cache with the key '2,2' (both arguments as one string)
|
||||
power(2, 3); // => 8, stored in cache with the key '2,3'
|
||||
```
|
||||
|
||||
More advanced examples follow.
|
||||
|
||||
#### Example: Options-like argument
|
||||
|
||||
If your function accepts an object, it won't be memoized out of the box:
|
||||
|
||||
```js
|
||||
const heavyMemoizedOperation = mem(heavyOperation);
|
||||
|
||||
heavyMemoizedOperation({full: true}); // Stored in cache with the object as key
|
||||
heavyMemoizedOperation({full: true}); // Stored in cache with the object as key, again
|
||||
// The objects look the same but for JS they're two different objects
|
||||
```
|
||||
|
||||
You might want to serialize or hash them, for example using `JSON.stringify` or something like [serialize-javascript](https://github.com/yahoo/serialize-javascript), which can also serialize `RegExp`, `Date` and so on.
|
||||
|
||||
```js
|
||||
const heavyMemoizedOperation = mem(heavyOperation, {cacheKey: JSON.stringify});
|
||||
|
||||
heavyMemoizedOperation({full: true}); // Stored in cache with the key '[{"full":true}]' (string)
|
||||
heavyMemoizedOperation({full: true}); // Retrieved from cache
|
||||
```
|
||||
|
||||
The same solution also works if it accepts multiple serializable objects:
|
||||
|
||||
```js
|
||||
const heavyMemoizedOperation = mem(heavyOperation, {cacheKey: JSON.stringify});
|
||||
|
||||
heavyMemoizedOperation('hello', {full: true}); // Stored in cache with the key '["hello",{"full":true}]' (string)
|
||||
heavyMemoizedOperation('hello', {full: true}); // Retrieved from cache
|
||||
```
|
||||
|
||||
#### Example: Multiple non-serializable arguments
|
||||
|
||||
If your function accepts multiple arguments that aren't supported by `JSON.stringify` (e.g. DOM elements and functions), you can instead extend the initial exact equality (`===`) to work on multiple arguments using [`many-keys-map`](https://github.com/fregante/many-keys-map):
|
||||
|
||||
```js
|
||||
const ManyKeysMap = require('many-keys-map');
|
||||
|
||||
const addListener = (emitter, eventName, listener) => emitter.on(eventName, listener);
|
||||
|
||||
const addOneListener = mem(addListener, {
|
||||
cacheKey: arguments_ => arguments_, // Use *all* the arguments as key
|
||||
cache: new ManyKeysMap() // Correctly handles all the arguments for exact equality
|
||||
});
|
||||
|
||||
addOneListener(header, 'click', console.log); // `addListener` is run, and it's cached with the `arguments` array as key
|
||||
addOneListener(header, 'click', console.log); // `addListener` is not run again
|
||||
addOneListener(mainContent, 'load', console.log); // `addListener` is run, and it's cached with the `arguments` array as key
|
||||
```
|
||||
|
||||
Better yet, if your function’s arguments are compatible with `WeakMap`, you should use [`deep-weak-map`](https://github.com/futpib/deep-weak-map) instead of `many-keys-map`. This will help avoid memory leaks.
|
||||
|
||||
|
||||
## API
|
||||
|
||||
### mem(fn, options?)
|
||||
|
||||
#### fn
|
||||
|
||||
Type: `Function`
|
||||
|
||||
Function to be memoized.
|
||||
|
||||
#### options
|
||||
|
||||
Type: `object`
|
||||
|
||||
##### maxAge
|
||||
|
||||
Type: `number`\
|
||||
Default: `Infinity`
|
||||
|
||||
Milliseconds until the cache expires.
|
||||
|
||||
##### cacheKey
|
||||
|
||||
Type: `Function`\
|
||||
Default: `arguments_ => arguments_[0]`\
|
||||
Example: `arguments_ => JSON.stringify(arguments_)`
|
||||
|
||||
Determines the cache key for storing the result based on the function arguments. By default, **only the first argument is considered**.
|
||||
|
||||
A `cacheKey` function can return any type supported by `Map` (or whatever structure you use in the `cache` option).
|
||||
|
||||
Refer to the [caching strategies](#caching-strategy) section for more information.
|
||||
|
||||
##### cache
|
||||
|
||||
Type: `object`\
|
||||
Default: `new Map()`, but it also intelligently uses `new WeakMap()` whenevever possible
|
||||
|
||||
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 [`quick-lru`](https://github.com/sindresorhus/quick-lru) for a LRU cache.
|
||||
|
||||
Refer to the [caching strategies](#caching-strategy) section for more information.
|
||||
|
||||
### 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](https://github.com/SamVerschueren/stats-map) as a replacement for the default cache.
|
||||
|
||||
#### Example
|
||||
|
||||
```js
|
||||
const mem = require('mem');
|
||||
const StatsMap = require('stats-map');
|
||||
const got = require('got');
|
||||
|
||||
const cache = new StatsMap();
|
||||
const memGot = mem(got, {cache});
|
||||
|
||||
(async () => {
|
||||
await memGot('sindresorhus.com');
|
||||
await memGot('sindresorhus.com');
|
||||
await memGot('sindresorhus.com');
|
||||
|
||||
console.log(cache.stats);
|
||||
//=> {hits: 2, misses: 1}
|
||||
})();
|
||||
```
|
||||
|
||||
|
||||
## Related
|
||||
|
||||
- [p-memoize](https://github.com/sindresorhus/p-memoize) - Memoize promise-returning & async functions
|
||||
|
||||
|
||||
---
|
||||
|
||||
<div align="center">
|
||||
<b>
|
||||
<a href="https://tidelift.com/subscription/pkg/npm-mem?utm_source=npm-mem&utm_medium=referral&utm_campaign=readme">Get professional support for this package with a Tidelift subscription</a>
|
||||
</b>
|
||||
<br>
|
||||
<sub>
|
||||
Tidelift helps make open source sustainable for maintainers while giving companies<br>assurances about security, maintenance, and licensing for their dependencies.
|
||||
</sub>
|
||||
</div>
|
||||
Loading…
Add table
Add a link
Reference in a new issue