X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FClusterWorker.html;h=4476d945541582990753b0308c10eb69adf28196;hb=f63918da6f3fc77cc7f98e4d43e3f37955140468;hp=846e4c32efb8979cf0772db1f0bd5808ed6e0aca;hpb=42db2d3372ac49ab00dd1889378238b7a78ac4ce;p=poolifier.git
diff --git a/docs/classes/ClusterWorker.html b/docs/classes/ClusterWorker.html
index 846e4c32..4476d945 100644
--- a/docs/classes/ClusterWorker.html
+++ b/docs/classes/ClusterWorker.html
@@ -40,11 +40,11 @@ but the minimum number of workers will be guaranteed.
Hierarchy
-AbstractWorker < Worker , Data , Response >
+AbstractWorker < Worker , Data , Response >
+Defined in src/worker/cluster-worker.ts:21
@@ -83,7 +83,7 @@ but the minimum number of workers will be guaranteed.
constructor
-new Cluster Worker< Data , Response > ( fn: ( ( data: Data ) => Response ) , opts?: WorkerOptions ) : ClusterWorker < Data , Response >
+new Cluster Worker< Data , Response > ( fn: ( ( data: Data ) => Response | Promise < Response > ) , opts?: WorkerOptions ) : ClusterWorker < Data , Response >
@@ -98,28 +98,28 @@ but the minimum number of workers will be guaranteed.
Parameters
-fn: ( ( data: Data ) => Response )
+fn: ( ( data: Data ) => Response | Promise < Response > )
-( data: Data ) : Response
+( data: Data ) : Response | Promise < Response >
-Returns Response
+Returns Response | Promise < Response >
+Defined in src/worker/cluster-worker.ts:31
Protected
Readonly
is Main
is Main: boolean
+Defined in src/worker/abstract-worker.ts:43
Protected
last Task Timestamp
last Task Timestamp: number
+Defined in src/worker/abstract-worker.ts:27
Protected
main Worker
main Worker: undefined | null | Worker
+Defined in src/worker/abstract-worker.ts:45
+Defined in src/worker/abstract-worker.ts:46
Methods
@@ -173,7 +173,7 @@ but the minimum number of workers will be guaranteed.
Returns The unique asyncId
assigned to the resource.
Returns number
-Inherited from AbstractWorker.asyncId
+Inherited from AbstractWorker .asyncId
Defined in node_modules/.pnpm/@types+node@18.15.11/node_modules/@types/node/async_hooks.d.ts:315
@@ -200,7 +200,7 @@ the AsyncResource
to which the function is bound.
Returns Func & { Â Â Â Â asyncResource: AsyncResource ; }
-Inherited from AbstractWorker.bind
+Inherited from AbstractWorker .bind
Defined in node_modules/.pnpm/@types+node@18.15.11/node_modules/@types/node/async_hooks.d.ts:288
@@ -211,9 +211,9 @@ the AsyncResource
to which the function is bound.
Returns void
+Defined in src/worker/abstract-worker.ts:153
emit Destroy
@@ -227,7 +227,7 @@ never be called.
Returns A reference to asyncResource
.
-Inherited from AbstractWorker.emitDestroy
+Inherited from AbstractWorker .emitDestroy
Defined in node_modules/.pnpm/@types+node@18.15.11/node_modules/@types/node/async_hooks.d.ts:311
@@ -240,29 +240,33 @@ never be called.
Returns Reference to the main worker.
Returns Worker
+Defined in src/worker/abstract-worker.ts:136
Protected
handle Error
handle Error( e: string | Error ) : string
-
+
+e: string | Error
+
Returns string
+Defined in src/worker/cluster-worker.ts:50
Protected
message Listener
-message Listener( message: MessageValue < Data , Worker > , fn: ( ( data: Data ) => Response ) ) : void
+message Listener( message: MessageValue < Data , Worker > , fn: ( ( data: Data ) => Response | Promise < Response > ) ) : void
@@ -270,32 +274,32 @@ never be called.
Parameters
-message: MessageValue < Data , Worker >
+
-fn: ( ( data: Data ) => Response )
+fn: ( ( data: Data ) => Response | Promise < Response > )
-( data: Data ) : Response
+( data: Data ) : Response | Promise < Response >
-Returns Response
+Returns Response | Promise < Response >
Returns void
+Defined in src/worker/abstract-worker.ts:84
Protected
run
-run( fn: ( ( data?: Data ) => Response ) , message: MessageValue < Data , unknown > ) : void
+run( fn: ( ( data?: Data ) => Response ) , message: MessageValue < Data , unknown > ) : void
@@ -318,17 +322,17 @@ never be called.
Optional
data: Data
Returns Response
-message: MessageValue < Data , unknown >
+
Returns void
+Defined in src/worker/abstract-worker.ts:178
Protected
run Async
-run Async( fn: ( ( data?: Data ) => Promise < Response > ) , message: MessageValue < Data , unknown > ) : void
+run Async( fn: ( ( data?: Data ) => Promise < Response > ) , message: MessageValue < Data , unknown > ) : void
@@ -351,13 +355,13 @@ never be called.
Optional
data: Data
Returns Promise < Response >
-message: MessageValue < Data , unknown >
+
Returns void
+Defined in src/worker/abstract-worker.ts:205
run In Async Scope
@@ -406,25 +410,27 @@ then restore the original execution context.
Returns Result
-Inherited from AbstractWorker.runInAsyncScope
+Inherited from AbstractWorker .runInAsyncScope
Defined in node_modules/.pnpm/@types+node@18.15.11/node_modules/@types/node/async_hooks.d.ts:303
Protected
send To Main Worker
-send To Main Worker( message: MessageValue < Response , unknown > ) : void
+send To Main Worker( message: MessageValue < Response , unknown > ) : void
-
+
Parameters
-message: MessageValue < Response , unknown >
+message: MessageValue < Response , unknown >
+
Returns void
+Defined in src/worker/cluster-worker.ts:45
trigger Async Id
@@ -434,7 +440,7 @@ then restore the original execution context.
Returns The same triggerAsyncId
that is passed to the AsyncResource
constructor.
Returns number
-Inherited from AbstractWorker.triggerAsyncId
+Inherited from AbstractWorker .triggerAsyncId
Defined in node_modules/.pnpm/@types+node@18.15.11/node_modules/@types/node/async_hooks.d.ts:320
@@ -469,7 +475,7 @@ the AsyncResource
to which the function is bound.
Optional
thisArg: ThisArg
Returns Func & { Â Â Â Â asyncResource: AsyncResource ; }
-Inherited from AbstractWorker.bind
+Inherited from AbstractWorker .bind
Defined in node_modules/.pnpm/@types+node@18.15.11/node_modules/@types/node/async_hooks.d.ts:273
Constructs a new poolifier cluster worker.