Interface ICommand<Model, Real, RunResult, CheckAsync>

Interface that should be implemented in order to define a command


Since 1.5.0

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

Type Parameters

  • Model extends object
  • Real
  • RunResult
  • CheckAsync extends boolean = false

Hierarchy (view full)


  • Check if the model is in the right state to apply the command

    WARNING: does not change the model


    • m: Readonly<Model>

      Model, simplified or schematic representation of real system

    Returns CheckAsync extends false
        ? boolean
        : Promise<boolean>


    Since 1.5.0