Variable defineJobConst

Type Declaration

• • <S extends ArgSpec = NoFlags>(declaration: JobDeclaration<S>): JobModule

  • Declare a runnable. Validates the declaration and returns it frozen; nothing runs until jeeves-scripts run <id> runs it.

    Type Parameters

    • S extends ArgSpec = NoFlags

    Parameters

    • declaration: JobDeclaration<S>

    Returns JobModule

    Example

    export default defineRunnable({
      id: 'acme-report',
      domain: 'acme',
      prerequisite: () => hasAcmeConfig() || 'no acme block in the instance config',
      flags: { live: argFlag('--live', 'Write changes (default: dry run)') },
      run: async ({ flags }) => { await report(flags.live); },
    });
    Copy

    Throws

    When the declaration is invalid (bad id, missing run, ...).