@xstd/async-function 1.3.0 → 1.3.1

package/CONTRIBUTING.md

@@ -1,6 +1,6 @@
 # Contributing
 
-This projet is open to everyone. Feel free to test the library, share it, improve it, and create merge requests.
+This project is open to everyone. Feel free to test the library, share it, improve it, and create pull requests.
 
 ## Getting started
 
@@ -38,40 +38,34 @@ yarn install
 ### Code
 
 - The source code is located in the `src` directory.
-- The projet uses [prettier](https://prettier.io/) to format the code. You'll want to enable and configure it in your IDE.
+- The project uses [prettier](https://prettier.io/) to format the code. You'll want to enable and configure it in your IDE.
 - The tests run with [vitest](https://vitest.dev)
 
 ### Commands
 
 - `fb:build`: builds the library.
-  - converts the typescript files into javascript files, copies the scss files, and assembles all the assets to create a package ready to be published.
+  - converts the TypeScript files into JavaScript files, copies the SCSS files, and assembles all the assets to create a package ready to be published.
   - some files are handled differently:
-    - `*.protected.{ts,scss}` or `**/*.protected/**`: these files are exported under `package-name/protected`
-      - this is indented to expose parts of the code that should be restricted to advanced users only, or shared to other libraries requiring _internal_ control.
+    - `*.protected.{ts,scss}` or `**/*.protected/**`: these files are exported under `package-name/protected`.
+      - this is intended to expose parts of the code that should be restricted to advanced users only, or shared with other libraries requiring _internal_ control.
     - `*.private.{ts,scss}` or `/*.private/**`: these files are **not** exported.
-      - this is indented to consume parts of the code internally, and not expose them publicly.
+      - this is intended to consume parts of the code internally, without exposing them publicly.
 - `fb:format`: formats the code using `prettier`.
-- `fb:test`: runs the tests using `vitest`.
-- `fb:test:coverage`: runs the tests with coverage.
-  - by default, 100% code coverage is required, to enforce good quality.
-- `fb:bench`: runs the bench tests.
-- `fb:typedoc`: generates the documentation.
-  - if the library exposes publicly only a few and/or simple parts, the documentation may be defined in the `README.md` instead.
 
 ### To create a PR
 
-1. fork the repository
-1. add the feature/fix by modifying the code in the `src/` directory
-1. add/write some tests until 100% code coverage is reached (run the tests with `yarn fb:test:coverage`)
-1. format the code, using the command `yarn fb:format`
-1. commit and push your work following the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) convention
-1. create a PR from your repository to the upstream repository, explaining clearly what was added/fixed.
+1. Fork the repository
+1. Add the feature or fix by modifying the code in the `src/` directory
+1. Add/write some tests with good code coverage (run them with `yarn fb:test:coverage`)
+1. Format the code using the command `yarn fb:format`
+1. Commit and push your work following the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) convention
+1. Create a PR from your fork to the upstream repository, clearly explaining what was added or fixed.
 
 ## Release Workflow
 
-> The `release.yml` workflow runs on `pull_request` and `push` events on the `main` and `develop` branches.
-> It invokes the `yarn fb:ci:release` used to build and publish the package.
-> Note that the `publish` step runs only if the equivalent stable version (`x.y.z`) does not already exist on npm
+> The `release.yml` workflow runs on `pull_request` and `push` events for the `main` and `develop` branches.
+> It invokes `yarn fb:ci:release`, which builds and publishes the packages.
+> Note that the `publish` step runs only if the equivalent stable version (`x.y.z`) does not already exist on npm.
 
 ### 1. Pull Request to `main` or `develop`
 
@@ -81,6 +75,10 @@ yarn install
 
 > Use the `dev` versions only if required.
 
+> [!NOTE]
+> The PR is published only if it carries the `dev` label — add it to the PR to get a `dev` release; otherwise the release is skipped.
+> Pull requests coming from forks always run in dry-run mode: nothing is published.
+
 ### 2. Push to `develop`
 
 - Impacted packages are published as: `x.y.z-rc.<timestamp>`
@@ -96,14 +94,14 @@ yarn install
 ```mermaid
 flowchart LR
   EVENT("WORKFLOW TRIGGER")
-  HAS_DEV_TAG{"has &quotdev&quot tag ?"}
+  HAS_DEV_TAG{"has &quot;dev&quot; label?"}
   SKIP_BUILD(["skip build"])
-  BUILD_DEV_PACKAGES["build &quotdev&quot package"]
-  PUBLISH_DEV_PACKAGES["publish &quotdev&quot package"]
-  BUILD_RC_PACKAGES["build &quotrc&quot package"]
-  PUBLISH_RC_PACKAGES["publish &quotrc&quot package"]
-  BUILD_PROD_PACKAGES["build &quotprod&quot package"]
-  PUBLISH_PROD_PACKAGES["publish &quotprod&quot package"]
+  BUILD_DEV_PACKAGES["build &quot;dev&quot; packages"]
+  PUBLISH_DEV_PACKAGES["publish &quot;dev&quot; packages"]
+  BUILD_RC_PACKAGES["build &quot;rc&quot; packages"]
+  PUBLISH_RC_PACKAGES["publish &quot;rc&quot; packages"]
+  BUILD_PROD_PACKAGES["build &quot;prod&quot; packages"]
+  PUBLISH_PROD_PACKAGES["publish &quot;prod&quot; packages"]
   TARGET_BRANCH{"branch"}
 
   EVENT -- "pull_request" --> HAS_DEV_TAG
@@ -122,6 +120,7 @@ flowchart LR
 
 ## Important Rules
 
-- if an equivalent **stable** version already exists on npm: the release is skipped
-- the `package.json` file in the repo must keep stable versions (`x.y.z`)
-- `-dev` / `-rc` suffixes are generated in CI
+- If an equivalent **stable** version already exists on npm, the release fails — bump the `package.json#version` before releasing (this also blocks `dev` / `rc` releases of a stable version that was already published).
+- The `package.json` version in the repo must always be a stable version (`x.y.z`).
+- The `-dev` / `-rc` suffixes are generated in CI.
+- The npm publish authenticates with [GitHub Actions OIDC](https://docs.github.com/en/actions/security-for-github-actions/security-hardening-your-deployments/about-security-hardening-with-oidc): no `NPM_TOKEN` secret is required (the `release.yml` workflow requests the `id-token: write` permission).

package/README.md

@@ -42,7 +42,7 @@ const fetchUser = fetchJson
   });
 
 // deduplicate concurrent calls for the same key:
-const getUser = fetchUser.shareConcurentCalls({ keyGenerator: ([id]) => id as string });
+const getUser = fetchUser.shareConcurrentCalls({ keyGenerator: ([id]) => id as string });
 
 const controller = new AbortController();
 const user = await getUser.call(controller.signal, '42');
@@ -253,10 +253,10 @@ const safe = fnc.catch((error) => null);
 const result = await safe.call(signal); // Response, or null if the request failed
 ```
 
-##### `shareConcurentCalls` (experimental)
+##### `shareConcurrentCalls` (experimental)
 
 ```ts
-shareConcurentCalls(options: ShareConcurentCallsOptions<GArguments>): AsyncFunction<GArguments, GReturn>
+shareConcurrentCalls(options: ShareConcurrentCallsOptions<GArguments>): AsyncFunction<GArguments, GReturn>
 ```
 
 Returns a new async function that deduplicates concurrent calls sharing the same key: while a call is in-flight, subsequent calls with the same key await the same underlying promise instead of triggering a new call.
@@ -270,7 +270,7 @@ The first call starts the underlying call with its own `AbortController`. Each c
 ```ts
 const loadUser = new AsyncFunction(async (signal, id: string) =>
   fetchUser(id, { signal }),
-).shareConcurentCalls({ keyGenerator: ([id]) => id });
+).shareConcurrentCalls({ keyGenerator: ([id]) => id });
 
 // 'fetchUser' is called once, both calls await the same result:
 const [a, b] = await Promise.all([loadUser.call(signal, 'a'), loadUser.call(signal, 'a')]);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xstd/async-function",
-  "version": "1.3.0",
+  "version": "1.3.1",
   "type": "module",
   "description": "Universal API around async functions",
   "keywords": [],
@@ -20,6 +20,6 @@
   },
   "dependencies": {
     "@xstd/abortable": "^1.2.3",
-    "@xstd/map-function": "^1.0.0"
+    "@xstd/map-function": "^1.3.0"
   }
 }

package/src/async-function.d.ts

@@ -1,6 +1,6 @@
 import type { MapFunctionArguments } from '@xstd/map-function';
 import { type AsyncFunctionLike } from './types/async-function-like.ts';
-import { type ShareConcurentCallsOptions } from './types/methods/share-concurent-calls/share-concurent-calls-options.js';
+import { type ShareConcurrentCallsOptions } from './types/methods/share-concurrent-calls/share-concurrent-calls-options.ts';
 import { type AsyncFunctionThenOnFulfilledFunction } from './types/methods/then/async-function.then.on-fulfilled-function.ts';
 import { type AsyncFunctionThenOnRejectedFunction } from './types/methods/then/async-function.then.on-rejected-function.ts';
 import { type TransformAsyncFunctionFunction } from './types/methods/transform/transform-async-function-function.ts';
@@ -137,18 +137,18 @@ export declare class AsyncFunction<GArguments extends readonly unknown[], GRetur
      * The first call starts the underlying call with its own `AbortController`. Each caller may abort its own wait without affecting the shared call. When the last consumer settles, the shared controller is aborted, the entry is removed, and a subsequent call starts a new one.
      *
      * @experimental
-     * @param {ShareConcurentCallsOptions<GArguments>} options Configuration object.
-     * @param {ShareConcurentCallsKeyGenerator<GArguments>} options.keyGenerator A function that generates a cache key from the call's arguments. Calls producing the same key share their result.
+     * @param {ShareConcurrentCallsOptions<GArguments>} options Configuration object.
+     * @param {ShareConcurrentCallsKeyGenerator<GArguments>} options.keyGenerator A function that generates a cache key from the call's arguments. Calls producing the same key share their result.
      * @returns {AsyncFunction<GArguments, GReturn>} A new async function sharing concurrent calls with identical keys.
      *
      * @example
      * ```ts
      * const loadUser = new AsyncFunction(async (signal, id: string) => fetchUser(id, { signal }))
-     *   .shareConcurentCalls({ keyGenerator: ([id]) => id });
+     *   .shareConcurrentCalls({ keyGenerator: ([id]) => id });
      *
      * // 'fetchUser' is called once, both calls await the same result:
      * const [a, b] = await Promise.all([loadUser.call(signal, 'a'), loadUser.call(signal, 'a')]);
      * ```
      */
-    shareConcurentCalls({ keyGenerator, }: ShareConcurentCallsOptions<GArguments>): AsyncFunction<GArguments, GReturn>;
+    shareConcurrentCalls({ keyGenerator, }: ShareConcurrentCallsOptions<GArguments>): AsyncFunction<GArguments, GReturn>;
 }

package/src/async-function.js

@@ -1,7 +1,7 @@
 import { abortify } from '@xstd/abortable';
 import {} from './types/async-function-like.js';
 import {} from './types/call-async-function.js';
-import {} from './types/methods/share-concurent-calls/share-concurent-calls-options.js';
+import {} from './types/methods/share-concurrent-calls/share-concurrent-calls-options.js';
 import {} from './types/methods/then/async-function.then.on-fulfilled-function.js';
 import {} from './types/methods/then/async-function.then.on-rejected-function.js';
 import { DEFAULT_ASYNC_FUNCTION_THEN_ON_FULFILLED_FUNCTION } from './types/methods/then/default.async-function.then.on-fulfilled-function.private.js';
@@ -183,20 +183,20 @@ export class AsyncFunction {
      * The first call starts the underlying call with its own `AbortController`. Each caller may abort its own wait without affecting the shared call. When the last consumer settles, the shared controller is aborted, the entry is removed, and a subsequent call starts a new one.
      *
      * @experimental
-     * @param {ShareConcurentCallsOptions<GArguments>} options Configuration object.
-     * @param {ShareConcurentCallsKeyGenerator<GArguments>} options.keyGenerator A function that generates a cache key from the call's arguments. Calls producing the same key share their result.
+     * @param {ShareConcurrentCallsOptions<GArguments>} options Configuration object.
+     * @param {ShareConcurrentCallsKeyGenerator<GArguments>} options.keyGenerator A function that generates a cache key from the call's arguments. Calls producing the same key share their result.
      * @returns {AsyncFunction<GArguments, GReturn>} A new async function sharing concurrent calls with identical keys.
      *
      * @example
      * ```ts
      * const loadUser = new AsyncFunction(async (signal, id: string) => fetchUser(id, { signal }))
-     *   .shareConcurentCalls({ keyGenerator: ([id]) => id });
+     *   .shareConcurrentCalls({ keyGenerator: ([id]) => id });
      *
      * // 'fetchUser' is called once, both calls await the same result:
      * const [a, b] = await Promise.all([loadUser.call(signal, 'a'), loadUser.call(signal, 'a')]);
      * ```
      */
-    shareConcurentCalls({ keyGenerator, }) {
+    shareConcurrentCalls({ keyGenerator, }) {
         const map = new Map();
         return new AsyncFunction(async (signal, ...args) => {
             signal.throwIfAborted();

package/src/async-function.js.map

@@ -1 +1 @@
-{"version":3,"file":"async-function.js","sourceRoot":"","sources":["../../src/async-function.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAE3C,OAAO,EAA0B,MAAM,gCAAgC,CAAC;AACxE,OAAO,EAA0B,MAAM,gCAAgC,CAAC;AACxE,OAAO,EAAmC,MAAM,wEAAwE,CAAC;AACzH,OAAO,EAA6C,MAAM,mEAAmE,CAAC;AAC9H,OAAO,EAA4C,MAAM,kEAAkE,CAAC;AAC5H,OAAO,EAAE,iDAAiD,EAAE,MAAM,mFAAmF,CAAC;AACtJ,OAAO,EAAE,gDAAgD,EAAE,MAAM,kFAAkF,CAAC;AACpJ,OAAO,EAAuC,MAAM,gEAAgE,CAAC;AACrH,OAAO,EAA+C,MAAM,8FAA8F,CAAC;AAE3J;;;;;GAKG;AACH,MAAM,OAAO,aAAa;IACxB;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,EAAE,CACP,KAA6C;QAE7C,OAAO,KAAK,YAAY,aAAa,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,aAAa,CAAsB,KAAK,CAAC,CAAC;IAChG,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,MAAM,CAAC,kBAAkB,CAAiD,EACxE,IAAI,EACJ,OAAO,GACqD;QAI5D,IAAI,GAAG,aAAa,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC;QAC9B,OAAO,GAAG,aAAa,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC;QAEpC,OAAO,IAAI,aAAa,CACtB,KAAK,EAAE,MAAmB,EAAE,GAAG,IAAgB,EAAoB,EAAE;YACnE,MAAM,UAAU,GAAoB,IAAI,eAAe,EAAE,CAAC;YAC1D,MAAM,YAAY,GAAgB,WAAW,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC;YAC/E,IAAI,CAAC;gBACH,OAAO,CACL,MAAM,OAAO,CAAC,GAAG,CAAC;oBAChB,OAAO,CAAC,KAAK,CAAC,YAAY,EAAE,GAAG,IAAI,CAAC;oBACpC,IAAI,CAAC,KAAK,CAAC,YAAY,EAAE,GAAG,IAAI,CAAC;iBAClC,CAAC,CACH,CAAC,CAAC,CAAC,CAAC;YACP,CAAC;oBAAS,CAAC;gBACT,UAAU,CAAC,KAAK,EAAE,CAAC;YACrB,CAAC;QACH,CAAC,CACF,CAAC;IACJ,CAAC;IAED;;OAEG;IACM,KAAK,CAAyC;IAEvD;;;;OAIG;IACH,YAAY,IAA4C;QACtD,IAAI,CAAC,KAAK,GAAG,IAAI,YAAY,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC;IACjE,CAAC;IAED;;;;;;OAMG;IACH,IAAI,CAAC,MAAmB,EAAE,GAAG,IAAgB;QAC3C,OAAO,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,CAAC;IAClD,CAAC;IAED,eAAe;IAEf;;;;;OAKG;IACH,SAAS,CAAU,YAA2D;QAC5E,OAAO,YAAY,CAAC,IAAI,CAAC,CAAC;IAC5B,CAAC;IAED,qBAAqB;IAErB;;;;;;OAMG;IACH,YAAY,CACV,MAAuD;QAEvD,OAAO,IAAI,aAAa,CACtB,CAAC,MAAmB,EAAE,GAAG,IAAmB,EAAkC,EAAE;YAC9E,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,GAAG,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC;QAChD,CAAC,CACF,CAAC;IACJ,CAAC;IAmCD;;;;;;;;;;;;;;;;;OAiBG;IACH,IAAI,CACF,WAAW,GAEK,iDAAiD,EACjE,kBAAkB,GAEF,gDAAgD;QAEhE,OAAO,IAAI,aAAa,CACtB,CAAC,MAAmB,EAAE,GAAG,IAAgB,EAAuB,EAAE;YAChE,OAAO,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,IAAI,CAAC,CAAC,IAAI,CACpC,CAAC,KAAc,EAAwC,EAAE;gBACvD,OAAO,WAAW,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;YACpC,CAAC,EACD,CAAC,KAAc,EAAwC,EAAE;gBACvD,OAAO,kBAAkB,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;YAC3C,CAAC,CACF,CAAC;QACJ,CAAC,CACF,CAAC;IACJ,CAAC;IAkBD;;;;;;;;;;;;;;;;OAgBG;IACH,KAAK,CACH,kBAA+E;QAE/E,OAAO,IAAI,CAAC,IAAI,CACd,SAAS,EACT,kBAAqE,CACtE,CAAC;IACJ,CAAC;IAED,gBAAgB;IAEhB;;;;;;;;;;;;;;;;;;OAkBG;IACH,mBAAmB,CAAC,EAClB,YAAY,GAC2B;QAOvC,MAAM,GAAG,GAAuB,IAAI,GAAG,EAAiB,CAAC;QAEzD,OAAO,IAAI,aAAa,CACtB,KAAK,EAAE,MAAmB,EAAE,GAAG,IAAgB,EAAoB,EAAE;YACnE,MAAM,CAAC,cAAc,EAAE,CAAC;YAExB,MAAM,GAAG,GAAW,YAAY,CAAC,IAAI,CAAC,CAAC;YAEvC,IAAI,KAAK,GAAsB,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YAE5C,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;gBACxB,MAAM,UAAU,GAAoB,IAAI,eAAe,EAAE,CAAC;gBAC1D,KAAK,GAAG;oBACN,UAAU;oBACV,OAAO,EAAE,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,GAAG,IAAI,CAAC;oBAC9C,SAAS,EAAE,CAAC;iBACb,CAAC;gBACF,GAAG,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;YACtB,CAAC;iBAAM,CAAC;gBACN,KAAK,CAAC,SAAS,EAAE,CAAC;YACpB,CAAC;YAED,IAAI,CAAC;gBACH,OAAO,MAAM,QAAQ,CAAC,KAAK,CAAC,OAAO,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;YACnD,CAAC;oBAAS,CAAC;gBACT,KAAK,CAAC,SAAS,EAAE,CAAC;gBAElB,IAAI,KAAK,CAAC,SAAS,KAAK,CAAC,EAAE,CAAC;oBAC1B,KAAK,CAAC,UAAU,CAAC,KAAK,EAAE,CAAC;oBACzB,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;gBAClB,CAAC;YACH,CAAC;QACH,CAAC,CACF,CAAC;IACJ,CAAC;CACF"}
+{"version":3,"file":"async-function.js","sourceRoot":"","sources":["../../src/async-function.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAE3C,OAAO,EAA0B,MAAM,gCAAgC,CAAC;AACxE,OAAO,EAA0B,MAAM,gCAAgC,CAAC;AACxE,OAAO,EAAoC,MAAM,0EAA0E,CAAC;AAC5H,OAAO,EAA6C,MAAM,mEAAmE,CAAC;AAC9H,OAAO,EAA4C,MAAM,kEAAkE,CAAC;AAC5H,OAAO,EAAE,iDAAiD,EAAE,MAAM,mFAAmF,CAAC;AACtJ,OAAO,EAAE,gDAAgD,EAAE,MAAM,kFAAkF,CAAC;AACpJ,OAAO,EAAuC,MAAM,gEAAgE,CAAC;AACrH,OAAO,EAA+C,MAAM,8FAA8F,CAAC;AAE3J;;;;;GAKG;AACH,MAAM,OAAO,aAAa;IACxB;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,EAAE,CACP,KAA6C;QAE7C,OAAO,KAAK,YAAY,aAAa,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,aAAa,CAAsB,KAAK,CAAC,CAAC;IAChG,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,MAAM,CAAC,kBAAkB,CAAiD,EACxE,IAAI,EACJ,OAAO,GACqD;QAI5D,IAAI,GAAG,aAAa,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC;QAC9B,OAAO,GAAG,aAAa,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC;QAEpC,OAAO,IAAI,aAAa,CACtB,KAAK,EAAE,MAAmB,EAAE,GAAG,IAAgB,EAAoB,EAAE;YACnE,MAAM,UAAU,GAAoB,IAAI,eAAe,EAAE,CAAC;YAC1D,MAAM,YAAY,GAAgB,WAAW,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC;YAC/E,IAAI,CAAC;gBACH,OAAO,CACL,MAAM,OAAO,CAAC,GAAG,CAAC;oBAChB,OAAO,CAAC,KAAK,CAAC,YAAY,EAAE,GAAG,IAAI,CAAC;oBACpC,IAAI,CAAC,KAAK,CAAC,YAAY,EAAE,GAAG,IAAI,CAAC;iBAClC,CAAC,CACH,CAAC,CAAC,CAAC,CAAC;YACP,CAAC;oBAAS,CAAC;gBACT,UAAU,CAAC,KAAK,EAAE,CAAC;YACrB,CAAC;QACH,CAAC,CACF,CAAC;IACJ,CAAC;IAED;;OAEG;IACM,KAAK,CAAyC;IAEvD;;;;OAIG;IACH,YAAY,IAA4C;QACtD,IAAI,CAAC,KAAK,GAAG,IAAI,YAAY,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC;IACjE,CAAC;IAED;;;;;;OAMG;IACH,IAAI,CAAC,MAAmB,EAAE,GAAG,IAAgB;QAC3C,OAAO,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,CAAC;IAClD,CAAC;IAED,eAAe;IAEf;;;;;OAKG;IACH,SAAS,CAAU,YAA2D;QAC5E,OAAO,YAAY,CAAC,IAAI,CAAC,CAAC;IAC5B,CAAC;IAED,qBAAqB;IAErB;;;;;;OAMG;IACH,YAAY,CACV,MAAuD;QAEvD,OAAO,IAAI,aAAa,CACtB,CAAC,MAAmB,EAAE,GAAG,IAAmB,EAAkC,EAAE;YAC9E,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,GAAG,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC;QAChD,CAAC,CACF,CAAC;IACJ,CAAC;IAmCD;;;;;;;;;;;;;;;;;OAiBG;IACH,IAAI,CACF,WAAW,GAEK,iDAAiD,EACjE,kBAAkB,GAEF,gDAAgD;QAEhE,OAAO,IAAI,aAAa,CACtB,CAAC,MAAmB,EAAE,GAAG,IAAgB,EAAuB,EAAE;YAChE,OAAO,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,IAAI,CAAC,CAAC,IAAI,CACpC,CAAC,KAAc,EAAwC,EAAE;gBACvD,OAAO,WAAW,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;YACpC,CAAC,EACD,CAAC,KAAc,EAAwC,EAAE;gBACvD,OAAO,kBAAkB,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;YAC3C,CAAC,CACF,CAAC;QACJ,CAAC,CACF,CAAC;IACJ,CAAC;IAkBD;;;;;;;;;;;;;;;;OAgBG;IACH,KAAK,CACH,kBAA+E;QAE/E,OAAO,IAAI,CAAC,IAAI,CACd,SAAS,EACT,kBAAqE,CACtE,CAAC;IACJ,CAAC;IAED,gBAAgB;IAEhB;;;;;;;;;;;;;;;;;;OAkBG;IACH,oBAAoB,CAAC,EACnB,YAAY,GAC4B;QAOxC,MAAM,GAAG,GAAuB,IAAI,GAAG,EAAiB,CAAC;QAEzD,OAAO,IAAI,aAAa,CACtB,KAAK,EAAE,MAAmB,EAAE,GAAG,IAAgB,EAAoB,EAAE;YACnE,MAAM,CAAC,cAAc,EAAE,CAAC;YAExB,MAAM,GAAG,GAAW,YAAY,CAAC,IAAI,CAAC,CAAC;YAEvC,IAAI,KAAK,GAAsB,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YAE5C,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;gBACxB,MAAM,UAAU,GAAoB,IAAI,eAAe,EAAE,CAAC;gBAC1D,KAAK,GAAG;oBACN,UAAU;oBACV,OAAO,EAAE,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,GAAG,IAAI,CAAC;oBAC9C,SAAS,EAAE,CAAC;iBACb,CAAC;gBACF,GAAG,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;YACtB,CAAC;iBAAM,CAAC;gBACN,KAAK,CAAC,SAAS,EAAE,CAAC;YACpB,CAAC;YAED,IAAI,CAAC;gBACH,OAAO,MAAM,QAAQ,CAAC,KAAK,CAAC,OAAO,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;YACnD,CAAC;oBAAS,CAAC;gBACT,KAAK,CAAC,SAAS,EAAE,CAAC;gBAElB,IAAI,KAAK,CAAC,SAAS,KAAK,CAAC,EAAE,CAAC;oBAC1B,KAAK,CAAC,UAAU,CAAC,KAAK,EAAE,CAAC;oBACzB,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;gBAClB,CAAC;YACH,CAAC;QACH,CAAC,CACF,CAAC;IACJ,CAAC;CACF"}

package/src/index.d.ts

@@ -5,4 +5,4 @@ export * from './types/static-methods/from-send-and-receive/async-function-from-
 export * from './types/methods/transform/transform-async-function-function.ts';
 export * from './types/methods/then/async-function.then.on-fulfilled-function.ts';
 export * from './types/methods/then/async-function.then.on-rejected-function.ts';
-export * from './types/methods/share-concurent-calls/share-concurent-calls-options.ts';
+export * from './types/methods/share-concurrent-calls/share-concurrent-calls-options.ts';

package/src/index.js

@@ -5,5 +5,5 @@ export * from './types/static-methods/from-send-and-receive/async-function-from-
 export * from './types/methods/transform/transform-async-function-function.js';
 export * from './types/methods/then/async-function.then.on-fulfilled-function.js';
 export * from './types/methods/then/async-function.then.on-rejected-function.js';
-export * from './types/methods/share-concurent-calls/share-concurent-calls-options.js';
+export * from './types/methods/share-concurrent-calls/share-concurrent-calls-options.js';
 //# sourceMappingURL=index.js.map

package/src/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,qBAAqB,CAAC;AACpC,cAAc,gCAAgC,CAAC;AAC/C,cAAc,gCAAgC,CAAC;AAC/C,cAAc,8FAA8F,CAAC;AAC7G,cAAc,gEAAgE,CAAC;AAC/E,cAAc,mEAAmE,CAAC;AAClF,cAAc,kEAAkE,CAAC;AACjF,cAAc,wEAAwE,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,qBAAqB,CAAC;AACpC,cAAc,gCAAgC,CAAC;AAC/C,cAAc,gCAAgC,CAAC;AAC/C,cAAc,8FAA8F,CAAC;AAC7G,cAAc,gEAAgE,CAAC;AAC/E,cAAc,mEAAmE,CAAC;AAClF,cAAc,kEAAkE,CAAC;AACjF,cAAc,0EAA0E,CAAC"}

package/src/types/async-function-like.d.ts

@@ -1,3 +1,9 @@
 import { type AsyncFunction } from '../async-function.ts';
 import { type CallAsyncFunction } from './call-async-function.ts';
+/**
+ * Represents anything that can be wrapped into an `AsyncFunction`: either an existing `AsyncFunction` instance, or a plain call function.
+ *
+ * @template GArguments The tuple type representing the arguments to be provided to the function.
+ * @template GReturn The type of the value returned by the async function.
+ */
 export type AsyncFunctionLike<GArguments extends readonly unknown[], GReturn> = AsyncFunction<GArguments, GReturn> | CallAsyncFunction<GArguments, GReturn>;

package/src/types/methods/share-concurrent-calls/share-concurrent-calls-options.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Options for the `AsyncFunction.shareConcurrentCalls` method.
+ *
+ * @template GArguments The tuple type representing the arguments to be provided to the function.
+ */
+export interface ShareConcurrentCallsOptions<GArguments extends readonly unknown[]> {
+    /**
+     * Generates a cache key from the call's arguments. Concurrent calls producing the same key share their result.
+     */
+    readonly keyGenerator: ShareConcurrentCallsKeyGenerator<GArguments>;
+}
+/**
+ * Generates a cache key from the call's arguments.
+ *
+ * @template GArguments The tuple type representing the arguments to be provided to the function.
+ *
+ * @param {...GArguments} args The arguments to be provided to the function.
+ * @returns {string} The key identifying concurrent calls to share.
+ */
+export interface ShareConcurrentCallsKeyGenerator<GArguments extends readonly unknown[]> {
+    (args: GArguments): string;
+}

package/src/types/methods/share-concurrent-calls/share-concurrent-calls-options.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=share-concurrent-calls-options.js.map

package/src/types/methods/share-concurrent-calls/share-concurrent-calls-options.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"share-concurrent-calls-options.js","sourceRoot":"","sources":["../../../../../src/types/methods/share-concurrent-calls/share-concurrent-calls-options.ts"],"names":[],"mappings":""}

package/src/types/methods/then/async-function.then.on-fulfilled-function.d.ts

@@ -1,3 +1,13 @@
+/**
+ * Handles the resolved value of an async function call, like the first parameter of `Promise.then`.
+ *
+ * @template GReturn The type of the value resolved by the async function.
+ * @template GNewReturn The type of the value returned by the handler.
+ *
+ * @param {GReturn} value The value resolved by the async function.
+ * @param {AbortSignal} signal The `AbortSignal` received by the call, forwarded to the handler.
+ * @returns {PromiseLike<GNewReturn> | GNewReturn} The new value, or a promise of it.
+ */
 export interface AsyncFunctionThenOnFulfilledFunction<GReturn, GNewReturn> {
     (value: GReturn, signal: AbortSignal): PromiseLike<GNewReturn> | GNewReturn;
 }

package/src/types/methods/then/async-function.then.on-rejected-function.d.ts

@@ -1,3 +1,12 @@
+/**
+ * Handles the error thrown by an async function call, like the second parameter of `Promise.then`.
+ *
+ * @template GNewReturn The type of the value returned by the handler.
+ *
+ * @param {unknown} error The error thrown by the async function.
+ * @param {AbortSignal} signal The `AbortSignal` received by the call, forwarded to the handler.
+ * @returns {PromiseLike<GNewReturn> | GNewReturn} A fallback value, or a promise of it.
+ */
 export interface AsyncFunctionThenOnRejectedFunction<GNewReturn> {
     (error: unknown, signal: AbortSignal): PromiseLike<GNewReturn> | GNewReturn;
 }

package/src/types/methods/then/default.async-function.then.on-fulfilled-function.private.d.ts

@@ -1,2 +1,5 @@
 import { type AsyncFunctionThenOnFulfilledFunction } from './async-function.then.on-fulfilled-function.ts';
+/**
+ * Default fulfilment handler: passes the resolved value through unchanged.
+ */
 export declare const DEFAULT_ASYNC_FUNCTION_THEN_ON_FULFILLED_FUNCTION: AsyncFunctionThenOnFulfilledFunction<any, any>;

package/src/types/methods/then/default.async-function.then.on-fulfilled-function.private.js

@@ -1,3 +1,6 @@
 import {} from './async-function.then.on-fulfilled-function.js';
+/**
+ * Default fulfilment handler: passes the resolved value through unchanged.
+ */
 export const DEFAULT_ASYNC_FUNCTION_THEN_ON_FULFILLED_FUNCTION = (value) => value;
 //# sourceMappingURL=default.async-function.then.on-fulfilled-function.private.js.map

package/src/types/methods/then/default.async-function.then.on-fulfilled-function.private.js.map

@@ -1 +1 @@
-{"version":3,"file":"default.async-function.then.on-fulfilled-function.private.js","sourceRoot":"","sources":["../../../../../src/types/methods/then/default.async-function.then.on-fulfilled-function.private.ts"],"names":[],"mappings":"AAAA,OAAO,EAA6C,MAAM,gDAAgD,CAAC;AAE3G,MAAM,CAAC,MAAM,iDAAiD,GAAmD,CAC/G,KAAU,EACL,EAAE,CAAC,KAAK,CAAC"}
+{"version":3,"file":"default.async-function.then.on-fulfilled-function.private.js","sourceRoot":"","sources":["../../../../../src/types/methods/then/default.async-function.then.on-fulfilled-function.private.ts"],"names":[],"mappings":"AAAA,OAAO,EAA6C,MAAM,gDAAgD,CAAC;AAE3G;;GAEG;AACH,MAAM,CAAC,MAAM,iDAAiD,GAG1D,CAAC,KAAU,EAAO,EAAE,CAAC,KAAK,CAAC"}

package/src/types/methods/then/default.async-function.then.on-rejected-function.private.d.ts

@@ -1,2 +1,5 @@
 import { type AsyncFunctionThenOnRejectedFunction } from './async-function.then.on-rejected-function.ts';
+/**
+ * Default rejection handler: re-throws the received error.
+ */
 export declare const DEFAULT_ASYNC_FUNCTION_THEN_ON_REJECTED_FUNCTION: AsyncFunctionThenOnRejectedFunction<any>;

package/src/types/methods/then/default.async-function.then.on-rejected-function.private.js

@@ -1,4 +1,7 @@
 import {} from './async-function.then.on-rejected-function.js';
+/**
+ * Default rejection handler: re-throws the received error.
+ */
 export const DEFAULT_ASYNC_FUNCTION_THEN_ON_REJECTED_FUNCTION = (error) => {
     throw error;
 };

package/src/types/methods/then/default.async-function.then.on-rejected-function.private.js.map

@@ -1 +1 @@
-{"version":3,"file":"default.async-function.then.on-rejected-function.private.js","sourceRoot":"","sources":["../../../../../src/types/methods/then/default.async-function.then.on-rejected-function.private.ts"],"names":[],"mappings":"AAAA,OAAO,EAA4C,MAAM,+CAA+C,CAAC;AAEzG,MAAM,CAAC,MAAM,gDAAgD,GAA6C,CACxG,KAAU,EACL,EAAE;IACP,MAAM,KAAK,CAAC;AACd,CAAC,CAAC"}
+{"version":3,"file":"default.async-function.then.on-rejected-function.private.js","sourceRoot":"","sources":["../../../../../src/types/methods/then/default.async-function.then.on-rejected-function.private.ts"],"names":[],"mappings":"AAAA,OAAO,EAA4C,MAAM,+CAA+C,CAAC;AAEzG;;GAEG;AACH,MAAM,CAAC,MAAM,gDAAgD,GAEzD,CAAC,KAAU,EAAO,EAAE;IACtB,MAAM,KAAK,CAAC;AACd,CAAC,CAAC"}

package/src/types/methods/transform/transform-async-function-function.d.ts

@@ -1,4 +1,13 @@
 import { type AsyncFunction } from '../../../async-function.ts';
+/**
+ * Transforms an `AsyncFunction` instance into another value.
+ *
+ * @template GSelf The type of the `AsyncFunction` instance to transform.
+ * @template GReturn The type of the value returned by the transformation.
+ *
+ * @param {GSelf} self The `AsyncFunction` instance to transform.
+ * @returns {GReturn} The result of the transformation.
+ */
 export interface TransformAsyncFunctionFunction<GSelf extends AsyncFunction<any, any>, GReturn> {
     (self: GSelf): GReturn;
 }

package/src/types/static-methods/from-send-and-receive/async-function-from-send-and-receive-options.d.ts

@@ -1,5 +1,17 @@
 import { type AsyncFunctionLike } from '../../async-function-like.ts';
+/**
+ * Options for the `AsyncFunction.fromSendAndReceive` static method.
+ *
+ * @template GArguments The tuple type representing the arguments to be provided to the send and receive functions.
+ * @template GReturn The type of the value returned by the receive function.
+ */
 export interface AsyncFunctionFromSendAndReceiveOptions<GArguments extends readonly unknown[], GReturn> {
+    /**
+     * The "push" async function to trigger (e.g. sending a command or message). Must not return a value.
+     */
     readonly send: AsyncFunctionLike<GArguments, void>;
+    /**
+     * The "pull" async function to await (e.g. listening for a response or event). Returns the result.
+     */
     readonly receive: AsyncFunctionLike<GArguments, GReturn>;
 }

package/src/types/methods/share-concurent-calls/share-concurent-calls-options.d.ts

@@ -1,6 +0,0 @@
-export interface ShareConcurentCallsOptions<GArguments extends readonly unknown[]> {
-    readonly keyGenerator: ShareConcurentCallsKeyGenerator<GArguments>;
-}
-export interface ShareConcurentCallsKeyGenerator<GArguments extends readonly unknown[]> {
-    (args: GArguments): string;
-}

package/src/types/methods/share-concurent-calls/share-concurent-calls-options.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=share-concurent-calls-options.js.map

package/src/types/methods/share-concurent-calls/share-concurent-calls-options.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"share-concurent-calls-options.js","sourceRoot":"","sources":["../../../../../src/types/methods/share-concurent-calls/share-concurent-calls-options.ts"],"names":[],"mappings":""}