Interface Command<Model, Real>

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

remarks: Since 1.5.0

Type Parameters

Model extends object
Real

Hierarchy

ICommand<Model, Real, void>
- Command

Index

Methods

Methods

check

check(m: Readonly<Model>): boolean

Inherited from ICommand.check
- Defined in packages/fast-check/src/check/model/command/ICommand.ts:22
Check if the model is in the right state to apply the command

WARNING: does not change the model

remarks
Since 1.5.0

Parameters
- m: Readonly<Model>
  
  Model, simplified or schematic representation of real system
Returns boolean

run

run(m: Model, r: Real): void

Inherited from ICommand.run
- Defined in packages/fast-check/src/check/model/command/ICommand.ts:34
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

remarks
Since 1.5.0

Parameters
- m: Model
  
  Model, simplified or schematic representation of real system
- r: Real
  
  Sytem under test
Returns void

toString

toString(): string

Inherited from ICommand.toString
- Defined in packages/fast-check/src/check/model/command/ICommand.ts:40
Name of the command

remarks
Since 1.5.0

Returns string

Generated using TypeDoc