From 0104449a0a01f252dc9bec8f36164134f3bbe89f Mon Sep 17 00:00:00 2001
From: Documentation Bot Protected Readonlyis
ProtectedlastProtectedoptsProtected OptionalstatisticsProtectedtaskProtected ReadonlytaskProtectedtaskProtectedgetProtectedgetGets the task function operation UUID for a request or response.
+The task function operation message.
+The task function operation UUID if available.
+ProtectedhandleProtectedhandleProtectedhandleProtectedhandleHandles a task function operation. +Deferred overrides must retain the task function properties reference or the +operation UUID when forwarding outside the incoming asynchronous context. +An acknowledgement without a recoverable UUID rejects the pool operation.
+The task function operation request.
+ProtectedmessageProtected ReadonlyrunProtected ReadonlyrunProtected ReadonlyrunProtectedsendProtected ReadonlysendOptionalemitterProtected ReadonlyfileProtected Optional ReadonlymaximumProtected ReadonlyminimumProtected ReadonlyoptsProtectedpromiseProtectedstartedProtectedstartingProtected OptionalworkerReadonlyworkerProtectedbusyProtectedtypeProtectedworkerProtectedafterHook executed after the worker task execution. +
Hook executed after task execution for a live worker node. +Recovered responses from removed worker nodes do not invoke this hook. Can be overridden.
The worker node key.
+The live worker node key.
The received message.
@@ -355,7 +356,7 @@ Can be overridden.ProtectedafterProtectedbeforeProtectedcheckProtectedcheckProtectedcreateProtectedcreateProtectedderegisterProtecteddestroyProtectedflagProtectedflushProtectedgetProtectedinternalProtectedinternalProtectedisProtectedregisterProtectedregisterProtectedsendProtectedsendProtectedsetupProtectedshallProtected ReadonlyworkerOptionalemitterProtected ReadonlyfileProtected Optional ReadonlymaximumProtected ReadonlyminimumProtected ReadonlyoptsProtectedpromiseProtectedstartedProtectedstartingProtected OptionalworkerReadonlyworkerProtectedbusyProtectedtypeProtectedworkerProtectedafterHook executed after the worker task execution. +
Hook executed after task execution for a live worker node. +Recovered responses from removed worker nodes do not invoke this hook. Can be overridden.
The worker node key.
+The live worker node key.
The received message.
@@ -355,7 +356,7 @@ Can be overridden.ProtectedafterProtectedbeforeProtectedcheckProtectedcheckProtectedcreateProtectedcreateProtectedderegisterProtecteddestroyProtectedflagProtectedflushProtectedgetProtectedinternalProtectedinternalProtectedisProtectedregisterProtectedregisterProtectedsendProtectedsendProtectedsetupProtectedshallProtected ReadonlyworkerOptionalemitterProtected ReadonlyfileProtected Optional ReadonlymaximumProtected ReadonlyminimumProtected ReadonlyoptsProtectedpromiseProtectedstartedProtectedstartingProtected OptionalworkerReadonlyworkerProtectedbusyProtectedtypeProtectedworkerProtectedafterHook executed after the worker task execution. +
Hook executed after task execution for a live worker node. +Recovered responses from removed worker nodes do not invoke this hook. Can be overridden.
The worker node key.
+The live worker node key.
The received message.
@@ -355,7 +356,7 @@ Can be overridden.ProtectedafterProtectedbeforeProtectedcheckProtectedcheckProtectedcreateProtectedcreateProtectedderegisterProtecteddestroyProtectedflagProtectedflushProtectedgetProtectedinternalProtectedinternalProtectedisProtectedregisterProtectedregisterProtectedsendProtectedsendProtectedsetupProtectedshallProtected ReadonlyworkerOptionalemitterProtected ReadonlyfileProtected Optional ReadonlymaximumProtected ReadonlyminimumProtected ReadonlyoptsProtectedpromiseProtectedstartedProtectedstartingProtected OptionalworkerReadonlyworkerProtectedbusyProtectedtypeProtectedworkerProtectedafterHook executed after the worker task execution. +
Hook executed after task execution for a live worker node. +Recovered responses from removed worker nodes do not invoke this hook. Can be overridden.
The worker node key.
+The live worker node key.
The received message.
@@ -355,7 +356,7 @@ Can be overridden.ProtectedafterProtectedbeforeProtectedcheckProtectedcheckProtectedcreateProtectedcreateProtectedderegisterProtecteddestroyProtectedflagProtectedflushProtectedgetProtectedinternalProtectedinternalProtectedisProtectedregisterProtectedregisterProtectedsendProtectedsendProtectedsetupProtectedshallProtected ReadonlyworkerProtected ReadonlyisProtectedlastProtectedoptsProtected OptionalstatisticsProtectedtaskProtected ReadonlytaskCorrelation of task function operations across protected handler overrides.
+ProtectedtaskProtectedgetProtectedgetGets the task function operation UUID for a request or response.
+The task function operation message.
+The task function operation UUID if available.
+ProtectedhandleProtectedhandleHandles a kill message sent by the main worker.
@@ -268,9 +297,9 @@ If a task function with the same name already exists, it is replaced.The kill message.
ProtectedhandleProtectedhandleHandles a task function operation. +Deferred overrides must retain the task function properties reference or the +operation UUID when forwarding outside the incoming asynchronous context. +An acknowledgement without a recoverable UUID rejects the pool operation.
+The task function operation request.
+ProtectedmessageProtected ReadonlyrunProtected ReadonlyrunProtected ReadonlyrunProtectedsendProtected ReadonlysendProtectedstartedWhether the pool is started or not.
ProtectedstartingWhether the pool is starting or not.
Protected OptionalworkerWorker choice strategies context referencing worker choice algorithms implementation.
ReadonlyworkerThe pool back pressure boolean status.
Protected AbstractbusyThe pool busyness boolean status.
Protected AbstracttypeProtected AbstractworkerProtectedafterHook executed after the worker task execution. +
Hook executed after task execution for a live worker node. +Recovered responses from removed worker nodes do not invoke this hook. Can be overridden.
The worker node key.
+The live worker node key.
The received message.
ProtectedafterProtectedbeforeProtected AbstractcheckProtected AbstractcheckProtectedcreateNew, completely set up dynamic worker node key.
ProtectedcreateNew, completely set up worker node key.
Protected AbstractderegisterProtecteddestroyProtectedflagProtectedflushProtectedgetThe worker information.
ProtectedinternalWorker nodes back pressure boolean status.
ProtectedinternalWorker nodes busyness boolean status.
Protected Abstractistrue if the worker is the main worker, false otherwise.
Protected AbstractregisterProtected AbstractregisterProtected AbstractsendProtected AbstractsendProtectedsetupProtected AbstractshallWhether to create a dynamic worker or not.
Protected ReadonlyworkerProtectedgetGets the task function operation UUID for a request or response.
+The task function operation message.
+The task function operation UUID if available.
+Protected AbstracthandleThe worker error object.
ProtectedhandleProtected AbstracthandleProtectedhandleHandles a task function operation. +Deferred overrides must retain the task function properties reference or the +operation UUID when forwarding outside the incoming asynchronous context. +An acknowledgement without a recoverable UUID rejects the pool operation.
+The task function operation request.
+Whether the worker has a task function with the given name or not.
The properties of the worker's task functions.
ProtectedmessageWhether the task function existed and was removed or not.
Protected ReadonlyrunProtected ReadonlyrunProtected ReadonlyrunProtectedsendProtected AbstractsendWhether the default task function was set or not.
Readonlyenablepoolifier:<PoolType>-<Wo
Returns void
Readonlyexecutepoolifier:<PoolType>-<Wo
The optional name of the task function to execute. If not specified, the default task function will be executed.
OptionalabortSignal: AbortSignal
-The optional AbortSignal to abort the task.
+The optional AbortSignal to abort the task. An already-aborted signal prevents submission.
OptionaltransferList: readonly Transferable[]
The optional array of transferable objects to transfer ownership of. Ownership of the transferred objects is given to the chosen pool's worker_threads worker and they should not be used in the main thread afterwards.
@@ -175,7 +175,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
Returns Promise<Response>
Promise with a task function response that will be fulfilled when the task is completed.
+Defined in src/pools/pool.ts:139
Readonlyhas Task Function
hasTaskFunction: (name: string) => boolean
@@ -197,14 +197,14 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
Returns boolean
true if the task function exists, false otherwise.
ReadonlyinfoPool information.
Readonlylistpoolifier:<PoolType>-<Wo
Returns TaskFunctionProperties[]
The properties of task functions available in this pool.
Readonlymappoolifier:<PoolType>-<Wo
The optional name of the task function to execute. If not specified, the default task function will be executed.
OptionalabortSignals: Iterable<AbortSignal, any, any>
-The optional iterable of AbortSignal to abort the tasks iterable.
+The optional AbortSignal iterable matching the input order and length.
OptionaltransferList: readonly Transferable[]
The optional array of transferable objects to transfer ownership of. Ownership of the transferred objects is given to the chosen pool's worker_threads worker and they should not be used in the main thread afterwards.
@@ -251,7 +251,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
Returns Promise<Response[]>
Promise with an array of task function responses that will be fulfilled when the tasks are completed.
+Defined in src/pools/pool.ts:168
Readonlyremove Task Function
removeTaskFunction: (name: string) => Promise<boolean>
@@ -273,7 +273,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
Returns Promise<boolean>
true if the task function was removed, false otherwise.
Readonlysetpoolifier:<PoolType>-<Wo
Returns Promise<boolean>
true if the default task function was set, false otherwise.
Readonlysetpoolifier:<PoolType>-<Wo
Returns void
Readonlysetpoolifier:<PoolType>-<Wo
Returns void
Readonlysetpoolifier:<PoolType>-<Wo
Returns boolean
true if the worker choice strategy options were set, false otherwise.
ReadonlystartStarts the minimum number of workers in this pool.
EventEmitter instance. The value can be
Optionalenvhttps://nodejs.org/api/cluster.html#cluster_cluster_fork_env
Optionalerror() => {}
Optionalexit() => {}
Optionalmessage() => {}
Optionalonline() => {}
OptionalrestartRestart worker on error.
Optionalsettingshttps://nodejs.org/api/cluster.html#cluster_cluster_settings
OptionalstartOptionaltasksPool worker node tasks queue options.
OptionalworkerOptionalworkerThe worker choice strategy options.
Optionalworkerhttps://nodejs.org/api/worker_threads.html#new-workerfilename-options
Optional ReadonlyconcurrencyOptional ReadonlyloadOptional ReadonlysizeOptional ReadonlytasksOptional ReadonlytasksOptional ReadonlytasksOptional ReadonlytaskOptional ReadonlymeasurementMeasurement to use in worker choice strategy supporting it.
Optional ReadonlyrunOptional ReadonlywaitOptionalweightsOptionalkill() => {}
Optionalmax
Correlation of task function operations across protected handler overrides.
+