X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractWorker.html;h=96fd87bf2b9972c7e9ab6f01042e5850a9650858;hb=743917b8a6544156a5b966854a3e3747db19508d;hp=6f9065e4344b2f2e0e6c0fe49b8f0c9ba1509509;hpb=9ad272eaf0cded8c7e70f1fe6f075c99f23619fa;p=poolifier.git diff --git a/docs/classes/AbstractWorker.html b/docs/classes/AbstractWorker.html index 6f9065e4..96fd87bf 100644 --- a/docs/classes/AbstractWorker.html +++ b/docs/classes/AbstractWorker.html @@ -1,26 +1,23 @@ -AbstractWorker | poolifier - v3.0.8

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

constructor +AbstractWorker | poolifier - v3.1.15

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 (view full)

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.

      +

Constructors

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

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

  • Returns number

    The unique asyncId assigned to the resource.

    -
  • Binds the given function to execute to this AsyncResource's scope.

    -

    Type Parameters

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

    Parameters

    • fn: Func

      The function to bind to the current AsyncResource.

      -

    Returns Func

    Since

    v14.8.0, v12.19.0

    -
  • Checks if the taskFunctions parameter is passed to the constructor and valid.

    -

    Parameters

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

      The task function(s) parameter that should be checked.

      -

    Returns void

  • Call all destroy hooks. This should only ever be called once. An error will -be thrown if it is called more than once. This must be manually called. If -the resource is left to be collected by the GC then the destroy hooks will -never be called.

    -

    Returns AbstractWorker<MainWorker, Data, Response>

    A reference to asyncResource.

    -
  • Returns the main worker.

    -

    Returns MainWorker

    Reference to the main worker.

    +

Generated using TypeDoc

\ No newline at end of file +

Generated using TypeDoc

\ No newline at end of file