@types/worker-threads-pool

Installation

npm install --save @types/worker-threads-pool

Summary

This package contains type definitions for worker-threads-pool (https://github.com/watson/worker-threads-pool#readme).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/worker-threads-pool.

index.d.ts

/// <reference types="node" />

import { Worker, WorkerOptions } from "worker_threads";

export = Pool;

declare class Pool {
    constructor(options?: Pool.Options);

    /**
     * Number of active workers in the pool.
     */
    size: number;

    /**
     * @param filename argument passed directly to `new Worker(filename, options)`
     * @param options argument passed directly to `new Worker(filename, options)`
     * @param callback will be called once the worker is created
     */
    acquire(filename: string, callback: (error: Error | null, worker: Worker) => void): void;
    acquire(
        filename: string,
        options: WorkerOptions,
        callback: (error: Error | null, worker: Worker) => void,
    ): void;

    /**
     * Calls `worker.terminate()` on all workers in the pool.
     * @param callback will be called once all workers have terminated
     */
    destroy(callback?: () => void): void;
}

declare namespace Pool {
    interface Options {
        /**
         * Maximum number of workers allowed in the pool. Other workers will be queued
         * and started once there's room in the pool.
         * @default 1
         */
        max?: number | undefined;
        /**
         * Maximum number of workers waiting to be started when the pool is full.
         * The callback to `pool.acquire` will be called with an error in case this limit is reached.
         */
        maxWaiting?: number | undefined;
    }
}

Additional Details

• Last updated: Tue, 07 Nov 2023 15:11:36 GMT
• Dependencies: @types/node

Credits

These definitions were written by BendingBender.