subservient/@types/index.d.ts

The easiest way to multithread in node.js

declare module 'subservient';

export namespace subservient {
    interface FarmOptions {
        maxSize?: number;
        idleTime?: number;
    }

    interface StrictFarmOptions {
        maxSize: number;
        idleTime: number;
    }

    class WorkerFarm {
        constructor(file: string, options: StrictFarmOptions)

        async spawn(): any
        async end(): void
    }

    class WorkerPool extends WorkerFarm {
        constructor(file: string, size: number)
    }
}

export function createFarm(file: string, options?: subservient.FarmOptions): subservient.WorkerFarm;
export function createPool(file: string, size: number): subservient.WorkerPool;

/**
 * If in a worker thread, expose the functions in `endpoint` to the master thread
 * @param endpoint Functions exposed to the master thread
 */
export function expose(endpoint: any): void;