X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FThreadWorker.html;h=62198283e49923fb181a0cf522035b8304ea8afc;hb=73d8141b526469f4fce46da956280f2b9146accb;hp=4b9f97027359c76adcd0f97879a17d9d3ec9693d;hpb=2946f23da560702e3f3631887e1eeb88777bd47d;p=poolifier.git
diff --git a/docs/classes/ThreadWorker.html b/docs/classes/ThreadWorker.html
index 4b9f9702..62198283 100644
--- a/docs/classes/ThreadWorker.html
+++ b/docs/classes/ThreadWorker.html
@@ -26,9 +26,9 @@ but the minimum number of workers will be guaranteed.
Since 0.0.1
-
+
Methods
@@ -71,9 +72,9 @@ but the minimum number of workers will be guaranteed.
get handle message run run run run send trigger bind constructor
-new < Data , Response > ( fn , opts ? ) : ThreadWorker < Data , Response > new < Data , Response > ( taskFunctions , opts ? ) : ThreadWorker < Data , Response >
-
+
Type Parameters
-
+
Data = unknown
@@ -98,8 +99,8 @@ but the minimum number of workers will be guaranteed.
Parameters
+Defined in src/worker/abstract-worker.ts:42 Protected Readonly is is : boolean
@@ -126,7 +127,7 @@ but the minimum number of workers will be guaranteed.
Defined in src/worker/abstract-worker.ts:54
Protected last last : number
@@ -134,7 +135,7 @@ but the minimum number of workers will be guaranteed.
Defined in src/worker/abstract-worker.ts:38
Protected main main : undefined | null | MessagePort
@@ -142,7 +143,7 @@ but the minimum number of workers will be guaranteed.
Defined in src/worker/abstract-worker.ts:58
Protected Readonly opts Defined in src/worker/abstract-worker.ts:59
+Protected task
Methods
async ( ) : number
-
-Returns number
+
+Returns number The unique asyncId assigned to the resource.
+ Defined in node_modules/.pnpm/@types+node@20.1.0/node_modules/@types/node/async_hooks.d.ts:312
bind
-bind < Func > ( fn ) : Func & { Â Â Â Â asyncResource : AsyncResource ; } bind < Func > ( fn ) : Func
-
+
Type Parameters
-
+
Func extends ( ( ... args ) => any )
@@ -188,10 +194,10 @@ the AsyncResource to which the function is bound.
fn : Func Returns Func & { Â Â Â Â asyncResource : AsyncResource ; } Defined in node_modules/.pnpm/@types+node@20.1.0/node_modules/@types/node/async_hooks.d.ts:287
+Defined in src/worker/abstract-worker.ts:179
emit
@@ -212,34 +218,30 @@ the AsyncResource to which the function is bound.
be thrown if it is called more than once. This must be manually called. If
the resource is left to be collected by the GC then the destroy hooks will
never be called.
-
-Returns A reference to asyncResource.
-
+A reference to asyncResource.
+ Defined in node_modules/.pnpm/@types+node@20.1.0/node_modules/@types/node/async_hooks.d.ts:308
Protected get
get ( ) : MessagePort
-Returns MessagePort
+Returns MessagePort Reference to the main worker.
+ Defined in src/worker/abstract-worker.ts:162
+Defined in src/worker/abstract-worker.ts:194
Protected message
-message ( message , fn ) : void message ( message ) : void
@@ -265,37 +268,11 @@ never be called.
message : MessageValue < Data , MessagePort >
-
-
-
Returns void Protected run
-run ( fn , message ) : void
-
-
-Returns void Defined in src/worker/abstract-worker.ts:138
Protected run
@@ -311,13 +288,13 @@ never be called.
-
+message : MessageValue < Data , Worker | MessagePort >
Returns void Defined in src/worker/abstract-worker.ts:231
run
@@ -330,9 +307,9 @@ then restore the original execution context.
Since v9.6.0
-
+
Type Parameters
-
+
This
@@ -368,7 +345,29 @@ then restore the original execution context.
Returns Result
+Defined in node_modules/.pnpm/@types+node@20.1.0/node_modules/@types/node/async_hooks.d.ts:300 Protected run
+run ( fn , message ) : void
+
+
+
Parameters
+
+
+
+
+
+message : MessageValue < Data , Worker | MessagePort > Returns void Protected send Defined in src/worker/thread-worker.ts:51
trigger
trigger ( ) : number
-
-Returns number
+
+Returns number The same triggerAsyncId that is passed to the AsyncResource constructor.
+ Defined in node_modules/.pnpm/@types+node@20.1.0/node_modules/@types/node/async_hooks.d.ts:317
Static bind
-bind < Func , ThisArg > ( fn , type ? , thisArg ? ) : Func & { Â Â Â Â asyncResource : AsyncResource ; } bind < Func , ThisArg > ( fn , type ? , thisArg ? ) : Func
-
+
Type Parameters
-
+
Func extends ( ( this , ... args ) => any )
@@ -430,10 +426,10 @@ the AsyncResource to which the function is bound.
Optional thisArg : ThisArg
-Returns Func & { Â Â Â Â asyncResource : AsyncResource ; } Defined in node_modules/.pnpm/@types+node@20.1.0/node_modules/@types/node/async_hooks.d.ts:277
Type of data this worker receives from pool's execution. This can only be serializable data.
@@ -44,7 +44,7 @@ but the minimum number of workers will be guaranteed.- ThreadWorker
+@@ -61,6 +61,7 @@ but the minimum number of workers will be guaranteed. last