fast-check/lib/types/check/model/command/ICommand.d.ts

Property based testing framework for JavaScript (like QuickCheck)

/**
 * Interface that should be implemented in order to define a command
 * @remarks Since 1.5.0
 * @public
 */
export interface ICommand<Model extends object, Real, RunResult, CheckAsync extends boolean = false> {
    /**
     * Check if the model is in the right state to apply the command
     *
     * WARNING: does not change the model
     *
     * @param m - Model, simplified or schematic representation of real system
     *
     * @remarks Since 1.5.0
     */
    check(m: Readonly<Model>): CheckAsync extends false ? boolean : Promise<boolean>;
    /**
     * Receive the non-updated model and the real or system under test.
     * Perform the checks post-execution - Throw in case of invalid state.
     * Update the model accordingly
     *
     * @param m - Model, simplified or schematic representation of real system
     * @param r - Sytem under test
     *
     * @remarks Since 1.5.0
     */
    run(m: Model, r: Real): RunResult;
    /**
     * Name of the command
     * @remarks Since 1.5.0
     */
    toString(): string;
}