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.
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
@@ -401,113 +359,132 @@ then restore the original execution context.
Since
v9.6.0
-
+
Type Parameters
-
+
-
This
+
This
-
Result
+
Result
Parameters
-
fn: ((this: This, ...args: any[]) => Result)
+
fn: ((this, ...args) => Result)
The function to call in the execution context of this async resource.
Base class containing some shared logic for all poolifier workers.
+Base class that implements some shared logic for all poolifier workers.
Type Parameters
-+-
-
-
-
-
-
MainWorker extends Worker | MessagePort
+MainWorker extends Worker | MessagePort
Type of main worker.
Data = unknown
+Data = unknown
Type of data this worker receives from pool's execution. This can only be serializable data.
Response = unknown
+Response = unknown
Type of response the worker sends back to the main worker. This can only be serializable data.
Hierarchy
-- AsyncResource
+
- AsyncResource
- AbstractWorker
-- ClusterWorker
-- ThreadWorker
@@ -49,350 +51,306 @@
constructor
+constructor
alivealive
asyncasync
+
+
-
-
-
-
-
-
+-
-
-
-
-
+Defined in src/worker/abstract-worker.ts:52
+
alive
-alive
+
+Defined in src/worker/abstract-worker.ts:42
+
+is
+
+
last
+last
-
+Defined in src/worker/abstract-worker.ts:38
+
main
-
-opts: WorkerOptions
+Defined in src/worker/abstract-worker.ts:58
+
+opts: WorkerOptions = ...
+Defined in src/worker/abstract-worker.ts:59
+
+task
+
+
-
+Defined in node_modules/.pnpm/@types+node@20.2.5/node_modules/@types/node/async_hooks.d.ts:306
+
-
-
-
-
+Defined in node_modules/.pnpm/@types+node@20.2.5/node_modules/@types/node/async_hooks.d.ts:283
+
-
+Defined in src/worker/abstract-worker.ts:86
+
-
+Defined in node_modules/.pnpm/@types+node@20.2.5/node_modules/@types/node/async_hooks.d.ts:302
+
-
-
+
+
-
+constructor
+alive
+is
+last
+main
+opts
+task
+async
+bind
+check
+check
+check
+emit
+get
+get
+handle
+message
+run
+run
+run
+send
+trigger
+bind
+
+
Constructors
-Properties
-Methods
-Constructors
-constructor
--- new
+
+- new
-
+
-
-
+-
-
Constructs a new poolifier worker.
Type Parameters
-+-
-
+
MainWorker extends Worker | MessagePort
MainWorker extends Worker | MessagePort
Data = unknown
Data = unknown
Response = unknown
Response = unknown
Parameters
type: string
+type: string
The type of async event.
isMain: boolean
+isMain: boolean
Whether this is the main worker or not.
fn: ((data: Data) => Response)
-Function processed by the worker when the pool's
-executionfunction is invoked.--
-
-- (data: Data): Response
--
-
-
-
Parameters
---
-
data: Data
Returns Response
taskFunctions: WorkerFunction<Data, Response> | TaskFunctions<Data, Response>
+Task function(s) processed by the worker when the pool's
+executionfunction is invoked. The first function is the default function.mainWorker: undefined | null | MainWorker
+mainWorker: undefined | null | MainWorker
Reference to main worker.
opts: WorkerOptions = ...
+opts: WorkerOptions = ...
Options for the worker.
Returns AbstractWorker<MainWorker, Data, Response>
Properties
-
-ProtectedOptionalReadonlyaliveHandler Id of the
+aliveIntervalworker alive check.Handler id of the
aliveIntervalworker alive check.
+ProtectedReadonlyisWhether this is the main worker or not.
+
-ProtectedlastTimestamp of the last task processed by this worker.
-Protectedmain
-Readonlyopts
+ProtectedReadonlyoptsOptions for the worker.
+ProtectedtaskTask function(s) processed by the worker when the pool's
+executionfunction is invoked.Methods
-async
--- async
+
+- async
-
-
-
-
Returns
The unique
-asyncIdassigned to the resource.Returns number
bind
--- bind<Func>(fn: Func): Func & { asyncResource: AsyncResource }
+
+- bind<Func>(fn): Func
-
+
+
Binds the given function to execute to this
-AsyncResource's scope.The returned function will have an
asyncResourceproperty referencing -theAsyncResourceto which the function is bound.Since
v14.8.0, v12.19.0
Type Parameters
-+-
-
Func extends ((...args: any[]) => any)
Func extends ((...args) => any)
Parameters
fn: Func
+fn: Func
The function to bind to the current
AsyncResource.Returns Func & { asyncResource: AsyncResource }
-Protectedcheck-- check
+
+- check
-
-
-
+
+
-
+- Defined in src/worker/abstract-worker.ts:98
+
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
-
-Privatecheck-- check
+- Defined in src/worker/abstract-worker.ts:179
+Privatecheck+- check
-
-
-
-
+
Check if the
+fnparameter is passed to the constructor.Checks if the
taskFunctionsparameter is passed to the constructor.Parameters
fn: ((data: Data) => Response)
-The function that should be defined.
---
-
-- (data: Data): Response
--
-
-
-
Parameters
---
-
data: Data
Returns Response
taskFunctions: WorkerFunction<Data, Response> | TaskFunctions<Data, Response>
+The task function(s) parameter that should be checked.
+Returns void
-Privatecheck-- check
+
+- check
-
-
-
+
Parameters
opts: WorkerOptions
opts: WorkerOptions
Returns void
emit
--- emit
+
+- emit
-
Call all
- -destroyhooks. 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 thedestroyhooks will never be called.Returns
A reference to
asyncResource.Returns AbstractWorker<MainWorker, Data, Response>
-Protectedget-- get
+
+- get
-
Returns the main worker.
- -Returns
Reference to the main worker.
Returns MainWorker
-Protectedhandle-- handle
+- Defined in src/worker/abstract-worker.ts:162
+Privateget+- get
-
-
-
+
-
+
+
Handle an error and convert it to a string so it can be sent back to the main worker.
- -Returns
Message of the error.
+Gets the task function in the given scope.
Parameters
-
-
-e: string | Error
-The error raised by the worker.
+
+Optionalname: stringName of the function that will be returned.
Returns string
-Protectedmessage-- message
--
-
-
-
Parameters
---
-
--
-
+
value: MessageValue<Data, MainWorker>
fn: ((data: Data) => Response)
---
-
+-- (data: Data): Response
+- Defined in src/worker/abstract-worker.ts:265
+Protectedhandle+- handle
-
+
-
-
-
Handles an error and convert it to a string so it can be sent back to the main worker.
+Parameters
data: Data
Returns Response
Returns void
Returns string
Message of the error.
+ -
-Protectedrun-- run(fn: ((data?: Data) => Response), value: MessageValue<Data, unknown>): void
+- Defined in src/worker/abstract-worker.ts:194
+Protectedmessage+- message
-
-
+- Defined in src/worker/abstract-worker.ts:138
+
-
+- Defined in src/worker/abstract-worker.ts:233
+
+
-
-
-
-
+
+-
-
-
-
-
+
+
+- Defined in node_modules/.pnpm/@types+node@20.2.5/node_modules/@types/node/async_hooks.d.ts:277
+
+
-
-
Run the given function synchronously.
+Worker message listener.
Parameters
-
-
--
-
-fn: ((data?: Data) => Response)
-Function that will be executed.
---
-
-- (data?: Data): Response
--
-
-
-
Parameters
---
-
Optionaldata: DataReturns Response
value: MessageValue<Data, unknown>
-Input data for the given function.
+message: MessageValue<Data, MainWorker>
+Message received.
Returns void
-Protectedrun-- run
+
+- run
-
-
-
-
+
-
-
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
---
-
Optionaldata: DataReturns Promise<Response>
value: MessageValue<Data, unknown>
+message: MessageValue<Data, Worker | MessagePort>
Input data for the given function.
Returns void
run
--- run
+
+- run
-
+
-
-
Call the provided function with the provided arguments in the execution context of the async resource. This will establish the context, trigger the AsyncHooks @@ -401,113 +359,132 @@ then restore the original execution context.
Since
v9.6.0
Type Parameters
-+-
-
+
This
This
Result
Result
Parameters
fn: ((this: This, ...args: any[]) => Result)
+fn: ((this, ...args) => Result)
The function to call in the execution context of this async resource.
-- (this: This, ...args: any[]): Result
+
+- (this, ...args): Result
-
-
-
+-
-
-
Parameters
this: This
this: This
Rest...args: any[]Returns Result
Rest...args: any[]Returns Result
+OptionalthisArg: ThisOptionalthisArg: ThisThe receiver to be used for the function call.
+Rest...args: any[]Rest...args: any[]Optional arguments to pass to the function.
Returns Result
+
+Protectedrun+- run
+-
+
+
+
Runs the given function synchronously.
+Parameters
++-
+
+-
+
fn: WorkerSyncFunction<Data, Response>
+Function that will be executed.
+message: MessageValue<Data, Worker | MessagePort>
+Input data for the given function.
+Returns void
-ProtectedAbstractsend-- send
+
+- send
-
-
-
-
+- Defined in src/worker/abstract-worker.ts:174
+
-
+- Defined in node_modules/.pnpm/@types+node@20.2.5/node_modules/@types/node/async_hooks.d.ts:311
+
+
-
-
-
-
-
-
-
Send a message to the main worker.
+Sends a message to the main worker.
Parameters
message: MessageValue<Response, unknown>
+message: MessageValue<Response, Worker | MessagePort>
The response message.
Returns void
-trigger
--- trigger
+
+- trigger
-
-
-
-
Returns
The same
-triggerAsyncIdthat is passed to theAsyncResourceconstructor.Returns number
-Staticbind-- bind<Func, ThisArg>(fn: Func, type?: string, thisArg?: ThisArg): Func & { asyncResource: AsyncResource }
+
+- bind<Func, ThisArg>(fn, type?, thisArg?): Func
-
+
-
-
Binds the given function to the current execution context.
-The returned function will have an
asyncResourceproperty referencing -theAsyncResourceto which the function is bound.Since
v14.8.0, v12.19.0
Type Parameters
-+-
-
+
Func extends ((this: ThisArg, ...args: any[]) => any)
Func extends ((this, ...args) => any)
ThisArg
ThisArg
Parameters
fn: Func
+fn: Func
The function to bind to the current execution context.
+Optionaltype: stringOptionaltype: stringAn optional name to associate with the underlying
AsyncResource.OptionalthisArg: ThisArgReturns Func & { asyncResource: AsyncResource }
Returns Func
-
+Settings
Settings
Member Visibility
Theme
+
On This Page
-- poolifier
-
Generated using TypeDoc