Noteworthy Programming Masterpiece

    @types/prosemirror-history
    TypeScript icon, indicating that this package has built-in type declarations

    1.0.3 • Public • Published

    Installation

    npm install --save @types/prosemirror-history

    Summary

    This package contains type definitions for prosemirror-history (https://github.com/ProseMirror/prosemirror-history).

    Details

    Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/prosemirror-history.

    index.d.ts

    // Type definitions for prosemirror-history 1.0
    // Project: https://github.com/ProseMirror/prosemirror-history
    // Definitions by: Bradley Ayers <https://github.com/bradleyayers>
    //                 David Hahn <https://github.com/davidka>
    //                 Tim Baumann <https://github.com/timjb>
    //                 Patrick Simmelbauer <https://github.com/patsimm>
    // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
    // TypeScript Version: 2.3
    
    import { Schema } from 'prosemirror-model';
    import { EditorState, Plugin, Transaction } from 'prosemirror-state';
    
    /**
     * Set a flag on the given transaction that will prevent further steps
     * from being appended to an existing history event (so that they
     * require a separate undo command to undo).
     */
    export function closeHistory<S extends Schema = any>(tr: Transaction<S>): Transaction<S>;
    /**
     * Returns a plugin that enables the undo history for an editor. The
     * plugin will track undo and redo stacks, which can be used with the
     * [`undo`](#history.undo) and [`redo`](#history.redo) commands.
     *
     * You can set an `"addToHistory"` [metadata
     * property](#state.Transaction.setMeta) of `false` on a transaction
     * to prevent it from being rolled back by undo.
     */
    export function history(config?: { depth?: number | null | undefined; newGroupDelay?: number | null | undefined }): Plugin;
    /**
     * A command function that undoes the last change, if any.
     */
    export function undo<S extends Schema = any>(state: EditorState<S>, dispatch?: (tr: Transaction<S>) => void): boolean;
    /**
     * A command function that redoes the last undone change, if any.
     */
    export function redo<S extends Schema = any>(state: EditorState<S>, dispatch?: (tr: Transaction<S>) => void): boolean;
    /**
     * The amount of undoable events available in a given state.
     */
    export function undoDepth(state: EditorState): number;
    /**
     * The amount of redoable events available in a given editor state.
     */
    export function redoDepth(state: EditorState): number;

    Additional Details

    Credits

    These definitions were written by Bradley Ayers, David Hahn, Tim Baumann, and Patrick Simmelbauer.

    Keywords

    none

    Install

    npm i @types/prosemirror-history

    DownloadsWeekly Downloads

    186,704

    Version

    1.0.3

    License

    MIT

    Unpacked Size

    7.46 kB

    Total Files

    4

    Last publish

    Collaborators

    • types