X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractWorker.html;h=489320bfd0ef992208723b7c0c4fcb2b9d9801e1;hb=76a3a76becd6ac41efb3271c708431a666828c30;hp=c17d1cd8cb88d494e5d56983b9ef2e5a5074c30c;hpb=da66e34cda2cbcb3a94865d24696c668f50a1437;p=poolifier.git diff --git a/docs/classes/AbstractWorker.html b/docs/classes/AbstractWorker.html index c17d1cd8..489320bf 100644 --- a/docs/classes/AbstractWorker.html +++ b/docs/classes/AbstractWorker.html @@ -1,4 +1,4 @@ -AbstractWorker | poolifier - v2.6.45
+AbstractWorker | poolifier - v2.7.1
  • Preparing search index...
  • -
  • The search index is not available
poolifier - v2.6.45
+
  • The search index is not available
  • poolifier - v2.7.1
    +
  • Defined in src/worker/abstract-worker.ts:79
  • id: number
    @@ -172,7 +171,7 @@
    +
  • Defined in src/worker/abstract-worker.ts:63
  • isMain: boolean
    @@ -180,7 +179,7 @@
    +
  • Defined in src/worker/abstract-worker.ts:91
  • lastTaskTimestamp: number
    @@ -188,7 +187,7 @@
    +
  • Defined in src/worker/abstract-worker.ts:71
  • mainWorker: MainWorker
    @@ -196,7 +195,7 @@
    +
  • Defined in src/worker/abstract-worker.ts:92
  • opts: WorkerOptions = DEFAULT_WORKER_OPTIONS
    @@ -204,7 +203,7 @@
    +
  • Defined in src/worker/abstract-worker.ts:94
  • statistics: WorkerStatistics
    @@ -212,7 +211,7 @@
    +
  • Defined in src/worker/abstract-worker.ts:75
  • taskFunctions: Map<string, TaskFunction<Data, Response>>
    @@ -220,13 +219,13 @@
    +
  • Defined in src/worker/abstract-worker.ts:67
  • Methods

      - +
    • Adds a task function to the worker. If a task function with the same name already exists, it is replaced.

      @@ -244,17 +243,11 @@ If a task function with the same name already exists, it is replaced.

      The task function to add.

    -

    Returns boolean

    Whether the task function was added or not.

    +

    Returns TaskFunctionOperationResult

    Whether the task function was added or not.

    -
    -

    Throws

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

    - -

    Throws

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

    - -

    Throws

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

    -
    +
  • Defined in src/worker/abstract-worker.ts:179
  • Returns TaskPerformance

    +
  • Defined in src/worker/abstract-worker.ts:587
  • +
  • Defined in src/worker/abstract-worker.ts:439
  • +
  • Defined in src/worker/abstract-worker.ts:405
  • -
    - -
    +
  • Defined in src/worker/abstract-worker.ts:611
  • -
    - -
    +
  • Defined in src/worker/abstract-worker.ts:118
  • Returns void

    +
  • Defined in src/worker/abstract-worker.ts:108
  • Returns TaskPerformance

    +
  • Defined in src/worker/abstract-worker.ts:596
  • +
  • Defined in src/worker/abstract-worker.ts:454
  • +
  • Defined in src/worker/abstract-worker.ts:485
  • +
  • Defined in src/worker/abstract-worker.ts:371
  • +
  • Defined in src/worker/abstract-worker.ts:299
  • +
    + +
    -

    Returns boolean

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

    +

    Returns TaskFunctionOperationResult

    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:162
  • +
    +
    +
  • Defined in src/worker/abstract-worker.ts:243
  • +
  • Defined in src/worker/abstract-worker.ts:306
  • -

    Returns boolean

    Whether the task function existed and was removed or not.

    - -
    -

    Throws

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

    +

    Returns TaskFunctionOperationResult

    Whether the task function existed and was removed or not.

    -

    Throws

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

    - -

    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:214
  • 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:494
  • +
  • Defined in src/worker/abstract-worker.ts:555
  • -
    - +
  • Defined in src/worker/abstract-worker.ts:521
  • +
    +
    +
  • Defined in src/worker/abstract-worker.ts:473
  • +
  • Defined in src/worker/abstract-worker.ts:466
  • -

    Returns boolean

    Whether the default task function was set or not.

    +

    Returns TaskFunctionOperationResult

    Whether the default task function was set or not.

    -
    -

    Throws

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

    - -

    Throws

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

    - -

    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:270
  • +
  • Defined in src/worker/abstract-worker.ts:418
  • +
  • Defined in src/worker/abstract-worker.ts:429
  • +
  • Defined in src/worker/abstract-worker.ts:617