X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=inline;f=docs%2Fclasses%2FThreadWorker.html;h=6c6183ddb4f7d9eb9cc078d84a4f51c5900e8aff;hb=e1d3eccbb484bfbe36f6dcb9c4ef22a11621a00b;hp=79298d41f4848667b9ed935730ebefbfadc2e688;hpb=42db2d3372ac49ab00dd1889378238b7a78ac4ce;p=poolifier.git
diff --git a/docs/classes/ThreadWorker.html b/docs/classes/ThreadWorker.html
index 79298d41..6c6183dd 100644
--- a/docs/classes/ThreadWorker.html
+++ b/docs/classes/ThreadWorker.html
@@ -40,11 +40,11 @@ but the minimum number of workers will be guaranteed.
Hierarchy
-AbstractWorker < MessagePort , Data , Response >
+AbstractWorker < MessagePort , Data , Response >
+Defined in src/worker/thread-worker.ts:21
@@ -83,7 +83,7 @@ but the minimum number of workers will be guaranteed.
constructor
-new Thread Worker< Data , Response > ( fn: ( ( data: Data ) => Response ) , opts?: WorkerOptions ) : ThreadWorker < Data , Response >
+new Thread Worker< Data , Response > ( fn: ( ( data: Data ) => Response | Promise < Response > ) , opts?: WorkerOptions ) : ThreadWorker < 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/thread-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 | MessagePort
+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,9 +240,9 @@ never be called.
Returns Reference to the main worker.
Returns MessagePort
+Defined in src/worker/abstract-worker.ts:136
Protected
handle Error
@@ -260,13 +260,13 @@ never be called.
Returns string
+Defined in src/worker/abstract-worker.ts:168
Protected
message Listener
-message Listener( message: MessageValue < Data , MessagePort > , fn: ( ( data: Data ) => Response ) ) : void
+message Listener( message: MessageValue < Data , MessagePort > , fn: ( ( data: Data ) => Response | Promise < Response > ) ) : void
@@ -274,32 +274,32 @@ never be called.
Parameters
-message: MessageValue < Data , MessagePort >
+message: MessageValue < Data , MessagePort >
-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
@@ -322,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
@@ -355,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
@@ -410,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/thread-worker.ts:39
trigger Async Id
@@ -438,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
@@ -473,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 thread worker.