checkscripts/dist/checkscript.d.ts

Inspired by Dan Slimmon's concept of "Do Nothing scripts", this project facilitates incremental automation of repetitive tasks.

import type { CheckscriptStep } from "./step.js";
export declare enum CheckscriptMode {
    RUN = 0,
    DOCUMENT = 1
}
export declare function checkscript<Context extends Object = {}>(name: string, description: string, context?: Context): Checkscript<Context>;
export { step } from "./step.js";
interface DocumentCheckscriptOptions {
    includeFooter: boolean;
}
declare class Checkscript<Context extends Object> {
    private _steps;
    private name;
    private description;
    private context;
    constructor(name: string, description: string, context: Context);
    steps: (this: Checkscript<Context>, ...steps: CheckscriptStep<Context>[]) => Checkscript<Context>;
    run: (this: Checkscript<Context>) => Promise<void>;
    document: (this: Checkscript<Context>, options?: DocumentCheckscriptOptions) => Promise<void>;
    private _runCheckscript;
}
//# sourceMappingURL=checkscript.d.ts.map