undo-redo.api.md

API Report File for "@fluidframework/undo-redo"

Do not edit this file. It is a report generated by API Extractor.

import { ISegment } from '@fluidframework/merge-tree';
import { ISharedMap } from '@fluidframework/map';
import { IValueChanged } from '@fluidframework/map';
import { SequenceDeltaEvent } from '@fluidframework/sequence';
import { SharedSegmentSequence } from '@fluidframework/sequence';

// @public (undocumented)
export interface IRevertible {
    // (undocumented)
    discard(): any;
    // (undocumented)
    revert(): any;
}

// @public
export class SharedMapRevertible implements IRevertible {
    constructor(changed: IValueChanged, map: ISharedMap);
    // (undocumented)
    discard(): void;
    // (undocumented)
    revert(): void;
}

// @public
export class SharedMapUndoRedoHandler {
    constructor(stackManager: UndoRedoStackManager);
    // (undocumented)
    attachMap(map: ISharedMap): void;
    // (undocumented)
    detachMap(map: ISharedMap): void;
}

// @public
export class SharedSegmentSequenceRevertible implements IRevertible {
    constructor(sequence: SharedSegmentSequence<ISegment>);
    // (undocumented)
    add(event: SequenceDeltaEvent): void;
    // (undocumented)
    discard(): void;
    // (undocumented)
    revert(): void;
    // (undocumented)
    readonly sequence: SharedSegmentSequence<ISegment>;
}

// @public
export class SharedSegmentSequenceUndoRedoHandler {
    constructor(stackManager: UndoRedoStackManager);
    // (undocumented)
    attachSequence<T extends ISegment>(sequence: SharedSegmentSequence<T>): void;
    // (undocumented)
    detachSequence<T extends ISegment>(sequence: SharedSegmentSequence<T>): void;
}

// @public
export class UndoRedoStackManager {
    constructor();
    // (undocumented)
    closeCurrentOperation(): void;
    // (undocumented)
    on(event: "changePushed", listener: () => void): void;
    // (undocumented)
    pushToCurrentOperation(revertible: IRevertible): void;
    // (undocumented)
    redoOperation(): boolean;
    // (undocumented)
    removeListener(event: "changePushed", listener: () => void): void;
    // (undocumented)
    undoOperation(): boolean;
}