@launchmenu/core/build/undoRedo/UndoRedoFacility.d.ts

An environment for visual keyboard controlled applets

import { IUndoRedoFacility } from "./_types/IUndoRedoFacility";
import { ICommand } from "./_types/ICommand";
import { IDataHook, Field } from "model-react";
import { ICommandsList } from "./_types/ICommandsList";
import { ICommandBatchFunction } from "./_types/ICommandBatchFunction";
/**
 * A command dispatcher and undo redo manager
 */
export declare class UndoRedoFacility implements IUndoRedoFacility {
    protected commands: Field<{
        past: ICommand[];
        future: ICommand[];
    }>;
    protected shouldSplitBatch: boolean;
    /**
     * Executes a given command
     * @param command The command to be executed
     * @param batchCommands Whether to batch this command with the previous command(s) if they also indicated to batch
     * @returns A promise that resolves when the command finishes executing or is canceled. true is returned if canceled
     */
    execute(command: ICommand, batchCommands?: boolean | ICommandBatchFunction): Promise<void>;
    /**
     * Makes sure the next executed command is not batched with the previous command,
     * even if the command specifies to be batched.
     */
    splitBatch(): void;
    /**
     * Steps 1 command back into the history
     * @returns A promise that resolves once the command is undone
     */
    undo(): Promise<void>;
    /**
     * Steps 1 command forward into the history
     * @returns A promise that resolves once the command is redone
     */
    redo(): Promise<void>;
    /**
     * Retrieves the state of the undo redo facility
     * @param hook The hook to subscribe to changes
     * @returns The current command facility state
     */
    getState(hook?: IDataHook): IUndoRedoFacilityState;
    /**
     * Retrieves all commands currently stored in the facility
     * @param hook The hook to subscribe to changes
     * @returns The currently stored commands
     */
    getCommands(hook?: IDataHook): ICommandsList;
}
//# sourceMappingURL=UndoRedoFacility.d.ts.map