X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractWorker.html;h=18a43c17ff5ece1893951dc02c853071665114b0;hb=749e1fa387ba832c85f789337b3c2e679331cb64;hp=960f1b1b6ee52ab3994755910e93bc43c9f1468b;hpb=56960396878dec81e3ebeea5b76387efca8cc2dc;p=poolifier.git
diff --git a/docs/classes/AbstractWorker.html b/docs/classes/AbstractWorker.html
index 960f1b1b..18a43c17 100644
--- a/docs/classes/AbstractWorker.html
+++ b/docs/classes/AbstractWorker.html
@@ -1,4 +1,4 @@
-
AbstractWorker | poolifier
+AbstractWorker | poolifier
@@ -18,32 +18,32 @@
-
+
Type Parameters
-
+
-MainWorker extends Worker | MessagePort
+MainWorker extends Worker | MessagePort
-Data = unknown
+Data = unknown
-Response = unknown
+Response = unknown
Hierarchy
-AsyncResource
+AsyncResource
+
Defined in src/worker/abstract-worker.ts:24
@@ -51,145 +51,133 @@
Constructors
-constructor
+
Properties
-alive Interval?
-
is Main
-
last Task Timestamp
-
main Worker
-
opts
+
Constructors
-
+
constructor
-
-new Abstract Worker< MainWorker , Data , Response > ( type: string , isMain: boolean , fn: ( ( data: Data ) => Response ) , mainWorker: undefined | null | MainWorker , opts?: WorkerOptions ) : AbstractWorker < MainWorker , Data , Response >
+
+new Abstract Worker < MainWorker , Data , Response > ( type , isMain , fn , mainWorker , opts ? ) : AbstractWorker < MainWorker , Data , Response >
-
+
Type Parameters
-
+
-MainWorker extends Worker | MessagePort
+MainWorker extends Worker | MessagePort
-Data = unknown
+Data = unknown
-Response = unknown
+Response = unknown
Parameters
-type: string
+type : string
-isMain: boolean
+isMain : boolean
-fn: ( ( data: Data ) => Response )
+
-
-
-
-( data: Data ) : Response
-
-
-Returns Response
+
-mainWorker: undefined | null | MainWorker
+mainWorker : undefined | null | MainWorker
-
+
-Returns AbstractWorker < MainWorker , Data , Response >
+
Defined in src/worker/abstract-worker.ts:46
Properties
-
+
Protected
Optional
Readonly
alive Interval
-alive Interval?: Timeout
+alive Interval ?: Timeout
-
+
Protected
Readonly
is Main
-is Main: boolean
+is Main : boolean
-
+
Protected
last Task Timestamp
-last Task Timestamp: number
+last Task Timestamp : number
-
+
Protected
main Worker
-main Worker: undefined | null | MainWorker
+main Worker : undefined | null | MainWorker
-
+
Protected
Readonly
opts
-
+
+Defined in src/worker/abstract-worker.ts:51
Methods
-
+
async Id
-
-async Id( ) : number
+
+async Id ( ) : number
-
-Returns number
+
+Returns number The unique asyncId
assigned to the resource.
+
-
+Defined in node_modules/.pnpm/@types+node@18.15.13/node_modules/@types/node/async_hooks.d.ts:315
+
bind
-
-bind< Func > ( fn: Func ) : Func & { Â Â Â Â asyncResource: AsyncResource ; }
+
+bind < Func > ( fn ) : Func & { Â Â Â Â asyncResource : AsyncResource ; }
-
+
Type Parameters
-
+
-Func extends ( ( ... args: any [] ) => any )
+Func extends ( ( ... args ) => any )
-Returns Func & { Â Â Â Â asyncResource: AsyncResource ; }
-
+Defined in node_modules/.pnpm/@types+node@18.15.13/node_modules/@types/node/async_hooks.d.ts:288
+
Protected
check Alive
-
-check Alive( ) : void
+
+check Alive ( ) : void
Returns void
-
+
Private
check Function Input
-
-check Function Input( fn: ( ( data: Data ) => Response ) ) : void
+
+check Function Input ( fn ) : void
@@ -234,87 +222,73 @@ the AsyncResource
to which the function is bound.
Parameters
-fn: ( ( data: Data ) => Response )
+
-
-
-
-( data: Data ) : Response
-
-
-Returns Response
+
Returns void
-
+
Private
check Worker Options
-
-check Worker Options( opts: WorkerOptions ) : void
+
+check Worker Options ( opts ) : void
+
Returns void
-
+
-
+Defined in node_modules/.pnpm/@types+node@18.15.13/node_modules/@types/node/async_hooks.d.ts:311
+
Protected
get Main Worker
-
-get Main Worker( ) : MainWorker
+
+get Main Worker ( ) : MainWorker
-Returns MainWorker
-
+
Protected
handle Error
-
-handle Error( e: string | Error ) : string
+
+handle Error ( e ) : string
Parameters
-e: string | Error
+e : string | Error
-Returns string
+Returns string Message of the error.
+
-
+
Protected
message Listener
-
-message Listener( message: MessageValue < Data , MainWorker > , fn: ( ( data: Data ) => Response ) ) : void
+
+message Listener ( message , fn ) : void
@@ -322,31 +296,20 @@ never be called.
Parameters
-message: MessageValue < Data , MainWorker >
+message : MessageValue < Data , MainWorker >
-fn: ( ( data: Data ) => Response )
+
-
-
-
-( data: Data ) : Response
-
-
-Returns Response
+
Returns void
-
+
Protected
run
-
-run( fn: ( ( data?: Data ) => Response ) , message: MessageValue < Data , unknown > ) : void
+
+run ( fn , message ) : void
@@ -354,31 +317,20 @@ never be called.
Parameters
-fn: ( ( data?: Data ) => Response )
+
-
-
-
-( data?: Data ) : Response
-
-
-Returns Response
+
-
+
Returns void
-
+
Protected
run Async
-
-run Async( fn: ( ( data?: Data ) => Promise < Response > ) , message: MessageValue < Data , unknown > ) : void
+
+run Async ( fn , message ) : void
@@ -386,31 +338,20 @@ never be called.
Parameters
-fn: ( ( data?: Data ) => Promise < Response > )
+
-
-
-
-( data?: Data ) : Promise < Response >
-
-
-Returns Promise < Response >
+
-
+
Returns void
-
+
run In Async Scope
-
-run In Async Scope< This , Result > ( fn: ( ( this: This , ... args: any [] ) => Result ) , thisArg?: This , ... args: any [] ) : Result
+
+run In Async Scope < This , Result > ( fn , thisArg ? , ... args ) : Result
-
-Result
+Result
Parameters
-fn: ( ( this: This , ... args: any [] ) => Result )
+fn : ( ( this , ... args ) => Result )
-
-( this: This , ... args: any [] ) : Result
+
+( this , ... args ) : Result
Parameters
-this: This
+this : This
-Rest
... args: any []
-Returns Result
+Rest
... args : any []
+Returns Result
-Optional
thisArg: This
+Optional
thisArg : This
-Rest
... args: any []
+Rest
... args : any []
-Returns Result
+
Protected
Abstract
send To Main Worker
-
-send To Main Worker( message: MessageValue < Response , unknown > ) : void
+
+send To Main Worker ( message ) : void
@@ -469,28 +410,27 @@ then restore the original execution context.
Parameters
Returns void
-
+
trigger Async Id
-
-trigger Async Id( ) : number
+
+trigger Async Id ( ) : number
-
-Returns number
+
+Returns number The same triggerAsyncId
that is passed to the AsyncResource
constructor.
+
-
+Defined in node_modules/.pnpm/@types+node@18.15.13/node_modules/@types/node/async_hooks.d.ts:320
+
Static
bind
-
-bind< Func , ThisArg > ( fn: Func , type?: string , thisArg?: ThisArg ) : Func & { Â Â Â Â asyncResource: AsyncResource ; }
+
+bind < Func , ThisArg > ( fn , type ? , thisArg ? ) : Func & { Â Â Â Â asyncResource : AsyncResource ; }
-
+
Type Parameters
-
+
-Func extends ( ( this: ThisArg , ... args: any [] ) => any )
+Func extends ( ( this , ... args ) => any )
-ThisArg
+ThisArg
Parameters
-fn: Func
+fn : Func
-Optional
type: string
+Optional
type : string
-Optional
thisArg: ThisArg
-Returns Func & { Â Â Â Â asyncResource: AsyncResource ; }
+Theme OS Light Dark
On This Page
+constructor
+alive Interval
+is Main
+last Task Timestamp
+main Worker
+opts
+async Id
+bind
+check Alive
+check Function Input
+check Worker Options
+emit Destroy
+get Main Worker
+handle Error
+message Listener
+run
+run Async
+run In Async Scope
+send To Main Worker
+trigger Async Id
+bind
+Pool Type
+Abstract Pool
+Abstract Worker
+Circular Array
+Cluster Worker
+Dynamic Cluster Pool
+Dynamic Thread Pool
+Fixed Cluster Pool
+Fixed Thread Pool
+Pool Emitter
+Thread Worker
+Worker Choice Strategy Context
+Cluster Pool Options
+IPool
+IWorker
+IWorker Choice Strategy
+Message Value
+Pool Options
+Promise Response Wrapper
+Required Statistics
+Task
+Tasks Queue Options
+Tasks Usage
+Worker Choice Strategy Options
+Worker Node
+Worker Options
+Draft
+Error Handler
+Exit Handler
+Kill Behavior
+Message Handler
+Online Handler
+Pool Event
+Thread Worker With Message Channel
+Worker Async Function
+Worker Choice Strategy
+Worker Function
+Worker Sync Function
+Kill Behaviors
+Pool Events
+Worker Choice Strategies
\ No newline at end of file
Base class that implements some shared logic for all poolifier workers.