@paraharness/lockfile

Cross-process advisory lockfile utility for Paraharness. This package coordinates exclusive access to shared host files across concurrent processes and in-process async tasks using p-queue FIFO serialization, atomic wx lockfile creation, .unref()ed utimes heartbeats, and dead-PID or stale-mtime lock reclamation.

Installation

With npm:

npm install @paraharness/lockfile

With yarn:

yarn add @paraharness/lockfile

With pnpm:

pnpm add @paraharness/lockfile

Usage

import { withFileLock } from '@paraharness/lockfile';

const result = await withFileLock(
  '.harness/lessons.lock',
  async () => {
    return { updated: true };
  },
  {
    staleMs: 10_000,
    heartbeatIntervalMs: 2_000,
    timeoutMs: 30_000,
  },
);

Documentation

See the @paraharness/lockfile API Reference for full type and builder specifications.

License

MIT © Tornike Tsomaia