X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractWorker.html;h=62d07519ef83be25da752177239cc27e2153b57d;hb=ecde6ea8c439bbdd9dc2ca118731b5006a1a9884;hp=f29da7f4f9ffcecbd52ae0a675ddaccadee66d93;hpb=904ddac9d4d1484aa4364ee8c042c62871ec2e39;p=poolifier.git diff --git a/docs/classes/AbstractWorker.html b/docs/classes/AbstractWorker.html index f29da7f4..62d07519 100644 --- a/docs/classes/AbstractWorker.html +++ b/docs/classes/AbstractWorker.html @@ -1,99 +1,98 @@ -AbstractWorker | poolifier - v3.0.13

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

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

    -

Generated using TypeDoc

\ No newline at end of file +

Generated using TypeDoc

\ No newline at end of file