X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractWorker.html;h=50ac5c495c6477a8c881eac8d0e9436004fc0648;hb=cc35cd9cb7323e39c9f521cdd4fbf51d1d31bbdf;hp=88e8a56fde382d17b326ad6e42a65746d344419f;hpb=953288ed6e2b952fb17b6fb0ebc4188ce813d53b;p=poolifier.git diff --git a/docs/classes/AbstractWorker.html b/docs/classes/AbstractWorker.html index 88e8a56f..50ac5c49 100644 --- a/docs/classes/AbstractWorker.html +++ b/docs/classes/AbstractWorker.html @@ -1,4 +1,4 @@ -AbstractWorker | poolifier - v2.6.31
+AbstractWorker | poolifier - v2.6.40
  • Preparing search index...
  • -
  • The search index is not available
poolifier - v2.6.31
+
  • The search index is not available
  • poolifier - v2.6.40
  • isMain: boolean

    Whether this is the main worker or not.

    -
    -
  • +
  • mainWorker: MainWorker

    Reference to main worker.

    -
    -
  • +
  • taskFunctions: TaskFunction<Data, Response> | TaskFunctions<Data, Response>

    Task function(s) processed by the worker when the pool's execution function is invoked. The first function is the default function.

    -
    -
  • +
  • opts: WorkerOptions = DEFAULT_WORKER_OPTIONS

    Options for the worker.

    -
    -
  • +

    Returns AbstractWorker<MainWorker, Data, Response>

    +
  • Defined in src/worker/abstract-worker.ts:83
  • Properties

    @@ -164,7 +159,7 @@
    +
  • Defined in src/worker/abstract-worker.ts:73
  • id: number
    @@ -172,7 +167,7 @@
    +
  • Defined in src/worker/abstract-worker.ts:57
  • isMain: boolean
    @@ -180,7 +175,7 @@
    +
  • Defined in src/worker/abstract-worker.ts:85
  • lastTaskTimestamp: number
    @@ -188,7 +183,7 @@
    +
  • Defined in src/worker/abstract-worker.ts:65
  • mainWorker: MainWorker
    @@ -196,7 +191,7 @@
    +
  • Defined in src/worker/abstract-worker.ts:86
  • opts: WorkerOptions = DEFAULT_WORKER_OPTIONS
    @@ -204,7 +199,7 @@
    +
  • Defined in src/worker/abstract-worker.ts:88
  • statistics: WorkerStatistics
    @@ -212,7 +207,7 @@
    +
  • Defined in src/worker/abstract-worker.ts:69
  • taskFunctions: Map<string, TaskFunction<Data, Response>>
    @@ -220,7 +215,7 @@
    +
  • Defined in src/worker/abstract-worker.ts:61
  • Methods

    @@ -237,13 +232,11 @@ If a task function with the same name already exists, it is replaced.

  • name: string

    The name of the task function to add.

    -
    -
  • +
  • fn: TaskFunction<Data, Response>

    The task function to add.

    -
    -
  • +

    Returns boolean

    Whether the task function was added or not.

    @@ -254,7 +247,7 @@ If a task function with the same name already exists, it is replaced.

    Throws

    https://nodejs.org/api/errors.html#class-typeerror If the fn parameter is not a function.

    +
  • Defined in src/worker/abstract-worker.ts:193
  • +
  • Defined in node_modules/.pnpm/@types+node@20.5.7/node_modules/@types/node/async_hooks.d.ts:306
  • Returns TaskPerformance

    +
  • Defined in src/worker/abstract-worker.ts:576
  • +

    Returns Func

    Since

    v14.8.0, v12.19.0

    +
  • Defined in node_modules/.pnpm/@types+node@20.5.7/node_modules/@types/node/async_hooks.d.ts:283
  • +
  • Defined in src/worker/abstract-worker.ts:419
  • +

    Returns void

    Throws

    https://nodejs.org/api/errors.html#class-error If the message worker id is not set or does not match the worker id.

    +
  • Defined in src/worker/abstract-worker.ts:385
  • +
  • Defined in src/worker/abstract-worker.ts:600
  • Returns void

    +
  • Defined in src/worker/abstract-worker.ts:308
  • +

    Returns void

    +
  • Defined in src/worker/abstract-worker.ts:132
  • +
    + +

    Returns void

    +
  • Defined in src/worker/abstract-worker.ts:101
  • +
  • Defined in node_modules/.pnpm/@types+node@20.5.7/node_modules/@types/node/async_hooks.d.ts:302
  • Returns TaskPerformance

    +
  • Defined in src/worker/abstract-worker.ts:585
  • -
    - -
    +
  • Defined in src/worker/abstract-worker.ts:434
  • +

    Returns string

    The error message.

    +
  • Defined in src/worker/abstract-worker.ts:466
  • +

    Returns void

    +
  • Defined in src/worker/abstract-worker.ts:351
  • +

    Returns void

    +
  • Defined in src/worker/abstract-worker.ts:322
  • +

    Returns boolean

    Whether the worker has a task function with the given name or not.

    Throws

    https://nodejs.org/api/errors.html#class-typeerror If the name parameter is not a string or an empty string.

    +
  • Defined in src/worker/abstract-worker.ts:177
  • +
  • Defined in src/worker/abstract-worker.ts:255
  • +

    Returns void

    +
  • Defined in src/worker/abstract-worker.ts:329
  • +

    Returns boolean

    Whether the task function existed and was removed or not.

    @@ -590,7 +569,7 @@ never be called.

    Throws

    https://nodejs.org/api/errors.html#class-error If the name parameter is the task function used as default task function.

    +
  • Defined in src/worker/abstract-worker.ts:231
  • +

    Returns void

    Throws

    https://nodejs.org/api/errors.html#class-error If the task function is not found.

    +
  • Defined in src/worker/abstract-worker.ts:476
  • +

    Returns void

    +
  • Defined in src/worker/abstract-worker.ts:541
  • Optional thisArg: This

    The receiver to be used for the function call.

    -
    -
  • +Optional
  • Rest ...args: any[]

    Optional arguments to pass to the function.

    -
    -
  • +Rest

    Returns Result

    Since

    v9.6.0

    +
  • Defined in node_modules/.pnpm/@types+node@20.5.7/node_modules/@types/node/async_hooks.d.ts:294
  • +

    Returns void

    +
  • Defined in src/worker/abstract-worker.ts:504
  • +
  • Defined in src/worker/abstract-worker.ts:453
  • +

    Returns void

    +
  • Defined in src/worker/abstract-worker.ts:446
  • +

    Returns boolean

    Whether the default task function was set or not.

    @@ -770,7 +739,7 @@ then restore the original execution context.

    Throws

    https://nodejs.org/api/errors.html#class-error If the name parameter is a non-existing task function.

    +
  • Defined in src/worker/abstract-worker.ts:285
  • +
  • Defined in src/worker/abstract-worker.ts:398
  • +
  • Defined in src/worker/abstract-worker.ts:409
  • +
  • Defined in node_modules/.pnpm/@types+node@20.5.7/node_modules/@types/node/async_hooks.d.ts:311
  • +
  • Defined in src/worker/abstract-worker.ts:606
  • +
    Optional thisArg: ThisArg
    Optional

    Returns Func

    Since

    v14.8.0, v12.19.0

    +
  • Defined in node_modules/.pnpm/@types+node@20.5.7/node_modules/@types/node/async_hooks.d.ts:277
  • -

    Generated using TypeDoc

    +

    Generated using TypeDoc

    \ No newline at end of file