X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractWorker.html;h=14a7e7012a913a914fa910015ce6d2ab9639cee5;hb=cf02ff9e146e22a2f99a6af35de7ce49efd4c6b5;hp=751ee0d79bfd47a69b5aa244f06b8d35f298dcb0;hpb=f7d06005106fbf8e845731e6652dd676b765f60e;p=poolifier.git diff --git a/docs/classes/AbstractWorker.html b/docs/classes/AbstractWorker.html index 751ee0d7..14a7e701 100644 --- a/docs/classes/AbstractWorker.html +++ b/docs/classes/AbstractWorker.html @@ -1,13 +1,13 @@ -AbstractWorker | poolifier - v2.6.27
+AbstractWorker | poolifier - v2.7.4
-
+
  • The search index is not available
  • poolifier - v2.7.4 +
    @@ -47,19 +47,19 @@
  • ClusterWorker
  • ThreadWorker
  • +
  • Defined in src/worker/abstract-worker.ts:55
  • - +

    Constructors

    -

    Properties

    -

    Methods

    - @@ -152,7 +153,7 @@
    +
  • Defined in src/worker/abstract-worker.ts:89
  • Properties

    @@ -162,7 +163,7 @@
    +
  • Defined in src/worker/abstract-worker.ts:79
  • id: number
    @@ -170,7 +171,7 @@
    +
  • Defined in src/worker/abstract-worker.ts:63
  • isMain: boolean
    @@ -178,7 +179,7 @@
    +
  • Defined in src/worker/abstract-worker.ts:91
  • lastTaskTimestamp: number
    @@ -186,7 +187,7 @@
    +
  • Defined in src/worker/abstract-worker.ts:71
  • mainWorker: MainWorker
    @@ -194,15 +195,15 @@
    +
  • Defined in src/worker/abstract-worker.ts:92
  • - -
    opts: WorkerOptions = ...
    + +
    opts: WorkerOptions = DEFAULT_WORKER_OPTIONS

    Options for the worker.

    +
  • Defined in src/worker/abstract-worker.ts:94
  • statistics: WorkerStatistics
    @@ -210,7 +211,7 @@
    +
  • Defined in src/worker/abstract-worker.ts:75
  • taskFunctions: Map<string, TaskFunction<Data, Response>>
    @@ -218,13 +219,13 @@
    +
  • Defined in src/worker/abstract-worker.ts:67
  • Methods

    -

    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.

    - -

    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
  • +
  • Defined in node_modules/.pnpm/@types+node@20.6.5/node_modules/@types/node/async_hooks.d.ts:315
  • Returns TaskPerformance

    +
  • Defined in src/worker/abstract-worker.ts:587
  • +
  • Defined in node_modules/.pnpm/@types+node@20.6.5/node_modules/@types/node/async_hooks.d.ts:288
  • +
  • Defined in src/worker/abstract-worker.ts:439
  • +
    + +
    +
  • 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
  • +
  • Defined in node_modules/.pnpm/@types+node@20.6.5/node_modules/@types/node/async_hooks.d.ts:311
  • 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.

    -
    -
    - +
  • 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.

    +

    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.

    - -

    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 node_modules/.pnpm/@types+node@20.6.5/node_modules/@types/node/async_hooks.d.ts:299
  • -
    - +
  • 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.

    - -
    -

    Throws

    https://nodejs.org/api/errors.html#class-typeerror If the name parameter is not a 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:270
  • +
  • Defined in src/worker/abstract-worker.ts:418
  • +
  • Defined in src/worker/abstract-worker.ts:429
  • +
  • Defined in node_modules/.pnpm/@types+node@20.6.5/node_modules/@types/node/async_hooks.d.ts:319
  • +
  • Defined in src/worker/abstract-worker.ts:617
  • +
  • Defined in node_modules/.pnpm/@types+node@20.6.5/node_modules/@types/node/async_hooks.d.ts:278
  • @@ -845,25 +838,26 @@ then restore the original execution context.

  • beginTaskPerformance
  • bind
  • checkActive
  • +
  • checkMessageWorkerId
  • checkStatistics
  • checkTaskFunctions
  • checkWorkerOptions
  • emitDestroy
  • endTaskPerformance
  • getMainWorker
  • -
  • getTaskFunction
  • handleError
  • handleKillMessage
  • handleReadyMessage
  • +
  • handleTaskFunctionOperationMessage
  • hasTaskFunction
  • -
  • listTaskFunctions
  • +
  • listTaskFunctionNames
  • messageListener
  • removeTaskFunction
  • run
  • runAsync
  • runInAsyncScope
  • runSync
  • -
  • sendTaskFunctionsListToMainWorker
  • +
  • sendTaskFunctionNamesToMainWorker
  • sendToMainWorker
  • setDefaultTaskFunction
  • startCheckActive
  • @@ -872,68 +866,30 @@ then restore the original execution context.

  • updateLastTaskTimestamp
  • bind
  • +
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Generated using TypeDoc

    +
    \ No newline at end of file