Interface ICommand<Model, Real, RunResult, CheckAsync>

Interface that should be implemented in order to define a command

Remarks

Since 1.5.0

interface ICommand<Model, Real, RunResult, CheckAsync> {
    check(m: Readonly<Model>): CheckAsync extends false
        ? boolean
        : Promise<boolean>;
    run(m: Model, r: Real): RunResult;
    toString(): string;
}

Type Parameters

Model extends object
Real
RunResult
CheckAsync extends boolean = false

Hierarchy (view full)

ICommand
- AsyncCommand
- Command

Index

Methods

check run toString

Methods

check

check(m): CheckAsync extends false
? boolean
: Promise<boolean>
Check if the model is in the right state to apply the command

WARNING: does not change the model
Parameters
- m: Readonly<Model>
  Model, simplified or schematic representation of real system
Returns CheckAsync extends false
? boolean
: Promise<boolean>
Remarks
Since 1.5.0
- Defined in packages/fast-check/src/check/model/command/ICommand.ts:21

run

run(m, r): RunResult
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
Parameters
- m: Model
  Model, simplified or schematic representation of real system
- r: Real
  Sytem under test
Returns RunResult
Remarks
Since 1.5.0
- Defined in packages/fast-check/src/check/model/command/ICommand.ts:33

toString

toString(): string
Name of the command

Returns string
Remarks
Since 1.5.0
- Defined in packages/fast-check/src/check/model/command/ICommand.ts:39