AbstractWorker | poolifier

Base class containing some shared logic for all poolifier workers.

Type parameters

-
MainWorker: 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

Properties

Methods

Constructors

- -

constructor

new AbstractWorker<MainWorker, Data, Response>(type: string, isMain: boolean, fn: (data: Data) => Response, mainWorker?: null | MainWorker, opts?: WorkerOptions): AbstractWorker<MainWorker, Data, Response>

-
-
- Defined in src/worker/abstract-worker.ts:42
-
-
-
-
Constructs a new poolifier worker.
-
-
-
Type parameters
-
- -
  MainWorker: 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: (data: Data) => Response
  -
  -
  Function processed by the worker when the pool's execution function is invoked.
  -
  -
  - -
    - (data: Data): Response
    -
    - -
      Parameters
      -
      - -
        data: Data
        -
      -
      Returns Response
      -
    -
  -
- -
  Optional mainWorker: null | MainWorker
  -
  -
  Reference to main worker.
  -
  -
- -
  opts: WorkerOptions = ...
  -
  -
  Options for the worker.
  -
  -
-
Returns AbstractWorker<MainWorker, Data, Response>
-

Properties

- -

Protected Readonly async

async: boolean

- -

Whether the worker is working asynchronously or not.

- -

Protected Optional Readonly interval

interval: undefined | Timeout

- -

Handler ID of the interval alive check.

- -

Protected Readonly killBehavior

killBehavior: "SOFT" | "HARD"

- -

The kill behavior set as option on the Worker constructor or a default value.

- -

Protected lastTask

lastTask: number

- -

Timestamp of the last task processed by this worker.

- -

Protected Optional mainWorker

mainWorker: undefined | null | MainWorker

- -

Protected Readonly maxInactiveTime

maxInactiveTime: number

- -

The maximum time to keep this worker alive while idle. The pool automatically checks and terminates this worker when the time expires.

- -

Readonly opts

opts: WorkerOptions = ...

- -

Methods

- -

asyncId

asyncId(): number

-
-
- Defined in node_modules/@types/node/async_hooks.d.ts:159
-
-
Returns number
-
the unique ID assigned to this AsyncResource instance.
-

- -

bind

bind<Func>(fn: Func): Func & { asyncResource: AsyncResource }

-
-
- Defined in node_modules/@types/node/async_hooks.d.ts:136
-
-
-
-
Binds the given function to execute to this AsyncResource's scope.
-
-
-
Type parameters
-
- -
  Func: (...args: any[]) => any
  -
-
Parameters
-
- -
  fn: Func
  -
  -
  The function to bind to the current AsyncResource.
  -
  -
-
Returns Func & { asyncResource: AsyncResource }
-

- -

Protected checkAlive

checkAlive(): void

-
-
- Defined in src/worker/abstract-worker.ts:130
-
-
-
-
Check to see if the worker should be terminated, because its living too long.
-
-
-
Returns void
-

- -

Private checkFunctionInput

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

-
-
- Defined in src/worker/abstract-worker.ts:104
-
-
-
-
Check if the fn parameter is passed to the constructor.
-
-
-
Parameters
-
- -
  fn: (data: Data) => Response
  -
  -
  The function that should be defined.
  -
  -
  - -
    - (data: Data): Response
    -
    - -
      Parameters
      -
      - -
        data: Data
        -
      -
      Returns Response
      -
    -
  -
-
Returns void
-

- -

emitDestroy

emitDestroy(): void

-
-
- Defined in node_modules/@types/node/async_hooks.d.ts:154
-
-
-
-
Call AsyncHooks destroy callbacks.
-
-
-
Returns void
-

- -

Protected getMainWorker

getMainWorker(): MainWorker

-
-
- Defined in src/worker/abstract-worker.ts:113
-
-
-
-
Returns the main worker.
-
-
-
Returns MainWorker
-
Reference to the main worker.
-

- -

Protected handleError

handleError(e: string | Error): string

-
-
- Defined in src/worker/abstract-worker.ts:142
-
-
-
-
Handle an error and convert it to a string so it can be sent back to the main worker.
-
-
-
Parameters
-
- -
  e: string | Error
  -
  -
  The error raised by the worker.
  -
  -
-
Returns string
-
Message of the error.
-

- -

Protected run

run(fn: (data?: Data) => Response, value: MessageValue<Data, unknown>): void

-
-
- Defined in src/worker/abstract-worker.ts:152
-
-
-
-
Run the given function synchronously.
-
-
-
Parameters
-
- -
  fn: (data?: Data) => Response
  -
  -
  Function that will be executed.
  -
  -
  - -
    - (data?: Data): Response
    -
    - -
      Parameters
      -
      - -
        Optional data: Data
        -
      -
      Returns Response
      -
    -
  -
- -
  value: MessageValue<Data, unknown>
  -
  -
  Input data for the given function.
  -
  -
-
Returns void
-

- -

Protected runAsync

runAsync(fn: (data?: Data) => Promise<Response>, value: MessageValue<Data, unknown>): void

-
-
- Defined in src/worker/abstract-worker.ts:173
-
-
-
-
Run the given function asynchronously.
-
-
-
Parameters
-
- -
  fn: (data?: Data) => Promise<Response>
  -
  -
  Function that will be executed.
  -
  -
  - -
    - (data?: Data): Promise<Response>
    -
    - -
      Parameters
      -
      - -
        Optional data: Data
        -
      -
      Returns Promise<Response>
      -
    -
  -
- -
  value: MessageValue<Data, unknown>
  -
  -
  Input data for the given function.
  -
  -
-
Returns void
-

- -

runInAsyncScope

runInAsyncScope<This, Result>(fn: (...args: any[]) => Result, thisArg?: This, ...args: any[]): Result

-
-
- Defined in node_modules/@types/node/async_hooks.d.ts:149
-
-
-
-
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.
-
-
-
Type parameters
-
- -
  This
  -
- -
  Result
  -
-
Parameters
-
- -
  fn: (...args: any[]) => Result
  -
  -
  The function to call in the execution context of this - async resource.
  -
  -
  - -
    - (...args: any[]): Result
    -
    - -
      Parameters
      -
      - -
        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
-

- -

Protected Abstract sendToMainWorker

sendToMainWorker(message: MessageValue<Response, unknown>): void

-
-
- Defined in src/worker/abstract-worker.ts:125
-
-
-
-
Send a message to the main worker.
-
-
-
Parameters
-
- -
  message: MessageValue<Response, unknown>
  -
  -
  The response message.
  -
  -
-
Returns void
-

- -

triggerAsyncId

triggerAsyncId(): number

-
-
- Defined in node_modules/@types/node/async_hooks.d.ts:164
-
-
Returns number
-
the trigger ID for this AsyncResource instance.
-

- -

Static bind

bind<Func>(fn: Func, type?: string): Func & { asyncResource: AsyncResource }

-
-
- Defined in node_modules/@types/node/async_hooks.d.ts:130
-
-
-
-
Binds the given function to the current execution context.
-
-
-
Type parameters
-
- -
  Func: (...args: any[]) => any
  -
-
Parameters
-
- -
  fn: Func
  -
  -
  The function to bind to the current execution context.
  -
  -
- -
  Optional type: string
  -
  -
  An optional name to associate with the underlying AsyncResource.
  -
  -
-
Returns Func & { asyncResource: AsyncResource }
-

- -

Base class containing some shared logic for all poolifier workers.

Type parameters

MainWorker: 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

Properties

Methods

Constructors

constructor

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

Overrides AsyncResource.constructor
- Defined in src/worker/abstract-worker.ts:42
+
Constructs a new poolifier worker.
+
Type parameters
- MainWorker: 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: (data: 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.

Protected lastTaskTimestamp

lastTaskTimestamp: number

Timestamp of the last task processed by this worker.

Protected mainWorker

mainWorker: undefined | null | MainWorker

Readonly opts

opts: WorkerOptions = ...

Methods

asyncId

asyncId(): number

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

bind

bind<Func>(fn: Func): Func & { asyncResource: AsyncResource }

Inherited from AsyncResource.bind
- Defined in node_modules/@types/node/async_hooks.d.ts:288
+
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: (...args: any[]) => any
Parameters
- fn: Func
  +
  The function to bind to the current AsyncResource.
  +
Returns Func & { asyncResource: AsyncResource }

Protected checkAlive

checkAlive(): void

- Defined in src/worker/abstract-worker.ts:133
+
Check to see if the worker should be terminated, because its living too long.
+
Returns void

Private checkFunctionInput

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

- Defined in src/worker/abstract-worker.ts:107
+
Check if the fn parameter is passed to the constructor.
+
Parameters
- fn: (data: Data) => Response
  +
  The function that should be defined.
  +
  - - (data: Data): Response
    - Parameters
      - data: Data
      Returns Response
Returns void

Private checkWorkerOptions

checkWorkerOptions(opts: WorkerOptions): void

- Defined in src/worker/abstract-worker.ts:92
Parameters
- opts: WorkerOptions
Returns void

emitDestroy

emitDestroy(): AbstractWorker<MainWorker, Data, Response>

Inherited from AsyncResource.emitDestroy
- Defined in node_modules/@types/node/async_hooks.d.ts:311
+
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.
+

Protected getMainWorker

getMainWorker(): MainWorker

- Defined in src/worker/abstract-worker.ts:116
+
Returns the main worker.
+
Returns MainWorker
Reference to the main worker.
+

Protected handleError

handleError(e: string | Error): string

- Defined in src/worker/abstract-worker.ts:148
+
Handle an error and convert it to a string so it can be sent back to the main worker.
+
Parameters
- e: string | Error
  +
  The error raised by the worker.
  +
Returns string
Message of the error.
+

Protected run

run(fn: (data?: Data) => Response, value: MessageValue<Data, unknown>): void

- Defined in src/worker/abstract-worker.ts:158
+
Run the given function synchronously.
+
Parameters
- fn: (data?: Data) => Response
  +
  Function that will be executed.
  +
  - - (data?: Data): Response
    - Parameters
      - Optional data: Data
      Returns Response
- value: MessageValue<Data, unknown>
  +
  Input data for the given function.
  +
Returns void

Protected runAsync

runAsync(fn: (data?: Data) => Promise<Response>, value: MessageValue<Data, unknown>): void

- Defined in src/worker/abstract-worker.ts:179
+
Run the given function asynchronously.
+
Parameters
- fn: (data?: Data) => Promise<Response>
  +
  Function that will be executed.
  +
  - - (data?: Data): Promise<Response>
    - Parameters
      - Optional data: Data
      Returns Promise<Response>
- value: MessageValue<Data, unknown>
  +
  Input data for the given function.
  +
Returns void

runInAsyncScope

runInAsyncScope<This, Result>(fn: (...args: any[]) => Result, thisArg?: This, ...args: any[]): Result

Inherited from AsyncResource.runInAsyncScope
- Defined in node_modules/@types/node/async_hooks.d.ts:303
+
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: (...args: any[]) => Result
  +
  The function to call in the execution context of this async resource.
  +
  - - (...args: any[]): Result
    - Parameters
      - 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

Protected Abstract sendToMainWorker

sendToMainWorker(message: MessageValue<Response, unknown>): void

- Defined in src/worker/abstract-worker.ts:128
+
Send a message to the main worker.
+
Parameters
- message: MessageValue<Response, unknown>
  +
  The response message.
  +
Returns void

triggerAsyncId

triggerAsyncId(): number

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

Static bind

bind<Func, ThisArg>(fn: Func, type?: string, thisArg?: ThisArg): Func & { asyncResource: AsyncResource }

Inherited from AsyncResource.bind
- Defined in node_modules/@types/node/async_hooks.d.ts:273
+
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: (...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 }

Type parameters

MainWorker: Worker | MessagePort

Data = unknown

Response = unknown

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type parameters

MainWorker: Worker | MessagePort

Data = unknown

Response = unknown

Parameters

type: string

isMain: boolean

fn: (data: Data) => Response

Parameters

data: Data

Returns Response

Optional mainWorker: null | MainWorker

opts: WorkerOptions = ...

Returns AbstractWorker<MainWorker, Data, Response>

Properties

Protected Readonly async

Protected Optional Readonly interval

Protected Readonly killBehavior

Protected lastTask

Protected Optional mainWorker

Protected Readonly maxInactiveTime

Readonly opts

Methods

asyncId

Returns number

bind

Type parameters

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

Parameters

fn: Func

Returns Func & { asyncResource: AsyncResource }

Protected checkAlive

Returns void

Private checkFunctionInput

Parameters

fn: (data: Data) => Response

Parameters

data: Data

Returns Response

Returns void

emitDestroy

Returns void

Protected getMainWorker

Returns MainWorker

Protected handleError

Parameters

e: string | Error

Returns string

Protected run

Parameters

fn: (data?: Data) => Response

Parameters

Optional data: Data

Returns Response

value: MessageValue<Data, unknown>

Returns void

Protected runAsync

Parameters

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

Parameters

Optional data: Data

Returns Promise<Response>

value: MessageValue<Data, unknown>

Returns void

runInAsyncScope

Type parameters

This

Result

Parameters