@types/prosemirror-collab - npm Package Compare versions

Comparing version 0.21.2 to 1.0.0

prosemirror-collab/index.d.ts

@@ -1,14 +0,43 @@
-// Type definitions for prosemirror-collab 0.21
+// Type definitions for prosemirror-collab 1.0
 // Project: https://github.com/ProseMirror/prosemirror-collab
 // 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';
 import { Step } from 'prosemirror-transform';
 
-export function collab<T>(config?: { version?: number, clientID?: number | string }): Plugin<T>;
+/**
+ * Creates a plugin that enables the collaborative editing framework
+ * for the editor.
+ */
+export function collab(config?: { version?: number | null, clientID?: number | string | null }): Plugin;
+/**
+ * Create a transaction that represents a set of new steps received from
+ * the authority. Applying this transaction moves the state forward to
+ * adjust to the authority's view of the document.
+ */
 export function receiveTransaction(state: EditorState, steps: Step[], clientIDs: Array<number | string>): Transaction;
-export function sendableSteps(state: EditorState): { version: number, steps: Step[], clientID: number | string, origins: Transaction[] } | null;
+/**
+ * Provides data describing the editor's unconfirmed steps, which need
+ * to be sent to the central authority. Returns null when there is
+ * nothing to send.
+ *
+ * `origins` holds the _original_ transactions that produced each
+ * steps. This can be useful for looking up time stamps and other
+ * metadata for the steps, but note that the steps may have been
+ * rebased, whereas the origin transactions are still the old,
+ * unchanged objects.
+ */
+export function sendableSteps(state: EditorState): { version: number, steps: Step[], clientID: number | string, origins: Transaction[] } | null | void;
+/**
+ * Get the version up to which the collab plugin has synced with the
+ * central authority.
+ */
 export function getVersion(state: EditorState): number;

prosemirror-collab/package.json

 {
     "name": "@types/prosemirror-collab",
-    "version": "0.21.2",
+    "version": "1.0.0",
     "description": "TypeScript definitions for prosemirror-collab",
@@ -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"
         }
@@ -27,4 +34,4 @@ ],
     },
-    "typesPublisherContentHash": "e9e2bfb3459e38c69d5b057e728c5b99acbe5f508a757db6552a63e957389acf",
-    "typeScriptVersion": "2.3"
+    "typesPublisherContentHash": "7b4ee951c482a54a12e916d65ad7c61f12c1b913c958bdc0fcc1407b10eaecc0",
+    "typeScriptVersion": "2.1"
 }

prosemirror-collab/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, prosemirror-transform
@@ -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

4937

increased by43.02%

Lines of code

40

increased by233.33%

Number of low quality alerts

1

decreased by-50%

No dependency changes