Interface IWorkerNode<Worker, Data>Internal

Worker node interface.

Type Parameters

  • Worker extends IWorker

    Type of worker.

  • Data = unknown

    Type of data sent to the worker. This can only be structured-cloneable data.

Hierarchy

  • IWorkerNode

Properties

clearTasksQueue closeChannel dequeueTask enqueueTask getTaskFunctionWorkerUsage hasBackPressure info messageChannel? onBackPressure? onEmptyQueue? popTask resetUsage tasksQueueBackPressureSize tasksQueueSize unshiftTask usage worker

Properties

Readonly clearTasksQueue

clearTasksQueue: (() => void)

Type declaration

    • (): void

    • Clears tasks queue.

      Returns void

Readonly closeChannel

closeChannel: (() => void)

Type declaration

    • (): void

    • Closes communication channel.

      Returns void

Readonly dequeueTask

dequeueTask: (() => undefined | Task<Data>)

Type declaration

    • (): undefined | Task<Data>

    • Dequeue task.

      Returns undefined | Task<Data>

      The dequeued task.

Readonly enqueueTask

enqueueTask: ((task) => number)

Type declaration

    • (task): number

    • Enqueue task.

      Parameters

      • task: Task<Data>

        The task to queue.

      Returns number

      The tasks queue size.

Readonly getTaskFunctionWorkerUsage

getTaskFunctionWorkerUsage: ((name) => undefined | WorkerUsage)

Type declaration

    • (name): undefined | WorkerUsage

    • Gets task function worker usage statistics.

      Parameters

      • name: string

        The task function name.

      Returns undefined | WorkerUsage

      The task function worker usage statistics if the task function worker usage statistics are initialized, undefined otherwise.

Readonly hasBackPressure

hasBackPressure: (() => boolean)

Type declaration

    • (): boolean

    • Whether the worker node has back pressure (i.e. its tasks queue is full).

      Returns boolean

      true if the worker node has back pressure, false otherwise.

Readonly info

info: WorkerInfo

Worker info.

Optional Readonly messageChannel

messageChannel?: MessageChannel

Message channel (worker_threads only).

Optional onBackPressure

onBackPressure?: WorkerNodeEventCallback

Callback invoked when worker node tasks queue is back pressured.

Optional onEmptyQueue

onEmptyQueue?: WorkerNodeEventCallback

Callback invoked when worker node tasks queue is empty.

Readonly popTask

popTask: (() => undefined | Task<Data>)

Type declaration

    • (): undefined | Task<Data>

    • Pops a task from the tasks queue.

      Returns undefined | Task<Data>

      The popped task.

Readonly resetUsage

resetUsage: (() => void)

Type declaration

    • (): void

    • Resets usage statistics.

      Returns void

tasksQueueBackPressureSize

tasksQueueBackPressureSize: number

Tasks queue back pressure size. This is the number of tasks that can be enqueued before the worker node has back pressure.

Readonly tasksQueueSize

tasksQueueSize: (() => number)

Type declaration

    • (): number

    • Tasks queue size.

      Returns number

      The tasks queue size.

Readonly unshiftTask

unshiftTask: ((task) => number)

Type declaration

    • (task): number

    • Prepends a task to the tasks queue.

      Parameters

      • task: Task<Data>

        The task to prepend.

      Returns number

      The tasks queue size.

Readonly usage

usage: WorkerUsage

Worker usage statistics.

Readonly worker

worker: Worker

Worker.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc