Type Alias JobModule

JobModule: Readonly<
    Omit<
        z.infer<typeof jobDeclarationSchema>,
        "prerequisite" | "doctorCheck" | "run",
    >,
> & {
    "[JOB]": true;
    doctorCheck?: (
        ctx: JobCallContext,
    ) => true | string | Promise<true | string>;
    prerequisite?: (
        ctx: JobCallContext,
    ) => true | string | Promise<true | string>;
    run: (ctx: JobCallContext) => void | Promise<void>;
}

A declared job, as defineRunnable returns it.

Type Declaration

Readonly[JOB]: true

Brand set by defineRunnable; see isJobModule.
Optional ReadonlydoctorCheck?: (ctx: JobCallContext) => true | string | Promise<true | string>

Checked by doctor only, once prerequisite is met.
Optional Readonlyprerequisite?: (ctx: JobCallContext) => true | string | Promise<true | string>

Checked before run; anything but true skips the run.
Readonlyrun: (ctx: JobCallContext) => void | Promise<void>

The job body.

Type Alias JobModule

Type Declaration

`Readonly`[JOB]: true

`Optional` `Readonly`doctorCheck?: (ctx: JobCallContext) => true | string | Promise<true | string>

`Optional` `Readonly`prerequisite?: (ctx: JobCallContext) => true | string | Promise<true | string>

`Readonly`run: (ctx: JobCallContext) => void | Promise<void>

Settings

Type Alias JobModule

Type Declaration

Readonly[JOB]: true

Optional ReadonlydoctorCheck?: (ctx: JobCallContext) => true | string | Promise<true | string>

Optional Readonlyprerequisite?: (ctx: JobCallContext) => true | string | Promise<true | string>

Readonlyrun: (ctx: JobCallContext) => void | Promise<void>

Settings

`Readonly`[JOB]: true

`Optional` `Readonly`doctorCheck?: (ctx: JobCallContext) => true | string | Promise<true | string>

`Optional` `Readonly`prerequisite?: (ctx: JobCallContext) => true | string | Promise<true | string>

`Readonly`run: (ctx: JobCallContext) => void | Promise<void>