X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractWorker.html;h=e72a60c2a90e28cd0ac1ec38c2ba99111b7e170c;hb=447eca603b96bc46303dfa16f3048b68ae576b0c;hp=597f0599a8fc4fae1c16ea37feed4727024bb63a;hpb=2de80350c43436f87fca7de401d213c0d93fe208;p=poolifier.git diff --git a/docs/classes/AbstractWorker.html b/docs/classes/AbstractWorker.html index 597f0599..e72a60c2 100644 --- a/docs/classes/AbstractWorker.html +++ b/docs/classes/AbstractWorker.html @@ -1,4 +1,4 @@ -AbstractWorker | poolifier - v2.6.45
+AbstractWorker | poolifier - v2.7.0
  • Preparing search index...
  • -
  • The search index is not available
poolifier - v2.6.45
+
  • The search index is not available
  • poolifier - v2.7.0
    +
  • Defined in src/worker/abstract-worker.ts:74
  • id: number
    @@ -172,7 +173,7 @@
    +
  • Defined in src/worker/abstract-worker.ts:58
  • isMain: boolean
    @@ -180,7 +181,7 @@
    +
  • Defined in src/worker/abstract-worker.ts:86
  • lastTaskTimestamp: number
    @@ -188,7 +189,7 @@
    +
  • Defined in src/worker/abstract-worker.ts:66
  • mainWorker: MainWorker
    @@ -196,7 +197,7 @@
    +
  • Defined in src/worker/abstract-worker.ts:87
  • opts: WorkerOptions = DEFAULT_WORKER_OPTIONS
    @@ -204,7 +205,7 @@
    +
  • Defined in src/worker/abstract-worker.ts:89
  • statistics: WorkerStatistics
    @@ -212,7 +213,7 @@
    +
  • Defined in src/worker/abstract-worker.ts:70
  • taskFunctions: Map<string, TaskFunction<Data, Response>>
    @@ -220,13 +221,13 @@
    +
  • Defined in src/worker/abstract-worker.ts:62
  • Methods

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

      @@ -244,17 +245,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:221
  • Returns TaskPerformance

    +
  • Defined in src/worker/abstract-worker.ts:632
  • +
  • Defined in src/worker/abstract-worker.ts:483
  • +
  • Defined in src/worker/abstract-worker.ts:449
  • +
  • Defined in src/worker/abstract-worker.ts:656
  • Returns void

    +
  • Defined in src/worker/abstract-worker.ts:336
  • +
  • Defined in src/worker/abstract-worker.ts:160
  • Returns void

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

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

    +
  • Defined in src/worker/abstract-worker.ts:641
  • +
  • Defined in src/worker/abstract-worker.ts:498
  • +
  • Defined in src/worker/abstract-worker.ts:529
  • +
  • Defined in src/worker/abstract-worker.ts:415
  • +
  • Defined in src/worker/abstract-worker.ts:350
  • +
    + +
    -

    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:204
  • +
    +
    +
  • Defined in src/worker/abstract-worker.ts:285
  • +
  • Defined in src/worker/abstract-worker.ts:357
  • -

    Returns boolean

    Whether the task function existed and was removed or not.

    +

    Returns TaskFunctionOperationResult

    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.

    - -

    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:256
  • +
  • Defined in src/worker/abstract-worker.ts:539
  • +
  • Defined in src/worker/abstract-worker.ts:600
  • -
    - +
  • Defined in src/worker/abstract-worker.ts:566
  • +
    +
    +
  • Defined in src/worker/abstract-worker.ts:517
  • +
  • Defined in src/worker/abstract-worker.ts:510
  • -

    Returns boolean

    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.

    +

    Returns TaskFunctionOperationResult

    Whether the default task function was set 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 a non-existing task function.

    -
    +
  • Defined in src/worker/abstract-worker.ts:312
  • +
  • Defined in src/worker/abstract-worker.ts:462
  • +
  • Defined in src/worker/abstract-worker.ts:473
  • +
  • Defined in src/worker/abstract-worker.ts:662