IWorkerNode | poolifier

X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIWorkerNode.html;h=8deaf2d1d78b7dc58166a9f44e952f917a1dd60e;hb=76369162548ededf89e0d513174a943cc330245c;hp=74ea58276c9b9cbfdb9e6eb0a96945c7c11d7679;hpb=51e49c70379025e6709ae33e5cb4bf91b22ccc41;p=poolifier.git diff --git a/docs/interfaces/IWorkerNode.html b/docs/interfaces/IWorkerNode.html index 74ea5827..8deaf2d1 100644 --- a/docs/interfaces/IWorkerNode.html +++ b/docs/interfaces/IWorkerNode.html @@ -1,4 +1,4 @@ -IWorkerNode | poolifier - v2.7.1

+IWorkerNode | poolifier - v3.0.4

@@ -35,9 +35,11 @@

Hierarchy

IWorkerNode

@@ -54,8 +56,6 @@ hasBackPressure info messageChannel? -onBackPressure? -onEmptyQueue? popTask resetUsage strategyData? @@ -64,6 +64,12 @@ unshiftTask usage worker +

Methods

addEventListener +dispatchEvent +removeEventListener

Properties

@@ -82,7 +88,7 @@

Returns void

Defined in src/pools/worker.ts:290

`Readonly` closeChannel

closeChannel: (() => void)

@@ -98,7 +104,7 @@

Returns void

Defined in src/pools/worker.ts:304

`Readonly` deleteTaskFunctionWorkerUsage

deleteTaskFunctionWorkerUsage: ((name) => boolean)

@@ -123,7 +129,7 @@

Defined in src/pools/worker.ts:318

`Readonly` dequeueTask

dequeueTask: (() => undefined | Task<Data>)

@@ -140,7 +146,7 @@

Defined in src/pools/worker.ts:280

`Readonly` enqueueTask

enqueueTask: ((task) => number)

@@ -165,7 +171,7 @@

Defined in src/pools/worker.ts:267

`Readonly` getTaskFunctionWorkerUsage

getTaskFunctionWorkerUsage: ((name) => undefined | WorkerUsage)

@@ -190,7 +196,7 @@

Defined in src/pools/worker.ts:311

`Readonly` hasBackPressure

hasBackPressure: (() => boolean)

@@ -207,7 +213,7 @@

Defined in src/pools/worker.ts:296

`Readonly` info

info: WorkerInfo

@@ -215,7 +221,7 @@

Defined in src/pools/worker.ts:236

`Optional` `Readonly` messageChannel

messageChannel?: MessageChannel

@@ -223,23 +229,7 @@

`Optional` onBackPressure

onBackPressure?: WorkerNodeEventCallback

Callback invoked when worker node tasks queue is back pressured.

`Optional` onEmptyQueue

onEmptyQueue?: WorkerNodeEventCallback

Callback invoked when worker node tasks queue is empty.

Defined in src/pools/worker.ts:249

`Readonly` popTask

popTask: (() => undefined | Task<Data>)

@@ -256,7 +246,7 @@

Defined in src/pools/worker.ts:286

`Readonly` resetUsage

resetUsage: (() => void)

@@ -272,16 +262,16 @@

Returns void

Defined in src/pools/worker.ts:300

`Optional` strategyData

strategyData?: StrategyData

Worker choice strategy data. -This is used to store data that is specific to the worker choice strategy.

+This is used to store data that are specific to the worker choice strategy.

Defined in src/pools/worker.ts:245

tasksQueueBackPressureSize

tasksQueueBackPressureSize: number

@@ -290,7 +280,7 @@ This is the number of tasks that can be enqueued before the worker node has back

Defined in src/pools/worker.ts:254

`Readonly` tasksQueueSize

tasksQueueSize: (() => number)

@@ -307,7 +297,7 @@ This is the number of tasks that can be enqueued before the worker node has back

Defined in src/pools/worker.ts:260

`Readonly` unshiftTask

unshiftTask: ((task) => number)

@@ -332,7 +322,7 @@ This is the number of tasks that can be enqueued before the worker node has back

Defined in src/pools/worker.ts:274

`Readonly` usage

usage: WorkerUsage

@@ -340,7 +330,7 @@ This is the number of tasks that can be enqueued before the worker node has back

Defined in src/pools/worker.ts:240

`Readonly` worker

worker: Worker

@@ -348,7 +338,77 @@ This is the number of tasks that can be enqueued before the worker node has back

Defined in src/pools/worker.ts:232

Methods

addEventListener

addEventListener(type, callback, options?): void
+
Appends 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.
+
MDN Reference
+
+
+
Parameters
+
- +
  type: string
- +
  callback: null | EventListenerOrEventListenerObject
- +
  Optional options: boolean | AddEventListenerOptions
+
Returns void
+
+
Inherited from EventTarget.addEventListener
+
- Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:8209

dispatchEvent

dispatchEvent(event): boolean
+
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.
+
MDN Reference
+
+
+
Parameters
+
- +
  event: Event
+
Returns boolean
+
+
Inherited from EventTarget.dispatchEvent
+
- Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:8215

removeEventListener

removeEventListener(type, callback, options?): void
+
Removes the event listener in target's event listener list with the same type, callback, and options.
+
MDN Reference
+
+
+
Parameters
+
- +
  type: string
- +
  callback: null | EventListenerOrEventListenerObject
- +
  Optional options: boolean | EventListenerOptions
+
Returns void
+
+
Inherited from EventTarget.removeEventListener
+
- Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:8221

Generated using TypeDoc

\ No newline at end of file +

\ No newline at end of file

type: string

callback: null | EventListenerOrEventListenerObject

`Optional` options: boolean | AddEventListenerOptions

event: Event

type: string

callback: null | EventListenerOrEventListenerObject

`Optional` options: boolean | EventListenerOptions