@common.js/mem 9.0.2

package/README.md

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

package/dist/index.d.ts

@@ -0,0 +1,116 @@
+declare type AnyFunction = (...arguments_: any) => any;
+interface CacheStorageContent<ValueType> {
+    data: ValueType;
+    maxAge: number;
+}
+interface CacheStorage<KeyType, ValueType> {
+    has: (key: KeyType) => boolean;
+    get: (key: KeyType) => CacheStorageContent<ValueType> | undefined;
+    set: (key: KeyType, value: CacheStorageContent<ValueType>) => void;
+    delete: (key: KeyType) => void;
+    clear?: () => void;
+}
+export interface Options<FunctionToMemoize extends AnyFunction, CacheKeyType> {
+    /**
+    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 from '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 from 'mem';
+    import serializeJavascript from 'serialize-javascript';
+
+    mem(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.
+
+    @default new Map()
+    @example new WeakMap()
+    */
+    readonly cache?: CacheStorage<CacheKeyType, ReturnType<FunctionToMemoize>>;
+}
+/**
+[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 from 'mem';
+
+let index = 0;
+const counter = () => ++index;
+const memoized = mem(counter);
+
+memoized('foo');
+//=> 1
+
+// Cached as it's the same argument
+memoized('foo');
+//=> 1
+
+// Not cached anymore as the arguments changed
+memoized('bar');
+//=> 2
+
+memoized('bar');
+//=> 2
+```
+*/
+export default function mem<FunctionToMemoize extends AnyFunction, CacheKeyType>(fn: FunctionToMemoize, { cacheKey, cache, maxAge, }?: Options<FunctionToMemoize, CacheKeyType>): FunctionToMemoize;
+/**
+@returns A [decorator](https://github.com/tc39/proposal-decorators) to memoize class methods or static class methods.
+
+@example
+```
+import {memDecorator} from 'mem';
+
+class Example {
+    index = 0
+
+    @memDecorator()
+    counter() {
+        return ++this.index;
+    }
+}
+
+class ExampleWithOptions {
+    index = 0
+
+    @memDecorator({maxAge: 1000})
+    counter() {
+        return ++this.index;
+    }
+}
+```
+*/
+export declare function memDecorator<FunctionToMemoize extends AnyFunction, 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 memClear(fn: AnyFunction): void;
+export {};

package/dist/index.js

@@ -0,0 +1,113 @@
+"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 mem from 'mem';
+
+let index = 0;
+const counter = () => ++index;
+const memoized = mem(counter);
+
+memoized('foo');
+//=> 1
+
+// Cached as it's the same argument
+memoized('foo');
+//=> 1
+
+// Not cached anymore as the arguments changed
+memoized('bar');
+//=> 2
+
+memoized('bar');
+//=> 2
+```
+*/ default: function() {
+        return mem;
+    },
+    memDecorator: function() {
+        return memDecorator;
+    },
+    memClear: function() {
+        return memClear;
+    }
+});
+var _mimicFn = /*#__PURE__*/ _interopRequireDefault(require("mimic-fn"));
+var _mapAgeCleaner = /*#__PURE__*/ _interopRequireDefault(require("map-age-cleaner"));
+function _interopRequireDefault(obj) {
+    return obj && obj.__esModule ? obj : {
+        default: obj
+    };
+}
+var cacheStore = new WeakMap();
+function mem(fn) {
+    var ref = arguments.length > 1 && arguments[1] !== void 0 ? arguments[1] : {}, cacheKey = ref.cacheKey, _cache = ref.cache, cache = _cache === void 0 ? new Map() : _cache, maxAge = ref.maxAge;
+    if (typeof maxAge === "number") {
+        (0, _mapAgeCleaner.default)(cache);
+    }
+    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 ? cacheKey(arguments_) : arguments_[0];
+        var cacheItem = cache.get(key);
+        if (cacheItem) {
+            return cacheItem.data; // eslint-disable-line @typescript-eslint/no-unsafe-return
+        }
+        var result = fn.apply(this, arguments_);
+        cache.set(key, {
+            data: result,
+            maxAge: maxAge ? Date.now() + maxAge : Number.POSITIVE_INFINITY
+        });
+        return result; // eslint-disable-line @typescript-eslint/no-unsafe-return
+    };
+    (0, _mimicFn.default)(memoized, fn, {
+        ignoreNonConfigurable: true
+    });
+    cacheStore.set(memoized, cache);
+    return memoized;
+}
+function memDecorator() {
+    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, @typescript-eslint/no-unsafe-member-access
+        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 = mem(input, options);
+                instanceMap.set(this, value);
+                return value;
+            }
+            return instanceMap.get(this);
+        };
+    };
+}
+function memClear(fn) {
+    var cache = cacheStore.get(fn);
+    if (!cache) {
+        throw new TypeError("Can't clear a function that was not memoized!");
+    }
+    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,58 @@
+{
+  "name": "@common.js/mem",
+  "version": "9.0.2",
+  "description": "mem package exported as CommonJS modules",
+  "license": "MIT",
+  "repository": "etienne-martin/common.js",
+  "funding": "https://github.com/sindresorhus/mem?sponsor=1",
+  "type": "commonjs",
+  "engines": {
+    "node": ">=12.20"
+  },
+  "scripts": {
+    "test": "xo && ava && npm run build && tsd",
+    "build": "del-cli dist && tsc"
+  },
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "map-age-cleaner": "^0.1.3",
+    "@common.js/mimic-fn": "^4.0.0"
+  },
+  "devDependencies": {
+    "@ava/typescript": "^1.1.1",
+    "@sindresorhus/tsconfig": "^1.0.2",
+    "@types/serialize-javascript": "^4.0.0",
+    "ava": "^3.15.0",
+    "del-cli": "^3.0.1",
+    "delay": "^4.4.0",
+    "serialize-javascript": "^5.0.1",
+    "ts-node": "^10.1.0",
+    "tsd": "^0.13.1",
+    "typescript": "^4.3.5",
+    "xo": "^0.41.0"
+  },
+  "ava": {
+    "timeout": "1m",
+    "extensions": {
+      "ts": "module"
+    },
+    "nonSemVerExperiments": {
+      "configurableModuleFormat": true
+    },
+    "nodeArguments": [
+      "--loader=ts-node/esm"
+    ]
+  },
+  "xo": {
+    "rules": {
+      "@typescript-eslint/member-ordering": "off",
+      "@typescript-eslint/no-var-requires": "off",
+      "@typescript-eslint/no-empty-function": "off"
+    }
+  },
+  "homepage": "https://github.com/etienne-martin/common.js#readme",
+  "main": "./dist/index.js"
+}