Skip to content

Rulvar API reference


Rulvar API reference / @rulvar/cli / Worker

Interface: Worker

Defined in: packages/cli/src/worker.ts:109

Methods

active()

ts
active(): string[];

Defined in: packages/cli/src/worker.ts:121

runIds currently held by this worker.

Returns

string[]


start()

ts
start(): void;

Defined in: packages/cli/src/worker.ts:111

Begins sweeping on the poll cadence. Idempotent.

Returns

void


stop()

ts
stop(): Promise<void>;

Defined in: packages/cli/src/worker.ts:119

Stops sweeping, cancels in-flight runs, releases held leases.

Returns

Promise&lt;void&gt;


sweep()

ts
sweep(): Promise<number>;

Defined in: packages/cli/src/worker.ts:117

One sweep: lease and resume eligible runs up to the concurrency cap. Returns the number of runs picked up. Exposed so hosts and tests can drive the worker deterministically without timers.

Returns

Promise&lt;number&gt;