Synchronously calls each of the listeners registered for the event namedeventName, in the order they were registered, passing the supplied arguments
to each.
@@ -186,4 +186,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.2Interface 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): IWorkerNode<Worker, Data>;
    emit(eventName, ...args): boolean;
    eventNames(): (string | symbol)[];
    getMaxListeners(): number;
    listenerCount(eventName, listener?): number;
    listeners(eventName): Function[];
    off(eventName, listener): IWorkerNode<Worker, Data>;
    on(eventName, listener): IWorkerNode<Worker, Data>;
    once(eventName, listener): IWorkerNode<Worker, Data>;
    prependListener(eventName, listener): IWorkerNode<Worker, Data>;
    prependOnceListener(eventName, listener): IWorkerNode<Worker, Data>;
    rawListeners(eventName): Function[];
    removeAllListeners(event?): IWorkerNode<Worker, Data>;
    removeListener(eventName, listener): IWorkerNode<Worker, Data>;
    setMaxListeners(n): IWorkerNode<Worker, Data>;
}
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
ReadonlyclearType declaration
Clears tasks queue.
-Returns void
ReadonlydeleteType declaration
Deletes task function worker usage statistics.
+Returns void
ReadonlydeleteType 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.ReadonlydequeueType declaration
Dequeue task.
+ReadonlydequeueType declaration
Dequeue task.
Returns undefined | Task<Data>
The dequeued task.
-ReadonlyenqueueType declaration
Enqueue task.
+ReadonlyenqueueType declaration
Enqueue task.
Parameters
task: Task<Data>
The task to queue.
Returns number
The tasks queue size.
-ReadonlygetType declaration
Gets task function worker usage statistics.
+ReadonlygetType 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.ReadonlyhasType declaration
Whether the worker node has back pressure (i.e. its tasks queue is full).
+ReadonlyhasType 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.ReadonlyinfoWorker info.
-OptionalReadonlymessageMessage channel (worker thread only).
-ReadonlypopType declaration
Pops a task from the tasks queue.
+ReadonlyinfoWorker info.
+OptionalReadonlymessageMessage channel (worker thread only).
+ReadonlypopType declaration
Pops a task from the tasks queue.
Returns undefined | Task<Data>
The popped task.
-ReadonlyregisterType declaration
Registers once a worker event handler.
+ReadonlyregisterType declaration
Registers once a worker event handler.
Parameters
event: string
The event.
handler: OnlineHandler<Worker> | MessageHandler<Worker> | ErrorHandler<Worker> | ExitHandler<Worker>
The event handler.
-Returns void
ReadonlyregisterType declaration
Registers a worker event handler.
+Returns void
ReadonlyregisterType declaration
Registers a worker event handler.
Parameters
event: string
The event.
handler: OnlineHandler<Worker> | MessageHandler<Worker> | ErrorHandler<Worker> | ExitHandler<Worker>
The event handler.
-Returns void
ReadonlyresetType declaration
Resets usage statistics.
-Returns void
OptionalstrategyWorker choice strategy data. +
Returns void
ReadonlyresetType declaration
Resets usage statistics.
+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.
-ReadonlytasksType declaration
Tasks queue size.
+ReadonlytasksType declaration
Tasks queue size.
Returns number
The tasks queue size.
-ReadonlyterminateType declaration
Terminates the worker node.
-Returns Promise<void>
ReadonlyunshiftType declaration
Prepends a task to the tasks queue.
+ReadonlyterminateType declaration
Terminates the worker node.
+Returns Promise<void>
ReadonlyunshiftType declaration
Prepends a task to the tasks queue.
Parameters
task: Task<Data>
The task to prepend.
Returns number
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 IWorkerNode<Worker, Data>
Since
v0.1.26
emit
Synchronously calls each of the listeners registered for the event named
@@ -186,4 +186,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 IWorkerNode<Worker, Data>
Since
v0.3.5
-Settings
Member Visibility
Theme
On This Page
Generated using TypeDoc
Settings
Member Visibility
Theme
On This Page
Generated using TypeDoc