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): 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)

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

run

toString

Settings

Member Visibility

Theme

On This Page

checkruntoString