Class WorkerManager<W>

Type Parameters

  • W extends ModuleMethods

Hierarchy

  • WorkerManager

Implements

  • WorkerManagerInterface<W>

Constructors

constructor

Properties

logger pool

Methods

call completed destroy queue settled createWorkerManager

Constructors

constructor

  • Type Parameters

    • W extends ModuleMethods

    Parameters

    • __namedParameters: {
          cores?: number;
          logger: Logger;
          workerFactory: (() => Promise<ModuleThread<W>>);
      }
      • Optional cores?: number
      • logger: Logger
      • workerFactory: (() => Promise<ModuleThread<W>>)
          • (): Promise<ModuleThread<W>>

          • Returns Promise<ModuleThread<W>>

    Returns WorkerManager<W>

Properties

Protected logger

logger: Logger

Protected pool

pool: Pool<ModuleThread<W>>

Methods

call

  • Type Parameters

    • T

    Parameters

    • f: ((worker) => Promise<T>)
        • (worker): Promise<T>

        • Parameters

          • worker: ModuleThread<W>

          Returns Promise<T>

    Returns Promise<T>

completed

  • Returns Promise<void>

destroy

  • Parameters

    • Optional __namedParameters: {
          force?: boolean;
      }
      • Optional force?: boolean

    Returns Promise<void>

queue

  • Type Parameters

    • T

    Parameters

    • f: ((worker) => Promise<T>)
        • (worker): Promise<T>

        • Parameters

          • worker: ModuleThread<W>

          Returns Promise<T>

    Returns QueuedTask<ModuleThread<W>, T>

settled

  • Returns Promise<Error[]>

Static createWorkerManager

  • Creates the WorkerManager The workerFactory needs to be a callback: () => spawn(new Worker(workerPath)) The spawn and Worker can be imported from threads The workerPath must point to a worker script The workerPath can be either an absolute path or relative path If it is a relative path, it has to be relative to the file location where the function expression is defined If cores is set to 0, this creates a useless worker pool Use undefined to mean using all cores

    Type Parameters

    • W extends ModuleMethods

    Parameters

    • __namedParameters: {
          cores?: number;
          logger?: Logger;
          workerFactory: (() => Promise<ModuleThread<W>>);
      }
      • Optional cores?: number
      • Optional logger?: Logger
      • workerFactory: (() => Promise<ModuleThread<W>>)
          • (): Promise<ModuleThread<W>>

          • Returns Promise<ModuleThread<W>>

    Returns Promise<WorkerManager<W>>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc