Interface Command<Model, Real>

Interface that should be implemented in order to define a synchronous command

Remarks

Since 1.5.0

interface Command<Model, Real> {
    check(m): boolean;
    run(m, r): void;
    toString(): string;
}

Type Parameters

Model extends object
Real

Hierarchy (view full)

ICommand<Model, Real, void>
- Command

Index

Methods

check run toString

Methods

check

check(m): 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 boolean
Remarks
Since 1.5.0
Inherited from ICommand.check
- Defined in packages/fast-check/src/check/model/command/ICommand.ts:21

run

run(m, r): void
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 void
Remarks
Since 1.5.0
Inherited from ICommand.run
- 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
Inherited from ICommand.toString
- Defined in packages/fast-check/src/check/model/command/ICommand.ts:39