docs: refine code documentation

Signed-off-by: Jérôme Benoit <jerome.benoit@piment-noir.org>

Author: jerome-benoit

.github/workflows/combine-prs.yml

@@ -3,7 +3,7 @@ name: Combine PRs
 on:
   workflow_dispatch:
   schedule:
-    - cron: '0 2 * * *'
+    - cron: '0 1 * * *'
 
 permissions:
   contents: write

README.md

@@ -21,7 +21,7 @@
 [![Javascript Standard Style Guide](<https://badgen.net/static/code style/standard/green>)](https://standardjs.com)
 [![Discord](https://badgen.net/discord/online-members/vXxZhyb3b6?icon=discord&label=discord&color=green)](https://discord.gg/vXxZhyb3b6)
 [![Open Collective](https://opencollective.com/poolifier/tiers/badge.svg)](https://opencollective.com/poolifier)
-[![PRs Welcome](https://badgen.net/static/PRs/welcome/green)](http://makeapullrequest.com)
+[![PRs Welcome](https://badgen.net/static/PRs/welcome/green)](https://makeapullrequest.com)
 [![No Dependencies](<https://badgen.net/static/dependencies/no dependencies/green>)](https://badgen.net/static/dependencies/nodependencies/green)
 
 </div>
@@ -38,34 +38,34 @@ Moreover you can execute your tasks using an API designed to improve the
 **developer experience**.\
 Please consult our [general guidelines](#general-guidelines).
 
-- Easy to use :white_check_mark:
-- Fixed and dynamic pool size :white_check_mark:
-- Easy switch from a pool type to another :white_check_mark:
-- Performance [benchmarks](./benchmarks/README.md) :white_check_mark:
-- No runtime dependencies :white_check_mark:
+- Easy to use ✔
+- Fixed and dynamic pool size ✔
+- Easy switch from a pool type to another ✔
+- Performance [benchmarks](./benchmarks/README.md) ✔
+- No runtime dependencies ✔
 
 <!-- - Proper integration with Deno
-  [async_hooks](https://nodejs.org/api/async_hooks.html) :white_check_mark: -->
+  [async_hooks](https://nodejs.org/api/async_hooks.html) ✔ -->
 
-- Support for ESM and TypeScript :white_check_mark:
+- Support for ESM and TypeScript ✔
 - Support for
   [web worker API](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API)
-  Deno module :white_check_mark:
-- Support for multiple task functions :white_check_mark:
+  Deno module ✔
+- Support for multiple task functions ✔
 - Support for task functions
   [CRUD](https://en.wikipedia.org/wiki/Create,_read,_update_and_delete)
-  operations at runtime :white_check_mark:
-- Support for sync and async task functions :white_check_mark:
-- Tasks distribution strategies :white_check_mark:
-- Lockless tasks queueing :white_check_mark:
+  operations at runtime ✔
+- Support for sync and async task functions ✔
+- Tasks distribution strategies ✔
+- Lockless tasks queueing ✔
 - Queued tasks rescheduling:
-  - Task stealing on empty queue :white_check_mark:
-  - Tasks stealing under back pressure :white_check_mark:
-  - Tasks redistribution on worker error :white_check_mark:
-- General guidelines on pool choice :white_check_mark:
-- Error handling out of the box :white_check_mark:
-- Widely tested :white_check_mark:
-- Active community :white_check_mark:
+  - Task stealing on empty queue ✔
+  - Tasks stealing under back pressure ✔
+  - Tasks redistribution on worker error ✔
+- General guidelines on pool choice ✔
+- Error handling out of the box ✔
+- Widely tested ✔
+- Active community ✔
 
 <!-- - Code quality [![Bugs](https://sonarcloud.io/api/project_badges/measure?project=pioardi_poolifier&metric=bugs)](https://sonarcloud.io/dashboard?id=pioardi_poolifier)
   [![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=pioardi_poolifier&metric=code_smells)](https://sonarcloud.io/dashboard?id=pioardi_poolifier)

benchmarks/benchmarks-utils.mjs

@@ -160,7 +160,7 @@ export const runPoolifierPoolBenchmark = async (
   })
 }
 
-export const LIST_FORMATTER = new Intl.ListFormat('en-US', {
+const LIST_FORMATTER = new Intl.ListFormat('en-US', {
   style: 'long',
   type: 'conjunction',
 })

docs/api.md

@@ -207,7 +207,7 @@ An object with these properties:
 
 - `workerOptions` (optional) - An object with the worker options to pass to
   worker. See
-  [worker_threads](https://nodejs.org/api/worker_threads.html#worker_threads_new_worker_filename_options)
+  [web worker](https://developer.mozilla.org/en-US/docs/Web/API/Worker/Worker#options)
   for more details.
 
 ## Worker

src/pools/abstract-pool.ts

@@ -490,7 +490,7 @@ export abstract class AbstractPool<
    * Checks if the worker id sent in the received message from a worker is valid.
    *
    * @param message - The received message.
-   * @throws {@link https://nodejs.org/api/errors.html#class-error} If the worker id is invalid.
+   * @throws {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error} If the worker id is invalid.
    */
   private checkMessageWorkerId(message: MessageValue<Data | Response>): void {
     if (message.workerId == null) {
@@ -1604,7 +1604,7 @@ export abstract class AbstractPool<
    *
    * @param worker - The worker.
    * @returns The added worker node key.
-   * @throws {@link https://nodejs.org/api/errors.html#class-error} If the added worker node is not found.
+   * @throws {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error} If the added worker node is not found.
    */
   private addWorkerNode(worker: Worker): number {
     const workerNode = new WorkerNode<Worker, Data>(

src/pools/pool.ts

@@ -260,8 +260,8 @@ export interface IPool<
    * @param name - The name of the task function.
    * @param fn - The task function.
    * @returns `true` if the task function was added, `false` otherwise.
-   * @throws {@link https://nodejs.org/api/errors.html#class-typeerror} If the `name` parameter is not a string or an empty string.
-   * @throws {@link https://nodejs.org/api/errors.html#class-typeerror} If the `fn` parameter is not a function.
+   * @throws {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypeError} If the `name` parameter is not a string or an empty string.
+   * @throws {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypeError} If the `fn` parameter is not a function.
    */
   readonly addTaskFunction: (
     name: string,

src/pools/selection-strategies/worker-choice-strategy-context.ts

@@ -170,7 +170,7 @@ export class WorkerChoiceStrategyContext<
    * Executes the worker choice strategy in the context algorithm.
    *
    * @returns The key of the worker node.
-   * @throws {@link https://nodejs.org/api/errors.html#class-error} If after configured retries the worker node key is null or undefined .
+   * @throws {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error} If after configured retries the worker node key is null or undefined .
    */
   public execute(): number {
     const workerNodeKey = (

src/pools/thread/fixed.ts

@@ -10,7 +10,7 @@ export interface ThreadPoolOptions<Data = unknown> extends PoolOptions<Data> {
   /**
    * Worker options.
    *
-   * @see https://nodejs.org/api/worker_threads.html#new-workerfilename-options
+   * @see https://developer.mozilla.org/en-US/docs/Web/API/Worker/Worker#options
    */
   workerOptions?: WorkerOptions
 }

src/worker/abstract-worker.ts

@@ -395,7 +395,7 @@ export abstract class AbstractWorker<
    * Check if the message worker id is set and matches the worker id.
    *
    * @param message - The message to check.
-   * @throws {@link https://nodejs.org/api/errors.html#class-error} If the message worker id is not set or does not match the worker id.
+   * @throws {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error} If the message worker id is not set or does not match the worker id.
    */
   private checkMessageWorkerId(message: MessageValue<Data>): void {
     if (message.workerId == null) {
@@ -444,7 +444,7 @@ export abstract class AbstractWorker<
    * Returns the main worker.
    *
    * @returns Reference to the main worker.
-   * @throws {@link https://nodejs.org/api/errors.html#class-error} If the main worker is not set.
+   * @throws {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error} If the main worker is not set.
    */
   protected getMainWorker(): MainWorker {
     if (this.mainWorker == null) {