- -

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 serializable data.
-
-
Response = unknown
-
Type of response the worker sends back to the main worker. This can only be serializable data.
-

Hierarchy

AsyncResource -
- AbstractWorker -
  - ClusterWorker
  - ThreadWorker

Index

Constructors

constructor

new AbstractWorker<MainWorker, Data, Response>(type: string, isMain: boolean, fn: WorkerFunction<Data, Response>, mainWorker: undefined | null | MainWorker, opts?: WorkerOptions): AbstractWorker<MainWorker, Data, Response>
-
Constructs a new poolifier worker.
-
-
-
Type Parameters
-
- -
  MainWorker extends Worker | MessagePort
- -
  Data = unknown
- -
  Response = unknown
-
-
Parameters
-
- -
  type: string
  -
  The type of async event.
  -
- -
  isMain: boolean
  -
  Whether this is the main worker or not.
  -
- -
  fn: WorkerFunction<Data, Response>
  -
  Function processed by the worker when the pool's execution function is invoked.
  -
- -
  mainWorker: undefined | null | MainWorker
  -
  Reference to main worker.
  -
- -
  opts: WorkerOptions = ...
  -
  Options for the worker.
  -
-
Returns AbstractWorker<MainWorker, Data, Response>
-
Overrides AsyncResource.constructor
-
- Defined in src/worker/abstract-worker.ts:46

Properties

`Protected` `Optional` `Readonly` aliveInterval

aliveInterval?: Timeout

Handler id of the aliveInterval worker alive check.

`Protected` `Readonly` isMain

isMain: boolean

Whether this is the main worker or not.

`Protected` lastTaskTimestamp

lastTaskTimestamp: number

Timestamp of the last task processed by this worker.

`Protected` mainWorker

mainWorker: undefined | null | MainWorker

Reference to main worker.

`Protected` `Readonly` opts

opts: WorkerOptions = ...

Options for the worker.

Methods

asyncId

asyncId(): number
-
-
Returns
The unique asyncId assigned to the resource.
-
-
Returns number
-
Inherited from AsyncResource.asyncId
-
- Defined in node_modules/.pnpm/@types+node@18.15.11/node_modules/@types/node/async_hooks.d.ts:315

bind

bind<Func>(fn: Func): Func & {
Â Â Â Â asyncResource: AsyncResource;
}
-
Binds the given function to execute to this AsyncResource's scope.
-
The returned function will have an asyncResource property referencing -the AsyncResource to which the function is bound.
- -
Since
v14.8.0, v12.19.0
-
-
-
Type Parameters
-
- -
  Func extends ((...args: any[]) => any)
-
-
Parameters
-
- -
  fn: Func
  -
  The function to bind to the current AsyncResource.
  -
-
Returns Func & {
Â Â Â Â asyncResource: AsyncResource;
}
-
Inherited from AsyncResource.bind
-
- Defined in node_modules/.pnpm/@types+node@18.15.11/node_modules/@types/node/async_hooks.d.ts:288

`Protected` checkAlive

checkAlive(): void
-
Checks if the worker should be terminated, because its living too long.
-
-
Returns void
-
- Defined in src/worker/abstract-worker.ts:156

`Private` checkFunctionInput

checkFunctionInput(fn: WorkerFunction<Data, Response>): void
-
Checks if the fn parameter is passed to the constructor.
-
-
-
Parameters
-
- -
  fn: WorkerFunction<Data, Response>
  -
  The function that should be defined.
  -
-
Returns void
-
- Defined in src/worker/abstract-worker.ts:122

`Private` checkWorkerOptions

checkWorkerOptions(opts: WorkerOptions): void
-
-
Parameters
-
- -
  opts: WorkerOptions
-
Returns void
-
- Defined in src/worker/abstract-worker.ts:110

emitDestroy

emitDestroy(): AbstractWorker<MainWorker, Data, Response>
-
Call all destroy hooks. This should only ever be called once. An error will +AbstractWorker | poolifier - v3.0.5
Preparing search index...
The search index is not available
poolifier - v3.0.5
poolifier
AbstractWorker
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
AsyncResource
AbstractWorker
ClusterWorker
ThreadWorker
Defined in src/worker/abstract-worker.ts:55
Index
Constructors
constructor +
Properties
activeInterval? +id +isMain +lastTaskTimestamp +mainWorker +opts +statistics +taskFunctions +
Methods
addTaskFunction +asyncId +beginTaskPerformance +bind +checkActive +checkMessageWorkerId +checkStatistics +checkTaskFunctions +checkWorkerOptions +emitDestroy +endTaskPerformance +getMainWorker +handleError +handleKillMessage +handleReadyMessage +handleTaskFunctionOperationMessage +hasTaskFunction +listTaskFunctionNames +messageListener +removeTaskFunction +run +runAsync +runInAsyncScope +runSync +sendTaskFunctionNamesToMainWorker +sendToMainWorker +setDefaultTaskFunction +startCheckActive +stopCheckActive +triggerAsyncId +updateLastTaskTimestamp +bind +
Constructors
constructor
new AbstractWorker<MainWorker, Data, Response>(type, isMain, mainWorker, taskFunctions, opts?): AbstractWorker<MainWorker, Data, Response>
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>
Overrides AsyncResource.constructor
Defined in src/worker/abstract-worker.ts:89
Properties
Protected Optional activeInterval
activeInterval?: Timeout
Handler id of the activeInterval worker activity check.
+
Defined in src/worker/abstract-worker.ts:79
Protected Abstract id
id: number
Worker id.
+
Defined in src/worker/abstract-worker.ts:63
Protected Readonly isMain
isMain: boolean
Whether this is the main worker or not.
+
Defined in src/worker/abstract-worker.ts:91
Protected lastTaskTimestamp
lastTaskTimestamp: number
Timestamp of the last task processed by this worker.
+
Defined in src/worker/abstract-worker.ts:71
Private Readonly mainWorker
mainWorker: MainWorker
Reference to main worker.
+
Defined in src/worker/abstract-worker.ts:92
Protected opts
opts: WorkerOptions = DEFAULT_WORKER_OPTIONS
Options for the worker.
+
Defined in src/worker/abstract-worker.ts:94
Protected statistics
statistics: WorkerStatistics
Performance statistics computation requirements.
+
Defined in src/worker/abstract-worker.ts:75
Protected taskFunctions
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:67
Methods
addTaskFunction
addTaskFunction(name, fn): TaskFunctionOperationResult
Adds a task function to the worker. +If a task function with the same name already exists, it is replaced.
+
Parameters
name: string
The name of the task function to add.
+
fn: TaskFunction<Data, Response>
The task function to add.
+
Returns TaskFunctionOperationResult
Whether the task function was added or not.
+
Defined in src/worker/abstract-worker.ts:179
asyncId
asyncId(): number
Returns number
The unique asyncId assigned to the resource.
+
Inherited from AsyncResource.asyncId
Defined in node_modules/.pnpm/@types+node@20.8.9/node_modules/@types/node/async_hooks.d.ts:315
Private beginTaskPerformance
beginTaskPerformance(name?): TaskPerformance
Parameters
Optional name: string
Returns TaskPerformance
Defined in src/worker/abstract-worker.ts:587
bind
bind<Func>(fn): Func
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
+
Inherited from AsyncResource.bind
Defined in node_modules/.pnpm/@types+node@20.8.9/node_modules/@types/node/async_hooks.d.ts:288
Private checkActive
checkActive(): void
Checks if the worker should be terminated, because its living too long.
+
Returns void
Defined in src/worker/abstract-worker.ts:439
Private checkMessageWorkerId
checkMessageWorkerId(message): void
Check if the message worker id is set and matches the worker id.
+
Parameters
message: MessageValue<Data, unknown>
The message to check.
+
Returns void
Throws
https://nodejs.org/api/errors.html#class-error If the message worker id is not set or does not match the worker id.
+
Defined in src/worker/abstract-worker.ts:405
Private checkStatistics
checkStatistics(): void
Returns void
Defined in src/worker/abstract-worker.ts:611
Private checkTaskFunctions
checkTaskFunctions(taskFunctions): void
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
Defined in src/worker/abstract-worker.ts:118
Private checkWorkerOptions
checkWorkerOptions(opts): void
Parameters
opts: WorkerOptions
Returns void
Defined in src/worker/abstract-worker.ts:108
emitDestroy
emitDestroy(): AbstractWorker<MainWorker, Data, Response>
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
A reference to asyncResource.
-
-
Returns AbstractWorker<MainWorker, Data, Response>
-
Inherited from AsyncResource.emitDestroy
-
-
Defined in node_modules/.pnpm/@types+node@18.15.11/node_modules/@types/node/async_hooks.d.ts:311
-
-
Protected getMainWorker
-
-
getMainWorker(): MainWorker
-
-
Returns the main worker.
- -
Returns
Reference to the main worker.
-
-
Returns MainWorker
-
-
Defined in src/worker/abstract-worker.ts:139
-
-
Protected handleError
-
-
handleError(e: string | Error): string
-
-
Handles an error and convert it to a string so it can be sent back to the main worker.
- -
Returns
Message of the error.
-
-
-
Parameters
-
-
-
e: string | Error
-
The error raised by the worker.
-
-
Returns string
-
-
Defined in src/worker/abstract-worker.ts:171
-
-
Protected messageListener
-
-
messageListener(message: MessageValue<Data, MainWorker>, fn: WorkerFunction<Data, Response>): void
-
-
Worker message listener.
-
-
-
Parameters
-
-
-
message: MessageValue<Data, MainWorker>
-
Message received.
-
-
-
fn: WorkerFunction<Data, Response>
-
Function processed by the worker when the pool's execution function is invoked.
-
-
Returns void
-
-
Defined in src/worker/abstract-worker.ts:89
-
-
Protected run
-
-
run(fn: WorkerSyncFunction<Data, Response>, message: MessageValue<Data, unknown>): void
-
-
Runs the given function synchronously.
-
-
-
Parameters
-
-
-
fn: WorkerSyncFunction<Data, Response>
-
Function that will be executed.
-
-
-
message: MessageValue<Data, unknown>
-
Input data for the given function.
-
-
Returns void
-
-
Defined in src/worker/abstract-worker.ts:181
-
-
Protected runAsync
-
-
runAsync(fn: WorkerAsyncFunction<Data, Response>, message: MessageValue<Data, unknown>): void
-
-
Runs the given function asynchronously.
-
-
-
Parameters
-
-
-
fn: WorkerAsyncFunction<Data, Response>
-
Function that will be executed.
-
-
-
message: MessageValue<Data, unknown>
-
Input data for the given function.
-
-
Returns void
-
-
Defined in src/worker/abstract-worker.ts:208
-
-
runInAsyncScope
-
-
runInAsyncScope<This, Result>(fn: ((this: This, ...args: any[]) => Result), thisArg?: This, ...args: any[]): Result
-
-
Call the provided function with the provided arguments in the execution context +
Returns AbstractWorker<MainWorker, Data, Response>
A reference to asyncResource.
+
Inherited from AsyncResource.emitDestroy
Defined in node_modules/.pnpm/@types+node@20.8.9/node_modules/@types/node/async_hooks.d.ts:311
Private endTaskPerformance
endTaskPerformance(taskPerformance): TaskPerformance
Parameters
taskPerformance: TaskPerformance
Returns TaskPerformance
Defined in src/worker/abstract-worker.ts:596
Protected getMainWorker
getMainWorker(): MainWorker
Returns the main worker.
+
Returns MainWorker
Reference to the main worker.
+
Throws
https://nodejs.org/api/errors.html#class-error If the main worker is not set.
+
Defined in src/worker/abstract-worker.ts:454
Protected handleError
handleError(error): string
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.
+
Defined in src/worker/abstract-worker.ts:485
Protected handleKillMessage
handleKillMessage(_message): void
Handles a kill message sent by the main worker.
+
Parameters
_message: MessageValue<Data, unknown>
Returns void
Defined in src/worker/abstract-worker.ts:371
Protected Abstract handleReadyMessage
handleReadyMessage(message): void
Handles the ready message sent by the main worker.
+
Parameters
message: MessageValue<Data, unknown>
The ready message.
+
Returns void
Defined in src/worker/abstract-worker.ts:299
Protected handleTaskFunctionOperationMessage
handleTaskFunctionOperationMessage(message): void
Parameters
message: MessageValue<Data, unknown>
Returns void
Defined in src/worker/abstract-worker.ts:326
hasTaskFunction
hasTaskFunction(name): TaskFunctionOperationResult
Checks if the worker has a task function with the given name.
+
Parameters
name: string
The name of the task function to check.
+
Returns TaskFunctionOperationResult
Whether the worker has a task function with the given name or not.
+
Defined in src/worker/abstract-worker.ts:162
listTaskFunctionNames
listTaskFunctionNames(): string[]
Lists the names of the worker's task functions.
+
Returns string[]
The names of the worker's task functions.
+
Defined in src/worker/abstract-worker.ts:243
Protected messageListener
messageListener(message): void
Worker message listener.
+
Parameters
message: MessageValue<Data, unknown>
The received message.
+
Returns void
Defined in src/worker/abstract-worker.ts:306
removeTaskFunction
removeTaskFunction(name): TaskFunctionOperationResult
Removes a task function from the worker.
+
Parameters
name: string
The name of the task function to remove.
+
Returns TaskFunctionOperationResult
Whether the task function existed and was removed or not.
+
Defined in src/worker/abstract-worker.ts:214
Protected run
run(task): void
Runs the given task.
+
Parameters
task: Task<Data>
The task to execute.
+
Returns void
Defined in src/worker/abstract-worker.ts:494
Protected runAsync
runAsync(fn, task): void
Runs the given task function asynchronously.
+
Parameters
fn: TaskAsyncFunction<Data, Response>
Task function that will be executed.
+
task: Task<Data>
Input data for the task function.
+
Returns void
Defined in src/worker/abstract-worker.ts:555
runInAsyncScope
runInAsyncScope<This, Result>(fn, thisArg?, ...args): Result
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.
- -
Since
v9.6.0
-
-
-
Type Parameters
-
-
-
This
-
-
Result
-
-
Parameters
-
-
-
fn: ((this: This, ...args: any[]) => Result)
-
The function to call in the execution context of this async resource.
-
-
-
-
-
(this: This, ...args: any[]): 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
-
Inherited from AsyncResource.runInAsyncScope
-
-
Defined in node_modules/.pnpm/@types+node@18.15.11/node_modules/@types/node/async_hooks.d.ts:303
-
-
Protected Abstract sendToMainWorker
-
-
sendToMainWorker(message: MessageValue<Response, unknown>): void
-
-
Sends a message to the main worker.
-
-
-
Parameters
-
-
-
message: MessageValue<Response, unknown>
-
The response message.
-
-
Returns void
-
-
Defined in src/worker/abstract-worker.ts:151
-
-
triggerAsyncId
-
-
triggerAsyncId(): number
-
-
-
Returns
The same triggerAsyncId that is passed to the AsyncResource constructor.
-
-
Returns number
-
Inherited from AsyncResource.triggerAsyncId
-
-
Defined in node_modules/.pnpm/@types+node@18.15.11/node_modules/@types/node/async_hooks.d.ts:320
-
-
Static bind
-
-
bind<Func, ThisArg>(fn: Func, type?: string, thisArg?: ThisArg): Func & {
Â Â Â Â asyncResource: AsyncResource;
}
-
-
Binds the given function to the current execution context.
-
The returned function will have an asyncResource property referencing -the AsyncResource to which the function is bound.
- -
Since
v14.8.0, v12.19.0
-
-
-
Type Parameters
-
-
-
Func extends ((this: ThisArg, ...args: any[]) => 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 & {
Â Â Â Â asyncResource: AsyncResource;
}
-
Inherited from AsyncResource.bind
-
-
Defined in node_modules/.pnpm/@types+node@18.15.11/node_modules/@types/node/async_hooks.d.ts:273
-
-
-
-
-
Settings
-
-
-
Member Visibility
-
-
Protected
-
Private
-
Inherited
-
External
-
-
Theme
-
-
On This Page
-
-
-
constructor
-
aliveInterval
-
isMain
-
lastTaskTimestamp
-
mainWorker
-
opts
-
asyncId
-
bind
-
checkAlive
-
checkFunctionInput
-
checkWorkerOptions
-
emitDestroy
-
getMainWorker
-
handleError
-
messageListener
-
run
-
runAsync
-
runInAsyncScope
-
sendToMainWorker
-
triggerAsyncId
-
bind
-
-
poolifier -
-
PoolType
-
AbstractPool
-
AbstractWorker
-
CircularArray
-
ClusterWorker
-
DynamicClusterPool
-
DynamicThreadPool
-
FixedClusterPool
-
FixedThreadPool
-
PoolEmitter
-
ThreadWorker
-
WorkerChoiceStrategyContext
-
ClusterPoolOptions
-
IPool
-
IWorker
-
IWorkerChoiceStrategy
-
MessageValue
-
PoolOptions
-
PromiseResponseWrapper
-
RequiredStatistics
-
Task
-
TasksQueueOptions
-
TasksUsage
-
WorkerChoiceStrategyOptions
-
WorkerNode
-
WorkerOptions
-
Draft
-
ErrorHandler
-
ExitHandler
-
KillBehavior
-
MessageHandler
-
OnlineHandler
-
PoolEvent
-
ThreadWorkerWithMessageChannel
-
WorkerAsyncFunction
-
WorkerChoiceStrategy
-
WorkerFunction
-
WorkerSyncFunction
-
KillBehaviors
-
PoolEvents
-
WorkerChoiceStrategies
-
-
Generated using TypeDoc
-
\ No newline at end of file +
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
+
Inherited from AsyncResource.runInAsyncScope
- Defined in node_modules/.pnpm/@types+node@20.8.9/node_modules/@types/node/async_hooks.d.ts:299

`Protected` runSync

runSync(fn, task): void
Runs the given task function synchronously.
+
Parameters
- fn: TaskSyncFunction<Data, Response>
  Task function that will be executed.
  +
- task: Task<Data>
  Input data for the task function.
  +
Returns void
- Defined in src/worker/abstract-worker.ts:521

`Protected` sendTaskFunctionNamesToMainWorker

sendTaskFunctionNamesToMainWorker(): void
Sends task function names to the main worker.
+
Returns void
- Defined in src/worker/abstract-worker.ts:473

`Protected` `Abstract` sendToMainWorker

sendToMainWorker(message): void
Sends a message to main worker.
+
Parameters
- message: MessageValue<Response, Data>
  The response message.
  +
Returns void
- Defined in src/worker/abstract-worker.ts:466

setDefaultTaskFunction

setDefaultTaskFunction(name): TaskFunctionOperationResult
Sets the default task function to use in the worker.
+
Parameters
- name: string
  The name of the task function to use as default task function.
  +
Returns TaskFunctionOperationResult
Whether the default task function was set or not.
+
- Defined in src/worker/abstract-worker.ts:270

`Private` startCheckActive

startCheckActive(): void
Starts the worker check active interval.
+
Returns void
- Defined in src/worker/abstract-worker.ts:418

`Private` stopCheckActive

stopCheckActive(): void
Stops the worker check active interval.
+
Returns void
- Defined in src/worker/abstract-worker.ts:429

triggerAsyncId

triggerAsyncId(): number
Returns number
The same triggerAsyncId that is passed to the AsyncResource constructor.
+
Inherited from AsyncResource.triggerAsyncId
- Defined in node_modules/.pnpm/@types+node@20.8.9/node_modules/@types/node/async_hooks.d.ts:319

`Private` updateLastTaskTimestamp

updateLastTaskTimestamp(): void
Returns void
- Defined in src/worker/abstract-worker.ts:617

`Static` bind

bind<Func, ThisArg>(fn, type?, thisArg?): Func
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
+
Inherited from AsyncResource.bind
- Defined in node_modules/.pnpm/@types+node@20.8.9/node_modules/@types/node/async_hooks.d.ts:278

Class AbstractWorker<MainWorker, Data, Response>Abstract

Type Parameters

MainWorker extends Worker | MessagePort

Data = unknown

Response = unknown

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

MainWorker extends Worker | MessagePort

Data = unknown

Response = unknown

Parameters

type: string

isMain: boolean

fn: WorkerFunction<Data, Response>

mainWorker: undefined | null | MainWorker

opts: WorkerOptions = ...

Returns AbstractWorker<MainWorker, Data, Response>

Properties

Protected Optional Readonly aliveInterval

Protected Readonly isMain

Protected lastTaskTimestamp

Protected mainWorker

Protected Readonly opts

Methods

asyncId

Returns

Returns number

bind

Since

Type Parameters

Func extends ((...args: any[]) => any)

Parameters

fn: Func

Returns Func & { Â Â Â Â asyncResource: AsyncResource; }

Protected checkAlive

Returns void

Private checkFunctionInput

Parameters

fn: WorkerFunction<Data, Response>

Returns void

Private checkWorkerOptions

Parameters

opts: WorkerOptions

Returns void

emitDestroy

Class AbstractWorker<MainWorker, Data, Response>Abstract

Type Parameters

MainWorker extends Worker | MessagePort

Data = unknown

Response = unknown

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

MainWorker extends MessagePort | Worker

Data = unknown

Response = unknown

Parameters

type: string

isMain: boolean

mainWorker: MainWorker

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

opts: WorkerOptions = DEFAULT_WORKER_OPTIONS

Returns AbstractWorker<MainWorker, Data, Response>

Properties

Protected Optional activeInterval

Protected Abstract id

Protected Readonly isMain

Protected lastTaskTimestamp

Private Readonly mainWorker

Class AbstractWorker<MainWorker, Data, Response>`Abstract`

`Protected` `Optional` `Readonly` aliveInterval

`Protected` `Readonly` isMain

`Protected` lastTaskTimestamp

`Protected` mainWorker

`Protected` `Readonly` opts

Returns Func & {
Â Â Â Â asyncResource: AsyncResource;
}

`Protected` checkAlive

`Private` checkFunctionInput

`Private` checkWorkerOptions

Class AbstractWorker<MainWorker, Data, Response>`Abstract`

`Protected` `Optional` activeInterval

`Protected` `Abstract` id

`Protected` `Readonly` isMain

`Protected` lastTaskTimestamp

`Private` `Readonly` mainWorker

`Protected` opts

`Protected` statistics

`Protected` taskFunctions

`Private` beginTaskPerformance

`Optional` name: string

`Private` checkActive

`Private` checkMessageWorkerId

`Private` checkStatistics

`Private` checkTaskFunctions

`Private` checkWorkerOptions

`Protected` getMainWorker

`Protected` handleError

`Protected` messageListener

`Protected` run

`Protected` runAsync

`Private` endTaskPerformance