From 181af286689e0b42fcac115ace6541364a943af2 Mon Sep 17 00:00:00 2001 From: =?utf8?q?J=C3=A9r=C3=B4me=20Benoit?= Date: Wed, 1 May 2024 18:39:19 +0200 Subject: [PATCH] docs: refine code comments MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit Signed-off-by: Jérôme Benoit --- docs/api.md | 2 +- src/worker/task-functions.ts | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/api.md b/docs/api.md index db56dc43..dd9f833c 100644 --- a/docs/api.md +++ b/docs/api.md @@ -115,7 +115,7 @@ An object with these properties: - `runTime` (optional) - Use the tasks [simple moving median](./worker-choice-strategies.md#simple-moving-median) runtime instead of the tasks simple moving average runtime in worker choice strategies. - `waitTime` (optional) - Use the tasks [simple moving median](./worker-choice-strategies.md#simple-moving-median) wait time instead of the tasks simple moving average wait time in worker choice strategies. - `elu` (optional) - Use the tasks [simple moving median](./worker-choice-strategies.md#simple-moving-median) ELU instead of the tasks simple moving average ELU in worker choice strategies. - - `weights` (optional) - The worker weights to use in weighted round robin worker choice strategies: `{ 0: 200, 1: 300, ..., n: 100 }`. + - `weights` (optional) - The worker weights to use in weighted round robin worker choice strategies: `Record`. Default: `{ runTime: { median: false }, waitTime: { median: false }, elu: { median: false } }` diff --git a/src/worker/task-functions.ts b/src/worker/task-functions.ts index 8999b69d..0b3083c3 100644 --- a/src/worker/task-functions.ts +++ b/src/worker/task-functions.ts @@ -62,7 +62,7 @@ export interface TaskFunctionObject { /** * Tasks functions that can be executed. * The key is the name of the task function or task function object. - * The value is the function or task function object. + * The value is the task function or task function object. * * @typeParam Data - Type of data sent to the worker. This can only be structured-cloneable data. * @typeParam Response - Type of execution response. This can only be structured-cloneable data. -- 2.34.1