Type Alias JobDeclaration<S>

JobDeclaration: Omit<
    z.infer<typeof jobDeclarationSchema>,
    "flags" | "prerequisite" | "doctorCheck" | "run",
> & {
    doctorCheck?: JobPrerequisite<S>;
    flags?: S;
    prerequisite?: JobPrerequisite<S>;
    run: JobRun<S>;
}

A runnable declaration; S is its flag spec, which types ctx.flags.

Type Parameters

S extends ArgSpec = NoFlags

Type Declaration

OptionaldoctorCheck?: JobPrerequisite<S>

Checked by doctor only, once prerequisite is met (see jobDeclarationSchema).
Optionalflags?: S

See jobDeclarationSchema.
Optionalprerequisite?: JobPrerequisite<S>

Checked before run; anything but true skips the run.
run: JobRun<S>

The job body.