X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractWorker.html;h=3c5b2f57ba336827c80081106b2c4b0ccba0f6c7;hb=a09a79a68dbaf04a9dff2f9d9dcc37da8c7dd314;hp=62f7d94901cc2f0b0b9ccd452e677c4dd6ca427d;hpb=4608939f425568da5553db1f5bf883d4cca18e02;p=poolifier.git diff --git a/docs/classes/AbstractWorker.html b/docs/classes/AbstractWorker.html index 62f7d949..3c5b2f57 100644 --- a/docs/classes/AbstractWorker.html +++ b/docs/classes/AbstractWorker.html @@ -1,4 +1,4 @@ -AbstractWorker | poolifier - v2.6.45
+AbstractWorker | poolifier - v3.0.5
  • Preparing search index...
  • -
  • The search index is not available
poolifier - v2.6.45
+
  • The search index is not available
  • poolifier - v3.0.5
    +
  • 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
  • +
  • Defined in node_modules/.pnpm/@types+node@20.8.9/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.8.9/node_modules/@types/node/async_hooks.d.ts:288
  • +
  • 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
  • +
  • Defined in node_modules/.pnpm/@types+node@20.8.9/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
  • Returns void

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

    - -

    Throws

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

    +

    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 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.8.9/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 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: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.8.9/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.8.9/node_modules/@types/node/async_hooks.d.ts:278
  • @@ -878,9 +837,7 @@ then restore the original execution context.

  • checkActive
  • checkMessageWorkerId
  • checkStatistics
  • -
  • checkTaskFunctionName
  • checkTaskFunctions
  • -
  • checkValidTaskFunction
  • checkWorkerOptions
  • emitDestroy
  • endTaskPerformance
  • @@ -888,15 +845,16 @@ then restore the original execution context.

  • handleError
  • handleKillMessage
  • handleReadyMessage
  • +
  • handleTaskFunctionOperationMessage
  • hasTaskFunction
  • -
  • listTaskFunctions
  • +
  • listTaskFunctionNames
  • messageListener
  • removeTaskFunction
  • run
  • runAsync
  • runInAsyncScope
  • runSync
  • -
  • sendTaskFunctionsListToMainWorker
  • +
  • sendTaskFunctionNamesToMainWorker
  • sendToMainWorker
  • setDefaultTaskFunction
  • startCheckActive
  • @@ -905,7 +863,7 @@ then restore the original execution context.

  • updateLastTaskTimestamp
  • bind
  • Generated using TypeDoc

    -
    \ No newline at end of file +
    \ No newline at end of file