X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FThreadWorker.html;h=48dfe83b952cbd0d9165f335252bb39938c52f6d;hb=699db3f06500e28320ae786e304c23020dd5b5ad;hp=9b927050c92b56b9aa478fb413bef381f9bde915;hpb=812ad701baefad24cad2df8f9a60bf4d581d8697;p=poolifier.git
diff --git a/docs/classes/ThreadWorker.html b/docs/classes/ThreadWorker.html
index 9b927050..48dfe83b 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: WorkerFunction < Data , Response > , opts?: WorkerOptions ) : ThreadWorker < Data , Response >
@@ -98,28 +98,17 @@ but the minimum number of workers will be guaranteed.
Parameters
-fn: ( ( data: Data ) => Response )
+
-
-
-
-( data: Data ) : Response
-
-
-Returns Response
+
+Defined in src/worker/thread-worker.ts:31
Protected
Readonly
is Main
is Main: boolean
+Defined in src/worker/abstract-worker.ts:48
Protected
last Task Timestamp
last Task Timestamp: number
+Defined in src/worker/abstract-worker.ts:32
Protected
main Worker
main Worker: undefined | null | MessagePort
+Defined in src/worker/abstract-worker.ts:50
+Defined in src/worker/abstract-worker.ts:51
Methods
@@ -173,7 +162,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 +189,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 +200,9 @@ the AsyncResource
to which the function is bound.
Returns void
+Defined in src/worker/abstract-worker.ts:156
emit Destroy
@@ -227,7 +216,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 +229,9 @@ never be called.
Returns Reference to the main worker.
Returns MessagePort
+Defined in src/worker/abstract-worker.ts:139
Protected
handle Error
@@ -260,13 +249,13 @@ never be called.
Returns string
+Defined in src/worker/abstract-worker.ts:171
Protected
message Listener
-message Listener( message: MessageValue < Data , MessagePort > , fn: ( ( data: Data ) => Response ) ) : void
+message Listener( message: MessageValue < Data , MessagePort > , fn: WorkerFunction < Data , Response > ) : void
@@ -274,32 +263,21 @@ never be called.
Parameters
-message: MessageValue < Data , MessagePort >
+message: MessageValue < Data , MessagePort >
-fn: ( ( data: Data ) => Response )
+
-
-
-
-( data: Data ) : Response
-
-
-Returns Response
+
Returns void
+Defined in src/worker/abstract-worker.ts:89
Protected
run
-run( fn: ( ( data?: Data ) => Response ) , message: MessageValue < Data , unknown > ) : void
+run( fn: WorkerSyncFunction < Data , Response > , message: MessageValue < Data , unknown > ) : void
@@ -307,32 +285,21 @@ never be called.
Parameters
-fn: ( ( data?: Data ) => Response )
+
-
-
-
-( data?: Data ) : Response
-
-
-Returns Response
+
-message: MessageValue < Data , unknown >
+
Returns void
+Defined in src/worker/abstract-worker.ts:181
Protected
run Async
-run Async( fn: ( ( data?: Data ) => Promise < Response > ) , message: MessageValue < Data , unknown > ) : void
+run Async( fn: WorkerAsyncFunction < Data , Response > , message: MessageValue < Data , unknown > ) : void
@@ -340,28 +307,17 @@ never be called.
Parameters
-fn: ( ( data?: Data ) => Promise < Response > )
+
-
-
-
-( data?: Data ) : Promise < Response >
-
-
-Returns Promise < Response >
+
-message: MessageValue < Data , unknown >
+
Returns void
+Defined in src/worker/abstract-worker.ts:208
run In Async Scope
@@ -410,25 +366,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 +396,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 +431,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.