Class Sweep

A running parameter sweep: a thin wrapper binding sweep identity to a FanOut so consumers get id/name/size alongside live fan-out progress. It holds the same FanOut instance being driven (never a copy), so summary always reflects current state. Driving it (pump on each tick) is the consumer's job unless it was started via SpawnClient.startSweep, which pumps it for you.

Index

Constructors

Properties

fanOut id name size

Accessors

isComplete summary

Methods

Constructors

constructor

new Sweep(
built: Pick<BuiltSweep, "id" | "name" | "size">,
fanOut: FanOut,
): Sweep
Parameters
- built: Pick<BuiltSweep, "id" | "name" | "size">
- fanOut: FanOut
Returns Sweep
- Defined in core/sweep.ts:159

Properties

`Readonly`fanOut

fanOut: FanOut

`Readonly`id

id: string

`Readonly`name

name: string

`Readonly`size

size: number

Accessors

isComplete

get isComplete(): boolean
Returns boolean
- Defined in core/sweep.ts:185

summary

get summary(): FanOutSummary
Returns FanOutSummary
- Defined in core/sweep.ts:182

Methods

pump

pump(nowMs: number): Promise<boolean>
Parameters
- nowMs: number
Returns Promise<boolean>
- Defined in core/sweep.ts:178

`Static`create

create(
    client: SpawnClient,
    spec: string | ParamSpec,
    opts?: SweepOptions,
): Sweep
Build from a spec and wire up a fresh FanOut over the given client.
Parameters
- client: SpawnClient
- spec: string | ParamSpec
- opts: SweepOptions = {}
Returns Sweep
- Defined in core/sweep.ts:169