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

Base class containing some shared logic for all poolifier workers.

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

Type Parameters

@@ -41,7 +43,7 @@

ClusterWorker

ThreadWorker

Defined in src/worker/abstract-worker.ts:24

@@ -54,9 +56,10 @@

Properties

aliveInterval? +isMain lastTaskTimestamp mainWorker -opts +opts

Methods

@@ -81,7 +84,7 @@

constructor

new AbstractWorker<MainWorker, Data, Response>(type: string, isMain: boolean, fn: ((data: Data) => Response), mainWorker: undefined | null | MainWorker, opts?: WorkerOptions): AbstractWorker<MainWorker, Data, Response>
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.

@@ -106,60 +109,58 @@
Whether this is the main worker or not.
-
fn: ((data: Data) => Response)
+
fn: WorkerFunction<Data, Response>

Function processed by the worker when the pool's execution function is invoked.
-
-
- -
  - (data: Data): Response
  - -
    -
    Parameters
    -
    - -
      data: Data
    -
    Returns Response

mainWorker: undefined | null | MainWorker

Reference to main worker.

opts: WorkerOptions = ...

Options for the worker.

Returns AbstractWorker<MainWorker, Data, Response>

Properties

`Protected` `Optional` `Readonly` aliveInterval

aliveInterval?: Timeout

Handler Id of the aliveInterval worker alive check.

Handler id of the aliveInterval worker alive check.

Defined in src/worker/abstract-worker.ts:36

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

Defined in src/worker/abstract-worker.ts:32

`Protected` mainWorker

mainWorker: undefined | null | MainWorker

`Readonly` opts

opts: WorkerOptions

Defined in src/worker/abstract-worker.ts:50

`Protected` `Readonly` opts

opts: WorkerOptions = ...

Options for the worker.

Defined in src/worker/abstract-worker.ts:51

Methods

@@ -173,11 +174,11 @@

Returns number

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 }
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 @@ -194,51 +195,40 @@ the AsyncResource to which the function is bound.

Parameters
- -
  fn: Func
  +
  fn: Func
  
  The function to bind to the current AsyncResource.
-
Returns Func & { asyncResource: AsyncResource }
+
Returns Func & {
Â Â Â Â asyncResource: AsyncResource;
}
Inherited from AsyncResource.bind
- Defined in node_modules/@types/node/ts4.8/async_hooks.d.ts:288

Defined in node_modules/.pnpm/@types+node@18.15.11/node_modules/@types/node/async_hooks.d.ts:288

`Protected` checkAlive

checkAlive(): void
-
Check to see if the worker should be terminated, because its living too long.
+
Checks if the worker should be terminated, because its living too long.

Returns void
- Defined in src/worker/abstract-worker.ts:144

Defined in src/worker/abstract-worker.ts:156

`Private` checkFunctionInput

checkFunctionInput(fn: ((data: Data) => Response)): void
checkFunctionInput(fn: WorkerFunction<Data, Response>): void
-
Check if the fn parameter is passed to the constructor.
+
Checks if the fn parameter is passed to the constructor.
Parameters
- -
  fn: ((data: Data) => Response)
  +
  fn: WorkerFunction<Data, Response>
  
  The function that should be defined.
  -
  -
  - -
    -
    (data: Data): Response
    -
    -
    -
    Parameters
    -
    -
    -
    data: Data
    -
    Returns Response
+

Returns void

`Protected` messageListener

messageListener(value: MessageValue<Data, MainWorker>, fn: ((data: Data) => Response)): void
messageListener(message: MessageValue<Data, MainWorker>, fn: WorkerFunction<Data, Response>): void
+
Worker message listener.
+
Parameters
- -
  value: MessageValue<Data, MainWorker>
- -
  fn: ((data: Data) => Response)
  -
  - -
    - (data: Data): Response
    - -
      -
      Parameters
      -
      +
      message: MessageValue<Data, MainWorker>
      +
      Message received.
      +
      
      -
      data: Data
      -
      Returns Response
+
fn: WorkerFunction<Data, Response>
+
Function processed by the worker when the pool's execution function is invoked.
+

Returns void

`Protected` run

run(fn: ((data?: Data) => Response), value: MessageValue<Data, unknown>): void
run(fn: WorkerSyncFunction<Data, Response>, message: MessageValue<Data, unknown>): void
-
Run the given function synchronously.
+
Runs the given function synchronously.
Parameters
- -
  fn: ((data?: Data) => Response)
  +
  fn: WorkerSyncFunction<Data, Response>
  
  Function that will be executed.
  -
  -
  - -
    -
    (data?: Data): Response
    -
    -
    -
    Parameters
    -
    -
    -
    Optional data: Data
    -
    Returns Response
-
value: MessageValue<Data, unknown>
+
message: MessageValue<Data, unknown>

Input data for the given function.

Returns void

`Protected` runAsync

runAsync(fn: ((data?: Data) => Promise<Response>), value: MessageValue<Data, unknown>): void
runAsync(fn: WorkerAsyncFunction<Data, Response>, message: MessageValue<Data, unknown>): void
-
Run the given function asynchronously.
+
Runs the given function asynchronously.
Parameters
- -
  fn: ((data?: Data) => Promise<Response>)
  +
  fn: WorkerAsyncFunction<Data, Response>
  
  Function that will be executed.
  -
  -
  - -
    -
    (data?: Data): Promise<Response>
    -
    -
    -
    Parameters
    -
    -
    -
    Optional data: Data
    -
    Returns Promise<Response>
-
value: MessageValue<Data, unknown>
+
message: MessageValue<Data, unknown>

Input data for the given function.

Returns void

runInAsyncScope

runInAsyncScope<This, Result>(fn: ((this: This, ...args: any[]) => Result), thisArg?: This, ...args: any[]): Result
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 of the async resource. This will establish the context, trigger the AsyncHooks @@ -412,51 +375,51 @@ then restore the original execution context.

Parameters
- -
  fn: ((this: This, ...args: any[]) => Result)
  +
  fn: ((this: This, ...args: any[]) => Result)
  
  The function to call in the execution context of this async resource.
  - - (this: This, ...args: any[]): Result
    - (this: This, ...args: any[]): Result
    - Parameters
      
      -
      this: This
      +
      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.

Class AbstractWorker<MainWorker, Data, Response>Abstract

Type Parameters

Properties

Methods

constructor

fn: ((data: Data) => Response)

fn: WorkerFunction<Data, Response>

Parameters

data: Data

Returns Response

mainWorker: undefined | null | MainWorker

mainWorker: undefined | null | MainWorker

opts: WorkerOptions = ...

Returns AbstractWorker<MainWorker, Data, Response>

Properties

Protected Optional Readonly aliveInterval

Protected Readonly isMain

Protected lastTaskTimestamp

Protected mainWorker

Readonly opts

Protected Readonly opts

Methods

Returns number

bind

Parameters

fn: Func

fn: Func

Returns Func & { asyncResource: AsyncResource }

Protected checkAlive

Returns void

Private checkFunctionInput

Parameters

fn: ((data: Data) => Response)

fn: WorkerFunction<Data, Response>

Parameters

data: Data

Returns Response

Returns void

Private checkWorkerOptions

opts: WorkerOptions

Returns void

emitDestroy

Returns

Returns AbstractWorker<MainWorker, Data, Response>

Protected getMainWorker

Returns

Returns MainWorker

Protected handleError

Returns

Returns string

Protected messageListener

Parameters

value: MessageValue<Data, MainWorker>

fn: ((data: Data) => Response)

Parameters

message: MessageValue<Data, MainWorker>

data: Data

Returns Response

fn: WorkerFunction<Data, Response>

Returns void

Protected run

Parameters

fn: ((data?: Data) => Response)

fn: WorkerSyncFunction<Data, Response>

Parameters

Optional data: Data

Returns Response

value: MessageValue<Data, unknown>

message: MessageValue<Data, unknown>

Returns void

Protected runAsync

Parameters

fn: ((data?: Data) => Promise<Response>)

fn: WorkerAsyncFunction<Data, Response>

Parameters

Optional data: Data

Returns Promise<Response>

value: MessageValue<Data, unknown>

message: MessageValue<Data, unknown>

Returns void

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

`Protected` `Optional` `Readonly` aliveInterval

`Protected` `Readonly` isMain

`Protected` lastTaskTimestamp

`Protected` mainWorker

`Readonly` opts

`Protected` `Readonly` opts

`Protected` checkAlive

`Private` checkFunctionInput

`Private` checkWorkerOptions

`Protected` getMainWorker

`Protected` handleError

`Protected` messageListener

`Protected` run

`Optional` data: Data

`Protected` runAsync

`Optional` data: Data

`Rest` ...args: any[]

`Optional` thisArg: This

`Optional` thisArg: This

`Rest` ...args: any[]

`Protected` `Abstract` sendToMainWorker

`Static` bind

`Optional` thisArg: ThisArg