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.
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.
A cluster worker used by a poolifier
-ClusterPool.When this worker is inactive for more than the given
maxInactiveTime, ++- Preparing search index...
+- The search index is not available
poolifier+- poolifier
+- ClusterWorker
+Class ClusterWorker<Data, Response>
A cluster worker used by a poolifier
+ClusterPool.When this worker is inactive for more than the given
maxInactiveTime, it will send a termination request to its main worker.If you use a
-DynamicClusterPoolthe extra workers that were created will be terminated, but the minimum number of workers will be guaranteed.of data this worker receives from pool's execution. This can only be serializable data.
-of response the worker sends back to the main worker. This can only be serializable data.
-Christopher Quadflieg
-2.0.0
-Type parameters
Data = unknown
Response = unknown
Hierarchy
Index
Constructors
Properties
Methods
Constructors
constructor
Constructs a new poolifier cluster worker.
-Type parameters
Data = unknown
Response = unknown
Parameters
fn: (data: Data) => Response
Function processed by the worker when the pool's
-executionfunction is invoked.Parameters
data: Data
Returns Response
opts: WorkerOptions = {}
Options for the worker.
-Returns ClusterWorker<Data, Response>
Properties
Protected Optional Readonly alive
Handler Id of the
-aliveIntervalworker alive check.Protected last
Timestamp of the last task processed by this worker.
-Protected main
Readonly opts
Methods
async
Returns number
The unique
-asyncIdassigned to the resource.bind
Binds the given function to execute to this
-AsyncResource's scope.The returned function will have an
asyncResourceproperty referencing + +Author
Christopher Quadflieg
+ +Since
2.0.0
+Type Parameters
++-
+
+-
+
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
++- AbstractWorker<Worker, Data, Response>
+
+- ClusterWorker
+
+Index
Constructors
+Properties
+Methods
+Constructors
+constructor
++- new
+-
+
+
+
+
+
Constructs a new poolifier cluster worker.
+Type Parameters
++-
+
+-
+
Data = unknown
Response = unknown
Parameters
++-
+
+-
+
fn: ((data: Data) => Response)
+Function processed by the worker when the pool's
+executionfunction is invoked.+-
+
+- (data: Data): Response
+-
+
+
+
Parameters
++-
+
data: Data
Returns Response
opts: WorkerOptions = {}
+Options for the worker.
+Returns ClusterWorker<Data, Response>
Properties
+
+ProtectedOptionalReadonlyaliveHandler id of the
+aliveIntervalworker alive check.
+ProtectedReadonlyisWhether this is the main worker or not.
+
+ProtectedlastTimestamp of the last task processed by this worker.
+
+ProtectedmainReference to main worker.
+
+ProtectedReadonlyoptsOptions for the worker.
+Methods
+async
++- async
+-
+
+
+
Returns
The unique
+asyncIdassigned to the resource.Returns number
bind
++- bind<Func>(fn: Func): Func & {
+-
+
- since
    asyncResource: AsyncResource;
}
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.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 check
Check to see if the worker should be terminated, because its living too long.
-Returns void
emit
Call all
destroyhooks. This should only ever be called once. An error will + +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;
}
+Protectedcheck+- check
+-
+
Checks if the worker should be terminated, because its living too long.
+Returns void
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 ClusterWorker<Data, Response>
A reference to
-asyncResource.Protected get
Returns the main worker.
-Returns Worker
Reference to the main worker.
-Protected handle
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 the given function synchronously.
-Parameters
fn: (data?: Data) => Response
Function that will be executed.
-Parameters
Optional data: Data
Returns Response
value: MessageValue<Data, unknown>
Input data for the given function.
-Returns void
Protected run
Run the given function asynchronously.
-Parameters
fn: (data?: Data) => Promise<Response>
Function that will be executed.
-Parameters
Optional data: Data
Returns Promise<Response>
value: MessageValue<Data, unknown>
Input data for the given function.
-Returns void
run
Call the provided function with the provided arguments in the execution context + +
Returns
A reference to
+asyncResource.Returns ClusterWorker<Data, Response>
+
+Protectedget+- get
+-
+
Returns the main worker.
+ +Returns
Reference to the main worker.
+Returns Worker
+Protectedhandle+- handle
+-
+
+
+
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
+Protectedmessage+- message
+-
+
+
+
Worker message listener.
+Parameters
++-
+
+-
+
message: MessageValue<Data, Worker>
+Message received.
+fn: ((data: Data) => Response)
+Function processed by the worker when the pool's
+executionfunction is invoked.+-
+
+- (data: Data): Response
+-
+
+
+
Parameters
++-
+
data: Data
Returns Response
Returns void
+Protectedrun+- run(fn: ((data?: Data) => Response), message: MessageValue<Data, unknown>): void
+-
+
+
+
Runs the given function synchronously.
+Parameters
++-
+
+-
+
fn: ((data?: Data) => Response)
+Function that will be executed.
++-
+
+- (data?: Data): Response
+-
+
+
+
Parameters
++-
+
Optionaldata: DataReturns Response
message: MessageValue<Data, unknown>
+Input data for the given function.
+Returns void
+Protectedrun+- run
+-
+
+
+
Runs the given function asynchronously.
+Parameters
++-
+
+-
+
fn: ((data?: Data) => Promise<Response>)
+Function that will be executed.
++-
+
+- (data?: Data): Promise<Response>
+-
+
+
+
Parameters
++-
+
Optionaldata: DataReturns Promise<Response>
message: MessageValue<Data, unknown>
+Input data for the given function.
+Returns void
run
++- run
+-
+
- since
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.
-v9.6.0
-Type parameters
This
Result
Parameters
fn: (...args: any[]) => Result
The function to call in the execution context of this async resource.
-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 send
Send a message to the main worker.
-Parameters
message: MessageValue<Response, unknown>
The response message.
-Returns void
trigger
Returns number
The same
-triggerAsyncIdthat is passed to theAsyncResourceconstructor.Static bind
Binds the given function to the current execution context.
-The returned function will have an
asyncResourceproperty referencing + +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
+OptionalthisArg: ThisThe receiver to be used for the function call.
+
+Rest...args: any[]Optional arguments to pass to the function.
+Returns Result
+
+Protectedsend+- send
+-
+
+
+
Sends a message to the main worker.
+Parameters
++-
+
message: MessageValue<Response, unknown>
+The response message.
+Returns void
trigger
++- trigger
+-
+
+
+
Returns
The same
+triggerAsyncIdthat is passed to theAsyncResourceconstructor.Returns number
+Staticbind+- bind<Func, ThisArg>(fn: Func, type?: string, thisArg?: ThisArg): Func & {
+-
+
- since
    asyncResource: AsyncResource;
}
Binds the given function to the current execution context.
+The returned function will have an
-asyncResourceproperty referencing theAsyncResourceto which the function is bound.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 }
Generated using TypeDoc
Since
v14.8.0, v12.19.0
+