@common.js/p-memoize 7.1.0

package/README.md

@@ -0,0 +1,5 @@
+# @common.js/p-memoize
+
+The [p-memoize](https://www.npmjs.com/package/p-memoize) package exported as CommonJS modules.
+
+Exported from [p-memoize@7.1.0](https://www.npmjs.com/package/p-memoize/v/7.1.0) using https://github.com/etienne-martin/common.js.

package/dist/index.d.ts

@@ -0,0 +1,106 @@
+import type { AsyncReturnType } from 'type-fest';
+export declare type AnyAsyncFunction = (...arguments_: readonly any[]) => Promise<unknown | void>;
+export interface CacheStorage<KeyType, ValueType> {
+    has: (key: KeyType) => Promise<boolean> | boolean;
+    get: (key: KeyType) => Promise<ValueType | undefined> | ValueType | undefined;
+    set: (key: KeyType, value: ValueType) => Promise<unknown> | unknown;
+    delete: (key: KeyType) => unknown;
+    clear?: () => unknown;
+}
+export interface Options<FunctionToMemoize extends AnyAsyncFunction, CacheKeyType> {
+    /**
+    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 pMemoize from 'p-memoize';
+
+    pMemoize(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 pMemoize from 'p-memoize';
+    import serializeJavascript from 'serialize-javascript';
+
+    pMemoize(function_, {cacheKey: serializeJavascript});
+    ```
+
+    @default arguments_ => arguments_[0]
+    @example arguments_ => JSON.stringify(arguments_)
+    */
+    readonly cacheKey?: (arguments_: Parameters<FunctionToMemoize>) => 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. To disable caching so that only concurrent executions resolve with the same value, pass `false`.
+
+    @default new Map()
+    @example new WeakMap()
+    */
+    readonly cache?: CacheStorage<CacheKeyType, AsyncReturnType<FunctionToMemoize>> | false;
+}
+/**
+[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 {setTimeout as delay} from 'node:timer/promises';
+import pMemoize from 'p-memoize';
+import got from 'got';
+
+const memoizedGot = pMemoize(got);
+
+await memoizedGot('https://sindresorhus.com');
+
+// This call is cached
+await memoizedGot('https://sindresorhus.com');
+
+await delay(2000);
+
+// This call is not cached as the cache has expired
+await memoizedGot('https://sindresorhus.com');
+```
+*/
+export default function pMemoize<FunctionToMemoize extends AnyAsyncFunction, CacheKeyType>(fn: FunctionToMemoize, { cacheKey, cache, }?: Options<FunctionToMemoize, CacheKeyType>): FunctionToMemoize;
+/**
+- Only class methods and getters/setters can be memoized, not regular functions (they aren't part of the proposal);
+- Only [TypeScript’s decorators](https://www.typescriptlang.org/docs/handbook/decorators.html#parameter-decorators) are supported, not [Babel’s](https://babeljs.io/docs/en/babel-plugin-proposal-decorators), which use a different version of the proposal;
+- Being an experimental feature, they need to be enabled with `--experimentalDecorators`; follow TypeScript’s docs.
+
+@returns A [decorator](https://github.com/tc39/proposal-decorators) to memoize class methods or static class methods.
+
+@example
+```
+import {pMemoizeDecorator} from 'p-memoize';
+
+class Example {
+    index = 0
+
+    @pMemoizeDecorator()
+    async counter() {
+        return ++this.index;
+    }
+}
+
+class ExampleWithOptions {
+    index = 0
+
+    @pMemoizeDecorator()
+    async counter() {
+        return ++this.index;
+    }
+}
+```
+*/
+export declare function pMemoizeDecorator<FunctionToMemoize extends AnyAsyncFunction, CacheKeyType>(options?: Options<FunctionToMemoize, CacheKeyType>): (target: any, propertyKey: string, descriptor: PropertyDescriptor) => void;
+/**
+Clear all cached data of a memoized function.
+
+@param fn - Memoized function.
+*/
+export declare function pMemoizeClear(fn: AnyAsyncFunction): void;

package/dist/index.js

@@ -0,0 +1,370 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+function _export(target, all) {
+    for(var name in all)Object.defineProperty(target, name, {
+        enumerable: true,
+        get: all[name]
+    });
+}
+_export(exports, {
+    /**
+[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 {setTimeout as delay} from 'node:timer/promises';
+import pMemoize from 'p-memoize';
+import got from 'got';
+
+const memoizedGot = pMemoize(got);
+
+await memoizedGot('https://sindresorhus.com');
+
+// This call is cached
+await memoizedGot('https://sindresorhus.com');
+
+await delay(2000);
+
+// This call is not cached as the cache has expired
+await memoizedGot('https://sindresorhus.com');
+```
+*/ default: function() {
+        return pMemoize;
+    },
+    pMemoizeDecorator: function() {
+        return pMemoizeDecorator;
+    },
+    pMemoizeClear: function() {
+        return pMemoizeClear;
+    }
+});
+var _mimicFn = /*#__PURE__*/ _interopRequireDefault(require("mimic-fn"));
+function _arrayLikeToArray(arr, len) {
+    if (len == null || len > arr.length) len = arr.length;
+    for(var i = 0, arr2 = new Array(len); i < len; i++)arr2[i] = arr[i];
+    return arr2;
+}
+function _arrayWithHoles(arr) {
+    if (Array.isArray(arr)) return arr;
+}
+function asyncGeneratorStep(gen, resolve, reject, _next, _throw, key, arg) {
+    try {
+        var info = gen[key](arg);
+        var value = info.value;
+    } catch (error) {
+        reject(error);
+        return;
+    }
+    if (info.done) {
+        resolve(value);
+    } else {
+        Promise.resolve(value).then(_next, _throw);
+    }
+}
+function _asyncToGenerator(fn) {
+    return function() {
+        var self = this, args = arguments;
+        return new Promise(function(resolve, reject) {
+            var gen = fn.apply(self, args);
+            function _next(value) {
+                asyncGeneratorStep(gen, resolve, reject, _next, _throw, "next", value);
+            }
+            function _throw(err) {
+                asyncGeneratorStep(gen, resolve, reject, _next, _throw, "throw", err);
+            }
+            _next(undefined);
+        });
+    };
+}
+function _interopRequireDefault(obj) {
+    return obj && obj.__esModule ? obj : {
+        default: obj
+    };
+}
+function _iterableToArrayLimit(arr, i) {
+    var _i = arr == null ? null : typeof Symbol !== "undefined" && arr[Symbol.iterator] || arr["@@iterator"];
+    if (_i == null) return;
+    var _arr = [];
+    var _n = true;
+    var _d = false;
+    var _s, _e;
+    try {
+        for(_i = _i.call(arr); !(_n = (_s = _i.next()).done); _n = true){
+            _arr.push(_s.value);
+            if (i && _arr.length === i) break;
+        }
+    } catch (err) {
+        _d = true;
+        _e = err;
+    } finally{
+        try {
+            if (!_n && _i["return"] != null) _i["return"]();
+        } finally{
+            if (_d) throw _e;
+        }
+    }
+    return _arr;
+}
+function _nonIterableRest() {
+    throw new TypeError("Invalid attempt to destructure non-iterable instance.\\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.");
+}
+function _slicedToArray(arr, i) {
+    return _arrayWithHoles(arr) || _iterableToArrayLimit(arr, i) || _unsupportedIterableToArray(arr, i) || _nonIterableRest();
+}
+function _unsupportedIterableToArray(o, minLen) {
+    if (!o) return;
+    if (typeof o === "string") return _arrayLikeToArray(o, minLen);
+    var n = Object.prototype.toString.call(o).slice(8, -1);
+    if (n === "Object" && o.constructor) n = o.constructor.name;
+    if (n === "Map" || n === "Set") return Array.from(n);
+    if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen);
+}
+var __generator = (void 0) && (void 0).__generator || function(thisArg, body) {
+    var f, y, t, g, _ = {
+        label: 0,
+        sent: function() {
+            if (t[0] & 1) throw t[1];
+            return t[1];
+        },
+        trys: [],
+        ops: []
+    };
+    return g = {
+        next: verb(0),
+        "throw": verb(1),
+        "return": verb(2)
+    }, typeof Symbol === "function" && (g[Symbol.iterator] = function() {
+        return this;
+    }), g;
+    function verb(n) {
+        return function(v) {
+            return step([
+                n,
+                v
+            ]);
+        };
+    }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while(_)try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [
+                op[0] & 2,
+                t.value
+            ];
+            switch(op[0]){
+                case 0:
+                case 1:
+                    t = op;
+                    break;
+                case 4:
+                    _.label++;
+                    return {
+                        value: op[1],
+                        done: false
+                    };
+                case 5:
+                    _.label++;
+                    y = op[1];
+                    op = [
+                        0
+                    ];
+                    continue;
+                case 7:
+                    op = _.ops.pop();
+                    _.trys.pop();
+                    continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) {
+                        _ = 0;
+                        continue;
+                    }
+                    if (op[0] === 3 && (!t || op[1] > t[0] && op[1] < t[3])) {
+                        _.label = op[1];
+                        break;
+                    }
+                    if (op[0] === 6 && _.label < t[1]) {
+                        _.label = t[1];
+                        t = op;
+                        break;
+                    }
+                    if (t && _.label < t[2]) {
+                        _.label = t[2];
+                        _.ops.push(op);
+                        break;
+                    }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop();
+                    continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) {
+            op = [
+                6,
+                e
+            ];
+            y = 0;
+        } finally{
+            f = t = 0;
+        }
+        if (op[0] & 5) throw op[1];
+        return {
+            value: op[0] ? op[1] : void 0,
+            done: true
+        };
+    }
+};
+var cacheStore = new WeakMap();
+function pMemoize(fn) {
+    var ref = arguments.length > 1 && arguments[1] !== void 0 ? arguments[1] : {}, _cacheKey = ref.cacheKey, cacheKey = _cacheKey === void 0 ? function(param) {
+        var _param = _slicedToArray(param, 1), firstArgument = _param[0];
+        return firstArgument;
+    } : _cacheKey, _cache = ref.cache, cache = _cache === void 0 ? new Map() : _cache;
+    // Promise objects can't be serialized so we keep track of them internally and only provide their resolved values to `cache`
+    // `Promise<AsyncReturnType<FunctionToMemoize>>` is used instead of `ReturnType<FunctionToMemoize>` because promise properties are not kept
+    var promiseCache = new Map();
+    var memoized = function memoized() {
+        for(var _len = arguments.length, arguments_ = new Array(_len), _key = 0; _key < _len; _key++){
+            arguments_[_key] = arguments[_key];
+        }
+        var key = cacheKey(arguments_);
+        if (promiseCache.has(key)) {
+            return promiseCache.get(key);
+        }
+        var _this = this;
+        var promise = _asyncToGenerator(function() {
+            var _tmp, promise, result;
+            return __generator(this, function(_state) {
+                switch(_state.label){
+                    case 0:
+                        _state.trys.push([
+                            0,
+                            ,
+                            11,
+                            12
+                        ]);
+                        _tmp = cache;
+                        if (!_tmp) return [
+                            3,
+                            2
+                        ];
+                        return [
+                            4,
+                            cache.has(key)
+                        ];
+                    case 1:
+                        _tmp = _state.sent();
+                        _state.label = 2;
+                    case 2:
+                        if (!_tmp) return [
+                            3,
+                            4
+                        ];
+                        return [
+                            4,
+                            cache.get(key)
+                        ];
+                    case 3:
+                        return [
+                            2,
+                            _state.sent()
+                        ];
+                    case 4:
+                        promise = fn.apply(_this, arguments_);
+                        return [
+                            4,
+                            promise
+                        ];
+                    case 5:
+                        result = _state.sent();
+                        _state.label = 6;
+                    case 6:
+                        _state.trys.push([
+                            6,
+                            ,
+                            7,
+                            10
+                        ]);
+                        return [
+                            2,
+                            result
+                        ];
+                    case 7:
+                        if (!cache) return [
+                            3,
+                            9
+                        ];
+                        return [
+                            4,
+                            cache.set(key, result)
+                        ];
+                    case 8:
+                        _state.sent();
+                        _state.label = 9;
+                    case 9:
+                        return [
+                            7
+                        ];
+                    case 10:
+                        return [
+                            3,
+                            12
+                        ];
+                    case 11:
+                        promiseCache.delete(key);
+                        return [
+                            7
+                        ];
+                    case 12:
+                        return [
+                            2
+                        ];
+                }
+            });
+        })();
+        promiseCache.set(key, promise);
+        return promise;
+    };
+    (0, _mimicFn.default)(memoized, fn, {
+        ignoreNonConfigurable: true
+    });
+    cacheStore.set(memoized, cache);
+    return memoized;
+}
+function pMemoizeDecorator() {
+    var options = arguments.length > 0 && arguments[0] !== void 0 ? arguments[0] : {};
+    var instanceMap = new WeakMap();
+    return function(target, propertyKey, descriptor) {
+        var input = target[propertyKey]; // eslint-disable-line @typescript-eslint/no-unsafe-assignment
+        if (typeof input !== "function") {
+            throw new TypeError("The decorated value must be a function");
+        }
+        delete descriptor.value;
+        delete descriptor.writable;
+        descriptor.get = function() {
+            if (!instanceMap.has(this)) {
+                var value = pMemoize(input, options);
+                instanceMap.set(this, value);
+                return value;
+            }
+            return instanceMap.get(this);
+        };
+    };
+}
+function pMemoizeClear(fn) {
+    if (!cacheStore.has(fn)) {
+        throw new TypeError("Can't clear a function that was not memoized!");
+    }
+    var cache = cacheStore.get(fn);
+    if (!cache) {
+        throw new TypeError("Can't clear a function that doesn't use a cache!");
+    }
+    if (typeof cache.clear !== "function") {
+        throw new TypeError("The cache Map can't be cleared!");
+    }
+    cache.clear();
+}

package/license

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (https://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.

package/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "@common.js/p-memoize",
+  "version": "7.1.0",
+  "description": "Memoize promise-returning & async functions",
+  "license": "MIT",
+  "repository": "etienne-martin/common.js",
+  "funding": "https://github.com/sindresorhus/p-memoize?sponsor=1",
+  "type": "commonjs",
+  "types": "dist/index.d.ts",
+  "engines": {
+    "node": ">=14.16"
+  },
+  "scripts": {
+    "test": "xo && ava && npm run build && tsd",
+    "build": "del-cli dist && tsc"
+  },
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "@common.js/mimic-fn": "^4.0.0"
+  },
+  "devDependencies": {
+    "@sindresorhus/tsconfig": "^3.0.1",
+    "@types/serialize-javascript": "^5.0.2",
+    "ava": "^4.3.0",
+    "del-cli": "^4.0.1",
+    "delay": "^5.0.0",
+    "p-defer": "^4.0.0",
+    "p-state": "^1.0.0",
+    "serialize-javascript": "^6.0.0",
+    "ts-node": "^10.8.2",
+    "tsd": "^0.22.0",
+    "xo": "^0.50.0"
+  },
+  "ava": {
+    "extensions": {
+      "ts": "module"
+    },
+    "nodeArguments": [
+      "--loader=ts-node/esm"
+    ]
+  },
+  "xo": {
+    "rules": {
+      "@typescript-eslint/no-redundant-type-constituents": "off"
+    }
+  },
+  "homepage": "https://github.com/etienne-martin/common.js#readme",
+  "main": "./dist/index.js"
+}

package/readme.md

@@ -0,0 +1,154 @@
+# p-memoize
+
+> [Memoize](https://en.wikipedia.org/wiki/Memoization) promise-returning & async functions
+
+Useful for speeding up consecutive function calls by caching the result of calls with identical input.
+
+<!-- Please keep this section in sync with https://github.com/sindresorhus/mem/blob/main/readme.md -->
+
+By default, **only the memoized function's first argument is considered** via strict equality comparison. If you need to cache multiple arguments or cache `object`s *by value*, have a look at alternative [caching strategies](#caching-strategy) below.
+
+This package is similar to [mem](https://github.com/sindresorhus/mem) but with async-specific enhancements; in particular, it allows for asynchronous caches and does not cache rejected promises.
+
+## Install
+
+```sh
+npm install p-memoize
+```
+
+## Usage
+
+```js
+import pMemoize from 'p-memoize';
+import got from 'got';
+
+const memoizedGot = pMemoize(got);
+
+await memoizedGot('https://sindresorhus.com');
+
+// This call is cached
+await memoizedGot('https://sindresorhus.com');
+```
+
+### Caching strategy
+
+Similar to the [caching strategy for `mem`](https://github.com/sindresorhus/mem#options) with the following exceptions:
+
+- Promises returned from a memoized function are locally cached until resolving, when their value is added to `cache`. Special properties assigned to a returned promise will not be kept after resolution and every promise may need to resolve with a serializable object if caching results in a database.
+- `.get()`, `.has()` and `.set()` methods on `cache` can run asynchronously by returning a promise.
+- Instead of `.set()` being provided an object with the properties `value` and `maxAge`, it will only be provided `value` as the first argument. If you want to implement time-based expiry, consider [doing so in `cache`](#time-based-cache-expiration).
+
+## API
+
+### pMemoize(fn, options?)
+
+Returns a memoized version of the given function.
+
+#### fn
+
+Type: `Function`
+
+Promise-returning or async function to be memoized.
+
+#### options
+
+Type: `object`
+
+See the [`mem` options](https://github.com/sindresorhus/mem#options) in addition to the below option.
+
+##### 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).
+
+See the [caching strategy](#caching-strategy) section for more information.
+
+##### cache
+
+Type: `object | false`\
+Default: `new Map()`
+
+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. To disable caching so that only concurrent executions resolve with the same value, pass `false`.
+
+See the [caching strategy](https://github.com/sindresorhus/mem#caching-strategy) section in the `mem` package for more information.
+
+### pMemoizeDecorator(options)
+
+Returns a [decorator](https://github.com/tc39/proposal-decorators) to memoize class methods or static class methods.
+
+Notes:
+
+- Only class methods and getters/setters can be memoized, not regular functions (they aren't part of the proposal);
+- Only [TypeScript’s decorators](https://www.typescriptlang.org/docs/handbook/decorators.html#parameter-decorators) are supported, not [Babel’s](https://babeljs.io/docs/en/babel-plugin-proposal-decorators), which use a different version of the proposal;
+- Being an experimental feature, they need to be enabled with `--experimentalDecorators`; follow TypeScript’s docs.
+
+#### options
+
+Type: `object`
+
+Same as options for `pMemoize()`.
+
+```ts
+import {pMemoizeDecorator} from 'p-memoize';
+
+class Example {
+	index = 0
+
+	@pMemoizeDecorator()
+	async counter() {
+		return ++this.index;
+	}
+}
+
+class ExampleWithOptions {
+	index = 0
+
+	@pMemoizeDecorator()
+	async counter() {
+		return ++this.index;
+	}
+}
+```
+
+### pMemoizeClear(memoized)
+
+Clear all cached data of a memoized function.
+
+It will throw when given a non-memoized function.
+
+## Tips
+
+### Time-based cache expiration
+
+```js
+import pMemoize from 'p-memoize';
+import ExpiryMap from 'expiry-map';
+import got from 'got';
+
+const cache = new ExpiryMap(10000); // Cached values expire after 10 seconds
+
+const memoizedGot = pMemoize(got, {cache});
+```
+
+### Caching promise rejections
+
+```js
+import pMemoize from 'p-memoize';
+import pReflect from 'p-reflect';
+
+const memoizedGot = pMemoize(async (url, options) => pReflect(got(url, options)));
+
+await memoizedGot('https://example.com');
+// {isFulfilled: true, isRejected: false, value: '...'}
+```
+
+## Related
+
+- [p-debounce](https://github.com/sindresorhus/p-debounce) - Debounce promise-returning & async functions
+- [p-throttle](https://github.com/sindresorhus/p-throttle) - Throttle promise-returning & async functions
+- [More…](https://github.com/sindresorhus/promise-fun)