@vielzeug/familiar

Web Worker pool with tasks, timeouts, cancellation

Installation

pnpm add @vielzeug/familiar
npm install @vielzeug/familiar
yarn add @vielzeug/familiar

Quick Start

// sum.worker.ts
import { exposeTask } from '@vielzeug/familiar/protocol';

exposeTask((values: number[]) => values.reduce((total, value) => total + value, 0));

// main.ts
import { createWorker } from '@vielzeug/familiar';

const pool = createWorker<number[], number>(new URL('./sum.worker.ts', import.meta.url), {
  concurrency: 2,
  timeout: 5_000,
});

try {
  console.log(await pool.run([1, 2, 3]));
} finally {
  pool.dispose();
}

Documentation

• Overview
• Usage Guide
• API Reference
• Examples
• Migration Guide

License

MIT © Helmuth Saatkamp: part of the Vielzeug monorepo.