X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Finterfaces%2FIWorkerNode.html;h=8deaf2d1d78b7dc58166a9f44e952f917a1dd60e;hb=0bc53e954d6d832092db4ea6ccea8b0f8f071ebe;hp=fc8cc02b8b925724bc546dbee3ade02b7d45e860;hpb=b881e803f1a32ce8d8218d3ba3638ad317ae87bc;p=poolifier.git diff --git a/docs/interfaces/IWorkerNode.html b/docs/interfaces/IWorkerNode.html index fc8cc02b..8deaf2d1 100644 --- a/docs/interfaces/IWorkerNode.html +++ b/docs/interfaces/IWorkerNode.html @@ -1,13 +1,13 @@ -
Readonly
clearReadonly
clearReadonly
closeReadonly
deleteDeletes task function worker usage statistics.
+The task function name.
+true
if the task function worker usage statistics were deleted, false
otherwise.
Readonly
dequeueReadonly
enqueueEnqueue task.
The task to queue.
The task queue size.
+The tasks queue size.
Readonly
getReadonly
getGets task worker usage statistics.
+Gets task function worker usage statistics.
The task function name.
+The task function worker usage statistics if the task function worker usage statistics are initialized, undefined
otherwise.
Readonly
hasWhether the worker node has back pressure (i.e. its tasks queue is full).
+true
if the worker node has back pressure, false
otherwise.
Readonly
infoOptional
Readonly
messageMessage channel (worker_threads only).
+Readonly
popReadonly
resetResets usage statistics .
+Resets usage statistics.
Optional
strategyWorker choice strategy data. +This is used to store data that are specific to the worker choice strategy.
+Tasks queue back pressure size. +This is the number of tasks that can be enqueued before the worker node has back pressure.
+Readonly
tasksTasks queue size.
Readonly
unshiftPrepends a task to the tasks queue.
+The task to prepend.
+The tasks queue size.
+ +Readonly
usageWorker usage statistics.
Readonly
workerAppends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.
+The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.
+When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.
+When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.
+When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.
+If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.
+The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.
+ +Optional
options: boolean | AddEventListenerOptionsInherited from EventTarget.addEventListener
+Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.
+ +Inherited from EventTarget.dispatchEvent
+Removes the event listener in target's event listener list with the same type, callback, and options.
+ +Optional
options: boolean | EventListenerOptionsInherited from EventTarget.removeEventListener
+Generated using TypeDoc
Generated using TypeDoc
+ \ No newline at end of file
Close communication channel.
+Closes communication channel.
Returns void