Class WorkerManager<Manifest>

constructor

• new WorkerManager<Manifest>(config): WorkerManager<Manifest>

• Constructs a new instance of the class using the provided parameters.

  Type Parameters

  • Manifest extends WorkerManifest

  Parameters

  • config: {
        cores: number;
        logger: Logger;
        manifest: Manifest;
        workerFactory: WorkerFactory;
    }

    The configuration for the constructor.

    • cores: number

      The number of cores to allocate for the worker pool.

    • logger: Logger

      The logger instance for logging messages.

    • manifest: Manifest

      The manifest containing method definitions.

    • workerFactory: WorkerFactory

      The factory for creating worker instances.

  Returns WorkerManager<Manifest>

methods

call

• call(task): Promise<WorkerResult>

• Processes a worker task by enqueuing it for execution.

  Parameters

  • task: WorkerTaskInformation

    The information about the worker task to be executed.

  Returns Promise<WorkerResult>

  A promise that resolves with the result of the worker task execution.

completed

• completed(): Promise<void>

• Returns a promise that resolves when the pool status becomes 'idle', or rejects if the pool status changes to 'terminated' or an error occurs.

  Returns Promise<void>

  A promise that resolves when the pool is idle or rejects with an error.

destroy

• destroy(params?): Promise<void>

• Destroys the WorkerManager instance and terminates its associated pool.

  Parameters

  • Optional params: {
        force?: boolean;
    } = {}

    An optional configuration object.

    • Optional force?: boolean

      Indicates whether to forcefully terminate the pool.

  Returns Promise<void>

  A promise that resolves when the destruction process is complete.

queue

• queue(task): Promise<WorkerResult>

• Enqueues a task to be processed by the worker pool.

  Parameters

  • task: WorkerTaskInformation

    The task to be processed by the worker pool.

  Returns Promise<WorkerResult>

  A promise that resolves with the result of the task or rejects with an error if the task fails or cannot be processed.

settled

• settled(): Promise<void>

• Returns a promise that resolves when the pool status becomes 'idle', or rejects if the pool status becomes 'terminated'.

  Returns Promise<void>

  A promise that resolves once the pool status is 'idle', or rejects if the pool status becomes 'terminated'.

Static createWorkerManager

• createWorkerManager<Manifest>(options): Promise<WorkerManager<Manifest>>

• Creates and initializes a new instance of WorkerManager.

  Type Parameters

  • Manifest extends WorkerManifest

  Parameters

  • options: {
        cores?: number;
        logger?: Logger;
        manifest: Manifest;
        workerFactory: WorkerFactory;
    }

    The configuration options for the WorkerManager.

    • Optional cores?: number

      The number of cores to allocate for workers. Defaults to 1.

    • Optional logger?: Logger

    • manifest: Manifest

      The manifest defining the worker capabilities and operations.

    • workerFactory: WorkerFactory

      The factory for creating workers.

  Returns Promise<WorkerManager<Manifest>>

  A promise that resolves to a new WorkerManager instance.