@types/prosemirror-keymap - npm Package Compare versions

Comparing version 0.24.0 to 1.0.0

prosemirror-keymap/index.d.ts

@@ -1,16 +0,53 @@
-// Type definitions for prosemirror-keymap 0.24
+// Type definitions for prosemirror-keymap 1.0
 // Project: https://github.com/ProseMirror/prosemirror-keymap
 // 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
 
+// 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 { Plugin } from 'prosemirror-state';
 import { EditorView } from 'prosemirror-view';
 
-export interface Bindings {
-    [key: string]: any;
-}
-
-export function keymap<T>(bindings: Bindings): Plugin<T>;
-export function keydownHandler(bindings: Bindings): (view: EditorView, event: Event) => boolean;
+/**
+ * Create a keymap plugin for the given set of bindings.
+ *
+ * Bindings should map key names to [command](#commands)-style
+ * functions, which will be called with `(EditorState, dispatch,
+ * EditorView)` arguments, and should return true when they've handled
+ * the key. Note that the view argument isn't part of the command
+ * protocol, but can be used as an escape hatch if a binding needs to
+ * directly interact with the UI.
+ *
+ * Key names may be strings like `"Shift-Ctrl-Enter"`—a key
+ * identifier prefixed with zero or more modifiers. Key identifiers
+ * are based on the strings that can appear in
+ * [`KeyEvent.key`](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key).
+ * Use lowercase letters to refer to letter keys (or uppercase letters
+ * if you want shift to be held). You may use `"Space"` as an alias
+ * for the `" "` name.
+ *
+ * Modifiers can be given in any order. `Shift-` (or `s-`), `Alt-` (or
+ * `a-`), `Ctrl-` (or `c-` or `Control-`) and `Cmd-` (or `m-` or
+ * `Meta-`) are recognized. For characters that are created by holding
+ * shift, the `Shift-` prefix is implied, and should not be added
+ * explicitly.
+ *
+ * You can use `Mod-` as a shorthand for `Cmd-` on Mac and `Ctrl-` on
+ * other platforms.
+ *
+ * You can add multiple keymap plugins to an editor. The order in
+ * which they appear determines their precedence (the ones early in
+ * the array get to dispatch first).
+ */
+export function keymap(bindings: { [key: string]: any }): Plugin;
+/**
+ * Given a set of bindings (using the same format as
+ * [`keymap`](#keymap.keymap), return a [keydown
+ * handler](#view.EditorProps.handleKeyDown) handles them.
+ */
+export function keydownHandler(bindings: { [key: string]: any }): (view: EditorView, event: Event) => boolean;

prosemirror-keymap/package.json

 {
     "name": "@types/prosemirror-keymap",
-    "version": "0.24.0",
+    "version": "1.0.0",
     "description": "TypeScript definitions for prosemirror-keymap",
@@ -16,2 +16,7 @@ "license": "MIT",
             "githubUsername": "davidka"
+        },
+        {
+            "name": "Tim Baumann",
+            "url": "https://github.com/timjb",
+            "githubUsername": "timjb"
         }
@@ -29,4 +34,4 @@ ],
     },
-    "typesPublisherContentHash": "862e59e0ff0629030c89aba175b3ef97a4ec6c1e8b3e9679eef934522154c1e6",
-    "typeScriptVersion": "2.3"
+    "typesPublisherContentHash": "eb8f75c5b4e3ee71b49e983759946dd17d874a4e9904fcc17c34abfdc443682c",
+    "typeScriptVersion": "2.1"
 }

prosemirror-keymap/README.md

@@ -11,3 +11,3 @@ # Installation
 Additional Details
- * Last updated: Tue, 26 Sep 2017 18:18:49 GMT
+ * Last updated: Wed, 25 Oct 2017 16:18:55 GMT
  * Dependencies: prosemirror-state, prosemirror-view
@@ -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

5403

increased by63.88%

Lines of code

50

increased by284.62%

Number of low quality alerts

1

decreased by-50%

No dependency changes