Type alias Command

Command: {
    id: number;
    inMemory: boolean;
    json: CommandJSON | undefined;
    name: string;
    type: string;
    updatable: boolean;
    execute(...args) => void;
    undo() => void;
} & EditorPointer & SerializableObject & Test

Type declaration

  • id: number

    Unique id of the command

  • inMemory: boolean

    Whether the command is in memory.

  • json: CommandJSON | undefined
  • name: string

    Human readable name of the command

  • type: string

    Type of the command

  • updatable: boolean

    Whether the command is updatable.

    If the command is NOT updatable, it's added as a new part of the history

  • execute:function
    • execute(...args): void

    • Execute the command, if possible.

      Parameters

      • Rest ...args: any[]

      Returns void

      If the command is executed successfully, return void. Otherwise, throw an error.

  • undo:function
    • undo(): void

    • Undo the command.

      Returns void

      If the command is executed successfully, return void. Otherwise, throw an error.

Settings

Member Visibility

Theme

Generated using TypeDoc