ThreadWorker | poolifier

Hierarchy

AbstractWorker<MessagePort, Data, Response> +
AbstractWorker<MessagePort, Data, Response>
- ThreadWorker

Defined in src/worker/thread-worker.ts:21

@@ -55,9 +57,10 @@ but the minimum number of workers will be guaranteed.

Properties

aliveInterval? +isMain lastTaskTimestamp mainWorker -opts +opts

Methods

@@ -80,7 +83,7 @@ but the minimum number of workers will be guaranteed.

constructor

new ThreadWorker<Data, Response>(fn: ((data: Data) => Response), opts?: WorkerOptions): ThreadWorker<Data, Response>
new ThreadWorker<Data, Response>(fn: ((data: Data) => Response), opts?: WorkerOptions): ThreadWorker<Data, Response>
Constructs a new poolifier thread worker.

@@ -95,38 +98,46 @@ but the minimum number of workers will be guaranteed.

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

Returns Response

opts: WorkerOptions = {}

Options for the worker.

Returns ThreadWorker<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:31

`Protected` `Readonly` isMain

isMain: boolean

Whether this is the main worker or not.

`Protected` lastTaskTimestamp

lastTaskTimestamp: number

@@ -134,21 +145,23 @@ but the minimum number of workers will be guaranteed.

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

`Protected` mainWorker

mainWorker: undefined | null | MessagePort

`Readonly` opts

opts: WorkerOptions

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

`Protected` `Readonly` opts

opts: WorkerOptions = ...

Options for the worker.

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

Methods

@@ -162,11 +175,11 @@ but the minimum number of workers will be guaranteed.

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 @@ -183,28 +196,28 @@ 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 AbstractWorker.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
Inherited from AbstractWorker.checkAlive
- Defined in src/worker/abstract-worker.ts:144

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

emitDestroy

emitDestroy(): ThreadWorker<Data, Response>
emitDestroy(): ThreadWorker<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 @@ -213,10 +226,10 @@ never be called.

Returns
A reference to asyncResource.

-
Returns ThreadWorker<Data, Response>
+
Returns ThreadWorker<Data, Response>
Inherited from AbstractWorker.emitDestroy
- Defined in node_modules/@types/node/ts4.8/async_hooks.d.ts:311

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

`Protected` getMainWorker

Returns MessagePort

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

`Protected` handleError

handleError(e: string | Error): string
-
Handle an error and convert it to a string so it can be sent back to the main worker.
+
Handles an error and convert it to a string so it can be sent back to the main worker.

Returns
Message of the error.

@@ -249,104 +262,110 @@ never be called.

Returns string
Inherited from AbstractWorker.handleError
- Defined in src/worker/abstract-worker.ts:159

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

`Protected` messageListener

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

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 @@ -366,52 +385,52 @@ 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.

Template

Template

Author

Since

Type Parameters

Data = unknown

Data = unknown

Response = unknown

Response = unknown

Hierarchy

Properties

Methods

constructor

Parameters

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

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

Parameters

data: Data

Returns Response

data: Data

Returns Response

opts: WorkerOptions = {}

Returns ThreadWorker<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

emitDestroy

Returns

Returns ThreadWorker<Data, Response>

Protected getMainWorker

Returns MessagePort

Protected handleError

Returns

Returns string

Protected messageListener

Parameters

value: MessageValue<Data, MessagePort>

message: MessageValue<Data, MessagePort>

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

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

Parameters

data: Data

Returns Response

data: Data

Returns Response

Returns void

Protected run

Parameters

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

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

Parameters

Optional data: Data

Returns Response

Optional data: Data

Returns Response

value: MessageValue<Data, unknown>

message: MessageValue<Data, unknown>

Returns void

Protected runAsync

Parameters

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

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

Parameters

Optional data: Data

Returns Promise<Response>

Optional data: Data

Returns Promise<Response>

`Protected` `Optional` `Readonly` aliveInterval

`Protected` `Readonly` isMain

`Protected` lastTaskTimestamp

`Protected` mainWorker

`Readonly` opts

`Protected` `Readonly` opts

`Protected` checkAlive

`Protected` getMainWorker

`Protected` handleError

`Protected` messageListener

`Protected` run

`Optional` data: Data

`Optional` data: Data

`Protected` runAsync

`Optional` data: Data

`Optional` data: Data

`Rest` ...args: any[]

`Optional` thisArg: This

`Optional` thisArg: This

`Rest` ...args: any[]

`Protected` sendToMainWorker

`Static` bind

`Optional` thisArg: ThisArg