@types/prosemirror-history - npm Package Compare versions

Comparing version 0.21.2 to 1.0.0

prosemirror-history/index.d.ts

@@ -1,15 +0,46 @@
-// Type definitions for prosemirror-history 0.21
+// 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>
 // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
-// TypeScript Version: 2.3
+// TypeScript Version: 2.1
 
-import { Plugin, EditorState, Transaction } from 'prosemirror-state';
+// IMPORTANT
+// This file was generated by https://github.com/bradleyayers/getdocs2ts. Please do not edit manually.
+// When you find an error in these declarations, fix the getdocs comment upstream or 'getdocs2ts', then regenerate.
 
+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(tr: Transaction): Transaction;
-export function history<T>(config?: { depth?: number, newGroupDelay: number, preserveItems?: boolean }): Plugin<T>;
+/**
+ * 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, newGroupDelay?: number | null }): Plugin;
+/**
+ * A command function that undoes the last change, if any.
+ */
 export function undo(state: EditorState, dispatch?: (tr: Transaction) => void): boolean;
+/**
+ * A command function that redoes the last undone change, if any.
+ */
 export function redo(state: EditorState, dispatch?: (tr: Transaction) => 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;

prosemirror-history/package.json

 {
     "name": "@types/prosemirror-history",
-    "version": "0.21.2",
+    "version": "1.0.0",
     "description": "TypeScript definitions for prosemirror-history",
@@ -9,7 +9,14 @@ "license": "MIT",
             "name": "Bradley Ayers",
-            "url": "https://github.com/bradleyayers"
+            "url": "https://github.com/bradleyayers",
+            "githubUsername": "bradleyayers"
         },
         {
             "name": "David Hahn",
-            "url": "https://github.com/davidka"
+            "url": "https://github.com/davidka",
+            "githubUsername": "davidka"
+        },
+        {
+            "name": "Tim Baumann",
+            "url": "https://github.com/timjb",
+            "githubUsername": "timjb"
         }
@@ -26,4 +33,4 @@ ],
     },
-    "typesPublisherContentHash": "69ccbc82aa9b76787a012cd9497070f8a7319c0e5db09ff8fca5353d5356e847",
-    "typeScriptVersion": "2.3"
+    "typesPublisherContentHash": "7a9e38917f95a9caa084ddbad3e9aa86de34832eef39ba174cc5f998bf7fdfbb",
+    "typeScriptVersion": "2.1"
 }

prosemirror-history/README.md

@@ -11,3 +11,3 @@ # Installation
 Additional Details
- * Last updated: Mon, 21 Aug 2017 21:59:27 GMT
+ * Last updated: Wed, 25 Oct 2017 16:18:55 GMT
  * Dependencies: prosemirror-state
@@ -17,2 +17,2 @@ * Global values: none
 # Credits
-These definitions were written by Bradley Ayers <https://github.com/bradleyayers>, David Hahn <https://github.com/davidka>.
+These definitions were written by Bradley Ayers <https://github.com/bradleyayers>, David Hahn <https://github.com/davidka>, Tim Baumann <https://github.com/timjb>.

Fixed alerts

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

4855

increased by43.09%

Lines of code

43

increased by230.77%

Number of low quality alerts

1

decreased by-50%

No dependency changes