Synchronously calls each of the listeners registered for the event namedeventName, in the order they were registered, passing the supplied arguments
to each.
@@ -215,4 +215,4 @@ memory leaks. The emitter.setMaxListeners() method allows the limit
modified for this specific EventEmitter instance. The value can be set toInfinity (or 0) to indicate an unlimited number of listeners.
Returns a reference to the EventEmitter, so that calls can be chained.
Worker node interface.
+- Preparing search index...
- The search index is not available
poolifier - v3.1.16Interface IWorkerNode<Worker, Data>
InternalWorker node interface.
    clearTasksQueue: (() => void);
    deleteTaskFunctionWorkerUsage: ((name) => boolean);
    dequeueTask: (() => undefined | Task<Data>);
    enqueueTask: ((task) => number);
    getTaskFunctionWorkerUsage: ((name) => undefined | WorkerUsage);
    hasBackPressure: (() => boolean);
    info: WorkerInfo;
    messageChannel?: MessageChannel;
    popTask: (() => undefined | Task<Data>);
    registerOnceWorkerEventHandler: ((event, handler) => void);
    registerWorkerEventHandler: ((event, handler) => void);
    resetUsage: (() => void);
    strategyData?: StrategyData;
    tasksQueueBackPressureSize: number;
    tasksQueueSize: (() => number);
    terminate: (() => Promise<void>);
    unshiftTask: ((task) => number);
    usage: WorkerUsage;
    worker: Worker;
    [captureRejectionSymbol]?(error, event, ...args): void;
    addListener(eventName, listener): this;
    emit(eventName, ...args): boolean;
    eventNames(): (string | symbol)[];
    getMaxListeners(): number;
    listenerCount(eventName, listener?): number;
    listeners(eventName): Function[];
    off(eventName, listener): this;
    on(eventName, listener): this;
    once(eventName, listener): this;
    prependListener(eventName, listener): this;
    prependOnceListener(eventName, listener): this;
    rawListeners(eventName): Function[];
    removeAllListeners(event?): this;
    removeListener(eventName, listener): this;
    setMaxListeners(n): this;
}
Type Parameters
Worker extends IWorker
Type of worker.
Data = unknown
Type of data sent to the worker. This can only be structured-cloneable data.
-Hierarchy
Index
Properties
Hierarchy
Index
Properties
Properties
ReadonlyclearClears tasks queue.
Type declaration
Clears tasks queue.
-Returns void
ReadonlydeleteDeletes task function worker usage statistics.
+Returns void
ReadonlydeleteDeletes task function worker usage statistics.
Type declaration
Deletes task function worker usage statistics.
Parameters
name: string
The task function name.
Returns boolean
trueif the task function worker usage statistics were deleted,falseotherwise.Param: name
The task function name.
Returns
-trueif the task function worker usage statistics were deleted,falseotherwise.ReadonlydequeueDequeue task.
+ReadonlydequeueDequeue task.
Type declaration
Dequeue task.
Returns undefined | Task<Data>
The dequeued task.
Returns
The dequeued task.
-ReadonlyenqueueEnqueue task.
+ReadonlyenqueueEnqueue task.
Type declaration
Enqueue task.
Parameters
task: Task<Data>
The task to queue.
Returns number
The tasks queue size.
Param: task
The task to queue.
Returns
The tasks queue size.
-ReadonlygetGets task function worker usage statistics.
+ReadonlygetGets task function worker usage statistics.
Type declaration
Gets task function worker usage statistics.
Parameters
name: string
The task function name.
Returns undefined | WorkerUsage
The task function worker usage statistics if the task function worker usage statistics are initialized,
undefinedotherwise.Param: name
The task function name.
Returns
The task function worker usage statistics if the task function worker usage statistics are initialized,
-undefinedotherwise.ReadonlyhasWhether the worker node has back pressure (i.e. its tasks queue is full).
+ReadonlyhasWhether the worker node has back pressure (i.e. its tasks queue is full).
Type declaration
Whether the worker node has back pressure (i.e. its tasks queue is full).
Returns boolean
trueif the worker node has back pressure,falseotherwise.Returns
-trueif the worker node has back pressure,falseotherwise.ReadonlyinfoWorker info.
-OptionalReadonlymessageMessage channel (worker thread only).
-ReadonlypopPops a task from the tasks queue.
+ReadonlyinfoWorker info.
+OptionalReadonlymessageMessage channel (worker thread only).
+ReadonlypopPops a task from the tasks queue.
Type declaration
Pops a task from the tasks queue.
Returns undefined | Task<Data>
The popped task.
Returns
The popped task.
-ReadonlyregisterRegisters once a worker event handler.
+ReadonlyregisterRegisters once a worker event handler.
Type declaration
Registers once a worker event handler.
Parameters
event: string
The event.
-handler: OnlineHandler<Worker> | MessageHandler<Worker> | ErrorHandler<Worker> | ExitHandler<Worker>
The event handler.
+handler: EventHandler<Worker>
The event handler.
Returns void
Param: event
The event.
Param: handler
The event handler.
-ReadonlyregisterRegisters a worker event handler.
+ReadonlyregisterRegisters a worker event handler.
Type declaration
Registers a worker event handler.
Parameters
event: string
The event.
-handler: OnlineHandler<Worker> | MessageHandler<Worker> | ErrorHandler<Worker> | ExitHandler<Worker>
The event handler.
+handler: EventHandler<Worker>
The event handler.
Returns void
Param: event
The event.
Param: handler
The event handler.
-ReadonlyresetResets usage statistics.
+ReadonlyresetResets usage statistics.
Type declaration
Resets usage statistics.
-Returns void
OptionalstrategyWorker choice strategy data. +
Returns void
OptionalstrategyWorker choice strategy data. This is used to store data that are specific to the worker choice strategy.
-tasks
Tasks queue back pressure size. +
tasks
Tasks queue back pressure size. This is the number of tasks that can be enqueued before the worker node has back pressure.
-ReadonlytasksTasks queue size.
+ReadonlytasksTasks queue size.
Type declaration
Tasks queue size.
Returns number
The tasks queue size.
Returns
The tasks queue size.
-ReadonlyterminateTerminates the worker node.
+ReadonlyterminateTerminates the worker node.
Type declaration
Terminates the worker node.
-Returns Promise<void>
ReadonlyunshiftPrepends a task to the tasks queue.
+Returns Promise<void>
ReadonlyunshiftPrepends a task to the tasks queue.
Type declaration
Prepends a task to the tasks queue.
Parameters
task: Task<Data>
The task to prepend.
Returns number
The tasks queue size.
Param: task
The task to prepend.
Returns
The tasks queue size.
-ReadonlyusageWorker usage statistics.
-ReadonlyworkerWorker.
-Methods
Optional[captureParameters
error: Error
event: string
Rest...args: any[]Returns void
add
Alias for
+emitter.on(eventName, listener).ReadonlyusageWorker usage statistics.
+ReadonlyworkerWorker.
+Methods
Optional[captureParameters
error: Error
event: string
Rest...args: any[]Returns void
add
Alias for
emitter.on(eventName, listener).Parameters
eventName: string | symbol
listener: ((...args) => void)
Parameters
Rest...args: any[]Returns void
Returns this
Since
v0.1.26
emit
Synchronously calls each of the listeners registered for the event named
@@ -215,4 +215,4 @@ memory leaks. TheeventName, in the order they were registered, passing the supplied arguments to each.emitter.setMaxListeners()method allows the limit modified for this specificEventEmitterinstance. The value can be set toInfinity(or0) to indicate an unlimited number of listeners.Returns a reference to the
EventEmitter, so that calls can be chained.Parameters
n: number
Returns this
Since
v0.3.5
-Settings
Member Visibility
Theme
On This Page