X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractWorker.html;h=e75fee8f4ccdbae38510e1a4755788b16ce7892b;hb=31542ddfe8297d3bd0f9cf97a3de06a03dafc15d;hp=6ecd85f062a20f06edbed633a0c88ae250e2e1c5;hpb=120c7852afd1ce4c01bd7e70cd14eeeedda8c1e3;p=poolifier.git diff --git a/docs/classes/AbstractWorker.html b/docs/classes/AbstractWorker.html index 6ecd85f0..e75fee8f 100644 --- a/docs/classes/AbstractWorker.html +++ b/docs/classes/AbstractWorker.html @@ -1,4 +1,4 @@ -AbstractWorker | poolifier - v2.6.16
+AbstractWorker | poolifier - v2.6.32
  • Preparing search index...
  • -
  • The search index is not available
poolifier - v2.6.16
+
  • The search index is not available
  • poolifier - v2.6.32
    @@ -103,7 +109,7 @@
      - +
    • Constructs a new poolifier worker.

      @@ -111,7 +117,7 @@

      Type Parameters

      • -

        MainWorker extends Worker | MessagePort

      • +

        MainWorker extends MessagePort | Worker

      • Data = unknown

      • @@ -130,17 +136,17 @@
      • -
        taskFunctions: WorkerFunction<Data, Response> | TaskFunctions<Data, Response>
        -

        Task function(s) processed by the worker when the pool's execution function is invoked. The first function is the default function.

        +
        mainWorker: MainWorker
        +

        Reference to main worker.

      • -
        mainWorker: MainWorker
        -

        Reference to main worker.

        +
        taskFunctions: TaskFunction<Data, Response> | TaskFunctions<Data, Response>
        +

        Task function(s) processed by the worker when the pool's execution function is invoked. The first function is the default function.

      • -
        opts: WorkerOptions = ...
        +
        opts: WorkerOptions = DEFAULT_WORKER_OPTIONS

        Options for the worker.

      @@ -148,7 +154,7 @@
    +
  • Defined in src/worker/abstract-worker.ts:83
  • Properties

    @@ -158,7 +164,7 @@
    +
  • Defined in src/worker/abstract-worker.ts:73
  • id: number
    @@ -166,7 +172,7 @@
    +
  • Defined in src/worker/abstract-worker.ts:57
  • isMain: boolean
    @@ -174,7 +180,7 @@
    +
  • Defined in src/worker/abstract-worker.ts:85
  • lastTaskTimestamp: number
    @@ -182,23 +188,23 @@
    -
    - +
  • Defined in src/worker/abstract-worker.ts:65
  • +
    +
    mainWorker: MainWorker

    Reference to main worker.

    +
  • Defined in src/worker/abstract-worker.ts:86
  • - -
    opts: WorkerOptions = ...
    + +
    opts: WorkerOptions = DEFAULT_WORKER_OPTIONS

    Options for the worker.

    +
  • Defined in src/worker/abstract-worker.ts:88
  • statistics: WorkerStatistics
    @@ -206,15 +212,15 @@
    +
  • Defined in src/worker/abstract-worker.ts:69
  • -
    taskFunctions: Map<string, WorkerFunction<Data, Response>>
    +
    taskFunctions: Map<string, TaskFunction<Data, Response>>

    Task function(s) processed by the worker when the pool's execution function is invoked.

    +
  • Defined in src/worker/abstract-worker.ts:61
  • Methods

    @@ -234,21 +240,21 @@ If a task function with the same name already exists, it is replaced.

  • -
    fn: WorkerFunction<Data, Response>
    +
    fn: TaskFunction<Data, Response>

    The task function to add.

  • Returns boolean

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

    +
  • Defined in src/worker/abstract-worker.ts:568
  • +
  • Defined in node_modules/.pnpm/@types+node@20.5.3/node_modules/@types/node/async_hooks.d.ts:283
  • +
  • Defined in src/worker/abstract-worker.ts:409
  • +
    + +
    +
  • Defined in src/worker/abstract-worker.ts:592
  • +
    + +
    +
  • Defined in src/worker/abstract-worker.ts:108
  • Returns void

    +
  • Defined in src/worker/abstract-worker.ts:98
  • +
  • Defined in node_modules/.pnpm/@types+node@20.5.3/node_modules/@types/node/async_hooks.d.ts:302
  • Returns TaskPerformance

    +
  • Defined in src/worker/abstract-worker.ts:577
  • +
  • Defined in src/worker/abstract-worker.ts:423
  • -

    Returns WorkerFunction<Data, Response>

    The task function.

    +

    Returns TaskFunction<Data, Response>

    The task function.

    Throws

    https://nodejs.org/api/errors.html#class-error If the task function is not found.

    +
  • Defined in src/worker/abstract-worker.ts:559
  • +
  • Defined in src/worker/abstract-worker.ts:455
  • +
    + +
    +
    + +
    +
  • Defined in src/worker/abstract-worker.ts:167
  • +
    + +
    +
  • Defined in src/worker/abstract-worker.ts:319
  • +
  • Defined in src/worker/abstract-worker.ts:221
  • +
  • Defined in src/worker/abstract-worker.ts:465
  • +
  • Defined in src/worker/abstract-worker.ts:517
  • +
  • Defined in node_modules/.pnpm/@types+node@20.5.3/node_modules/@types/node/async_hooks.d.ts:294
  • -
    - +
  • Defined in src/worker/abstract-worker.ts:480
  • +
    +
    +
  • Defined in src/worker/abstract-worker.ts:442
  • +
  • Defined in src/worker/abstract-worker.ts:435
  • +
  • Defined in src/worker/abstract-worker.ts:275
  • +
  • Defined in src/worker/abstract-worker.ts:388
  • +
  • Defined in src/worker/abstract-worker.ts:399
  • +
  • Defined in node_modules/.pnpm/@types+node@20.5.3/node_modules/@types/node/async_hooks.d.ts:311
  • +
    + +
    +
  • Defined in node_modules/.pnpm/@types+node@20.5.3/node_modules/@types/node/async_hooks.d.ts:277