X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractWorker.html;h=50ac5c495c6477a8c881eac8d0e9436004fc0648;hb=cc35cd9cb7323e39c9f521cdd4fbf51d1d31bbdf;hp=ea59495d1ac3ec4c190af490d230054e2eadc285;hpb=6acf0df125c95248e1c05c38e97c7676b48f6a1a;p=poolifier.git diff --git a/docs/classes/AbstractWorker.html b/docs/classes/AbstractWorker.html index ea59495d..50ac5c49 100644 --- a/docs/classes/AbstractWorker.html +++ b/docs/classes/AbstractWorker.html @@ -1,4 +1,4 @@ -AbstractWorker | poolifier - v2.6.16
+AbstractWorker | poolifier - v2.6.40
  • Preparing search index...
  • -
  • The search index is not available
poolifier - v2.6.16
+
  • The search index is not available
  • poolifier - v2.6.40
    @@ -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

      • @@ -122,33 +128,28 @@
      • type: string

        The type of async event.

        -
        -
      • +
      • isMain: boolean

        Whether this is the main worker or not.

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

        -
        -
      • +
      • -
        opts: WorkerOptions = ...
        +
        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 = DEFAULT_WORKER_OPTIONS

        Options for the worker.

        -
        -
      +

    Returns AbstractWorker<MainWorker, Data, Response>

    +
  • Defined in src/worker/abstract-worker.ts:83
  • Properties

    @@ -158,7 +159,7 @@
    +
  • Defined in src/worker/abstract-worker.ts:73
  • id: number
    @@ -166,7 +167,7 @@
    +
  • Defined in src/worker/abstract-worker.ts:57
  • isMain: boolean
    @@ -174,7 +175,7 @@
    +
  • Defined in src/worker/abstract-worker.ts:85
  • lastTaskTimestamp: number
    @@ -182,23 +183,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 +207,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

    @@ -231,24 +232,22 @@ If a task function with the same name already exists, it is replaced.

  • name: string

    The name of the task function to add.

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

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

    Returns Func

    Since

    v14.8.0, v12.19.0

    +
  • Defined in node_modules/.pnpm/@types+node@20.5.7/node_modules/@types/node/async_hooks.d.ts:283
  • +
  • Defined in src/worker/abstract-worker.ts:419
  • +
    + +
    +
  • Defined in src/worker/abstract-worker.ts:600
  • +
    + +

    Returns void

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

    Returns void

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

    +
  • Defined in src/worker/abstract-worker.ts:585
  • -
    - -
    +
  • Defined in src/worker/abstract-worker.ts:434
  • +

    Returns string

    The error message.

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

    Returns boolean

    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.

    +

    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:177
  • +
    + +

    Returns void

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

    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.

    +

    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:231
  • +

    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:476
  • Returns void

    +
  • Defined in src/worker/abstract-worker.ts:541
  • Optional thisArg: This

    The receiver to be used for the function call.

    -
    -
  • +Optional
  • Rest ...args: any[]

    Optional arguments to pass to the function.

    -
    -
  • +Rest

    Returns Result

    Since

    v9.6.0

    +
  • Defined in node_modules/.pnpm/@types+node@20.5.7/node_modules/@types/node/async_hooks.d.ts:294
  • Returns void

    -
    - +
  • Defined in src/worker/abstract-worker.ts:504
  • +
    +
    +
  • Defined in src/worker/abstract-worker.ts:453
  • +

    Returns void

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

    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-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 a non-existing task function.

    +
  • Defined in src/worker/abstract-worker.ts:285
  • +
  • Defined in src/worker/abstract-worker.ts:398
  • +
  • Defined in src/worker/abstract-worker.ts:409
  • +
  • Defined in node_modules/.pnpm/@types+node@20.5.7/node_modules/@types/node/async_hooks.d.ts:311
  • +
    + +
    +
    Optional thisArg: ThisArg
    Optional

    Returns Func

    Since

    v14.8.0, v12.19.0

    +
  • Defined in node_modules/.pnpm/@types+node@20.5.7/node_modules/@types/node/async_hooks.d.ts:277
  • -

    Generated using TypeDoc

    +

    Generated using TypeDoc

    \ No newline at end of file