@common.js/p-memoize 7.1.0 → 7.1.1

package/README.md

@@ -2,4 +2,4 @@
 
 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.
+Exported from [p-memoize@7.1.1](https://www.npmjs.com/package/p-memoize/v/7.1.1) using https://github.com/etienne-martin/common.js.

package/dist/index.d.ts

@@ -1,13 +1,13 @@
 import type { AsyncReturnType } from 'type-fest';
 export declare type AnyAsyncFunction = (...arguments_: readonly any[]) => Promise<unknown | void>;
-export interface CacheStorage<KeyType, ValueType> {
+export declare type 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> {
+};
+export declare type 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).
 
@@ -41,7 +41,7 @@ export interface Options<FunctionToMemoize extends AnyAsyncFunction, CacheKeyTyp
     @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.
 

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@common.js/p-memoize",
-  "version": "7.1.0",
-  "description": "Memoize promise-returning & async functions",
+  "version": "7.1.1",
+  "description": "p-memoize package exported as CommonJS modules",
   "license": "MIT",
   "repository": "etienne-martin/common.js",
   "funding": "https://github.com/sindresorhus/p-memoize?sponsor=1",
   "type": "commonjs",
-  "types": "dist/index.d.ts",
+  "types": "./dist/index.d.ts",
   "engines": {
     "node": ">=14.16"
   },
@@ -18,20 +18,21 @@
     "dist"
   ],
   "dependencies": {
-    "@common.js/mimic-fn": "^4.0.0"
+    "@common.js/mimic-fn": "^4.0.0",
+    "type-fest": "^3.0.0"
   },
   "devDependencies": {
     "@sindresorhus/tsconfig": "^3.0.1",
     "@types/serialize-javascript": "^5.0.2",
-    "ava": "^4.3.0",
-    "del-cli": "^4.0.1",
+    "ava": "^4.3.3",
+    "del-cli": "^5.0.0",
     "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"
+    "ts-node": "^10.9.1",
+    "tsd": "^0.24.1",
+    "xo": "^0.52.4"
   },
   "ava": {
     "extensions": {

package/readme.md

@@ -1,154 +0,0 @@
-# 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)