X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractWorker.html;h=62d07519ef83be25da752177239cc27e2153b57d;hb=eea9f8d7f367e79b2ab86f62a9504e3a93b6db14;hp=c4e0f319735d6a58d46a99c4700e0b592ca6c578;hpb=6349b7551b1060472ed8c97dd01ef0c827d62278;p=poolifier.git diff --git a/docs/classes/AbstractWorker.html b/docs/classes/AbstractWorker.html index c4e0f319..62d07519 100644 --- a/docs/classes/AbstractWorker.html +++ b/docs/classes/AbstractWorker.html @@ -1,128 +1,98 @@ -AbstractWorker | poolifier - v3.0.7

Class AbstractWorker<MainWorker, Data, Response>Abstract

Base class that implements some shared logic for all poolifier workers.

-

Type Parameters

  • MainWorker extends Worker | MessagePort

    Type of main worker.

    -
  • Data = unknown

    Type of data this worker receives from pool's execution. This can only be structured-cloneable data.

    -
  • Response = unknown

    Type of response the worker sends back to the main worker. This can only be structured-cloneable data.

    -

Hierarchy

Constructors

  • Constructs a new poolifier worker.

    -

    Type Parameters

    • MainWorker extends MessagePort | Worker

    • Data = unknown

    • Response = unknown

    Parameters

    • type: string

      The type of async event.

      -
    • isMain: boolean

      Whether this is the main worker or not.

      -
    • 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 = DEFAULT_WORKER_OPTIONS

      Options for the worker.

      -

    Returns AbstractWorker<MainWorker, Data, Response>

Properties

activeInterval?: Timeout

Handler id of the activeInterval worker activity check.

-
id: number

Worker id.

-
isMain: boolean

Whether this is the main worker or not.

-
lastTaskTimestamp: number

Timestamp of the last task processed by this worker.

-
mainWorker: MainWorker

Reference to main worker.

-
opts: WorkerOptions = DEFAULT_WORKER_OPTIONS

Options for the worker.

-
statistics: WorkerStatistics

Performance statistics computation requirements.

-
taskFunctions: Map<string, TaskFunction<Data, Response>>

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

-

Methods

  • Handles an error and convert it to a string so it can be sent back to the main worker.

    -

    Parameters

  • Handles an error and convert it to a string so it can be sent back to the main worker.

    +

    Parameters

    • error: string | Error

      The error raised by the worker.

    Returns string

    The error message.

    -
  • Lists the names of the worker's task functions.

    Returns string[]

    The names of the worker's task functions.

    -
  • Call the provided function with the provided arguments in the execution context -of the async resource. This will establish the context, trigger the AsyncHooks -before callbacks, call the function, trigger the AsyncHooks after callbacks, and -then restore the original execution context.

    -

    Type Parameters

    • This

    • Result

    Parameters

    • fn: ((this, ...args) => Result)

      The function to call in the execution context of this async resource.

      -
        • (this, ...args): Result
        • Parameters

          • this: This
          • Rest ...args: any[]

          Returns Result

    • Optional thisArg: This

      The receiver to be used for the function call.

      -
    • Rest ...args: any[]

      Optional arguments to pass to the function.

      -

    Returns Result

    Since

    v9.6.0

    -
  • Returns number

    The same triggerAsyncId that is passed to the AsyncResource constructor.

    -
  • Binds the given function to the current execution context.

    -

    Type Parameters

    • Func extends ((this, ...args) => any)

    • ThisArg

    Parameters

    • fn: Func

      The function to bind to the current execution context.

      -
    • Optional type: string

      An optional name to associate with the underlying AsyncResource.

      -
    • Optional thisArg: ThisArg

    Returns Func

    Since

    v14.8.0, v12.19.0

    -

Generated using TypeDoc

\ No newline at end of file +

Generated using TypeDoc

\ No newline at end of file