API Reference/Core/createWorker
function

createWorker

typescript
function createWorker(
  options: WorkerOptions<TMessages, TDriver>
): Promise<WorkerClient<TMessages, TDriver extends Driver<C, unknown> ? C : DriverCapabilities>>

Create a worker process with type-safe messaging.

By default, uses the child_process driver which spawns a separate Node.js process and communicates via Unix domain sockets (or named pipes on Windows).

You can pass a different driver for alternative backends:

Parameters

NameTypeDescription
optionsWorkerOptions<TMessages, TDriver>Worker options including script path and optional driver

Returns

Promise<WorkerClient<TMessages, TDriver extends Driver<C, unknown> ? C : DriverCapabilities>>

Examples

typescript
const worker = await createWorker<MyMessages>({
  script: './worker.js',
});
typescript
import { WorkerThreadsDriver } from 'isolated-workers/drivers/worker-threads';

const worker = await createWorker<MyMessages>({
  script: './worker.js',
  driver: new WorkerThreadsDriver(),
});