X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractWorker.html;h=e72a60c2a90e28cd0ac1ec38c2ba99111b7e170c;hb=447eca603b96bc46303dfa16f3048b68ae576b0c;hp=84fd102e762555d9ae11b48f168441ddfc2092d4;hpb=ff6cf64964e78aafa95098852ec0472b567f7b1b;p=poolifier.git diff --git a/docs/classes/AbstractWorker.html b/docs/classes/AbstractWorker.html index 84fd102e..e72a60c2 100644 --- a/docs/classes/AbstractWorker.html +++ b/docs/classes/AbstractWorker.html @@ -1,13 +1,13 @@ -AbstractWorker | poolifier - v2.6.26
+AbstractWorker | poolifier - v2.7.0
-
+
  • The search index is not available
  • poolifier - v2.7.0 +
    @@ -47,19 +47,19 @@
  • ClusterWorker
  • ThreadWorker
  • +
  • Defined in src/worker/abstract-worker.ts:50
  • - +
    +
  • Defined in src/worker/abstract-worker.ts:84
  • Properties

    @@ -162,7 +165,7 @@
    +
  • Defined in src/worker/abstract-worker.ts:74
  • id: number
    @@ -170,7 +173,7 @@
    +
  • Defined in src/worker/abstract-worker.ts:58
  • isMain: boolean
    @@ -178,7 +181,7 @@
    +
  • Defined in src/worker/abstract-worker.ts:86
  • lastTaskTimestamp: number
    @@ -186,7 +189,7 @@
    +
  • Defined in src/worker/abstract-worker.ts:66
  • mainWorker: MainWorker
    @@ -194,15 +197,15 @@
    +
  • Defined in src/worker/abstract-worker.ts:87
  • - -
    opts: WorkerOptions = ...
    + +
    opts: WorkerOptions = DEFAULT_WORKER_OPTIONS

    Options for the worker.

    +
  • Defined in src/worker/abstract-worker.ts:89
  • statistics: WorkerStatistics
    @@ -210,7 +213,7 @@
    +
  • Defined in src/worker/abstract-worker.ts:70
  • taskFunctions: Map<string, TaskFunction<Data, Response>>
    @@ -218,13 +221,13 @@
    +
  • Defined in src/worker/abstract-worker.ts:62
  • 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:221
  • +
  • Defined in node_modules/.pnpm/@types+node@20.6.2/node_modules/@types/node/async_hooks.d.ts:307
  • Returns TaskPerformance

    +
  • Defined in src/worker/abstract-worker.ts:632
  • +
  • Defined in node_modules/.pnpm/@types+node@20.6.2/node_modules/@types/node/async_hooks.d.ts:284
  • +
  • Defined in src/worker/abstract-worker.ts:483
  • +
    + +
    +
  • Defined in src/worker/abstract-worker.ts:656
  • +
    + +
    +
  • Defined in src/worker/abstract-worker.ts:160
  • +
    + +

    Returns void

    +
  • Defined in src/worker/abstract-worker.ts:102
  • +
  • Defined in node_modules/.pnpm/@types+node@20.6.2/node_modules/@types/node/async_hooks.d.ts:303
  • 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.

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

    - -
    -

    Throws

    https://nodejs.org/api/errors.html#class-typeerror If the name parameter is not a 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:256
  • +
  • Defined in src/worker/abstract-worker.ts:539
  • +
  • Defined in src/worker/abstract-worker.ts:600
  • +
  • Defined in node_modules/.pnpm/@types+node@20.6.2/node_modules/@types/node/async_hooks.d.ts:295
  • -
    - +
  • 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.

    - -

    Throws

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

    +

    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 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 node_modules/.pnpm/@types+node@20.6.2/node_modules/@types/node/async_hooks.d.ts:312
  • +
  • Defined in src/worker/abstract-worker.ts:662
  • +
  • Defined in node_modules/.pnpm/@types+node@20.6.2/node_modules/@types/node/async_hooks.d.ts:278
  • @@ -845,25 +870,28 @@ then restore the original execution context.

  • beginTaskPerformance
  • bind
  • checkActive
  • +
  • checkMessageWorkerId
  • checkStatistics
  • +
  • checkTaskFunctionName
  • checkTaskFunctions
  • +
  • checkValidTaskFunctionEntry
  • 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 +900,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