Class WorkerPoolService

The worker pool service registered under CAPABILITIES.WORKER_POOL.

Resolves the worker host once: an injected options.host wins over the runtime's IRuntimeServices.workers. When neither exists (e.g. Cloudflare Workers), the service still constructs — run() throws WorkerPoolUnavailableError, stats() returns [], and shutdown() resolves — so one codebase stays deployable everywhere. Construction refuses an invalid maxWorkers with RangeError, just as the plugin factory does.

Since

0.1.0

Implements

IWorkerPool

Index

Constructors

constructor

Methods

run shutdown stats

Constructors

constructor

new WorkerPoolService(
    options: WorkerPoolPluginOptions | undefined,
    runtime: IRuntimeServices,
    collector?: WorkerPoolCollector,
): WorkerPoolService
Parameters
- options: WorkerPoolPluginOptions | undefined
- runtime: IRuntimeServices
- Optionalcollector: WorkerPoolCollector
  Present only when the application registered CAPABILITIES.METRICS. Threaded into every pool this service creates.
Returns WorkerPoolService
- Defined in packages/worker-pool-plugin/src/services/worker-pool-service.ts:73

Methods

run

run<TInput, TOutput>(
    taskModule: string,
    input: TInput,
    options?: WorkerRunOptions,
): Promise<TOutput>
Runs a task on the pool for taskModule, creating it lazily.
Type Parameters
- TInput
- TOutput
Parameters
- taskModule: string
  Module specifier of a defineWorkerTask module
- input: TInput
  Structured-clonable task input
- Optionaloptions: WorkerRunOptions
  Per-call options
Returns Promise<TOutput>
The task's output

Throws
When the runtime has no worker support

Throws
When options.timeoutMs is not 0 or a positive integer no greater than 2 147 483 647 (the call is rejected, not admitted)
Implementation of IWorkerPool.run
- Defined in packages/worker-pool-plugin/src/services/worker-pool-service.ts:101

shutdown

shutdown(): Promise<void>
Shuts down every pool (terminating workers, rejecting pending tasks). Safe to call more than once.

Returns Promise<void>
Implementation of IWorkerPool.shutdown
- Defined in packages/worker-pool-plugin/src/services/worker-pool-service.ts:158

stats

stats(): readonly TaskPoolStats[]
Returns a snapshot of every pool created so far.

Returns readonly TaskPoolStats[]
One TaskPoolStats per task module
Implementation of IWorkerPool.stats
- Defined in packages/worker-pool-plugin/src/services/worker-pool-service.ts:150

Class WorkerPoolService

Since

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns WorkerPoolService

Methods

run

Type Parameters

Parameters

Returns Promise<TOutput>

Throws

Throws

shutdown

Returns Promise<void>

stats

Returns readonly TaskPoolStats[]

Settings

On This Page