@types/prosemirror-schema-list - npm Package Compare versions

Comparing version 0.21.0 to 1.0.0

prosemirror-schema-list/index.d.ts

@@ -1,8 +0,13 @@
-// Type definitions for prosemirror-schema-list 0.21
+// Type definitions for prosemirror-schema-list 1.0
 // Project: https://github.com/ProseMirror/prosemirror-schema-list
 // 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.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 OrderedMap = require('orderedmap');
@@ -12,9 +17,53 @@ import { NodeSpec, NodeType } from 'prosemirror-model';
 
+/**
+ * An ordered list [node spec](#model.NodeSpec). Has a single
+ * attribute, `order`, which determines the number at which the list
+ * starts counting, and defaults to 1. Represented as an `<ol>`
+ * element.
+ */
 export let orderedList: NodeSpec;
+/**
+ * A bullet list node spec, represented in the DOM as `<ul>`.
+ */
 export let bulletList: NodeSpec;
+/**
+ * A list item (`<li>`) spec.
+ */
 export let listItem: NodeSpec;
-export function addListNodes<T>(nodes: OrderedMap<T>, itemContent: string, listGroup?: string): OrderedMap<T>;
+/**
+ * Convenience function for adding list-related node types to a map
+ * specifying the nodes for a schema. Adds
+ * [`orderedList`](#schema-list.orderedList) as `"ordered_list"`,
+ * [`bulletList`](#schema-list.bulletList) as `"bullet_list"`, and
+ * [`listItem`](#schema-list.listItem) as `"list_item"`.
+ *
+ * `itemContent` determines the content expression for the list items.
+ * If you want the commands defined in this module to apply to your
+ * list structure, it should have a shape like `"paragraph block*"` or
+ * `"paragraph (ordered_list | bullet_list)*"`. `listGroup` can be
+ * given to assign a group name to the list node types, for example
+ * `"block"`.
+ */
+export function addListNodes(nodes: OrderedMap<NodeSpec>, itemContent: string, listGroup?: string): OrderedMap<NodeSpec>;
+/**
+ * Returns a command function that wraps the selection in a list with
+ * the given type an attributes. If `dispatch` is null, only return a
+ * value to indicate whether this is possible, but don't actually
+ * perform the change.
+ */
 export function wrapInList(listType: NodeType, attrs?: { [key: string]: any }): (state: EditorState, dispatch?: (tr: Transaction) => void) => boolean;
+/**
+ * Build a command that splits a non-empty textblock at the top level
+ * of a list item by also splitting that list item.
+ */
 export function splitListItem(itemType: NodeType): (state: EditorState, dispatch?: (tr: Transaction) => void) => boolean;
+/**
+ * Create a command to lift the list item around the selection up into
+ * a wrapping list.
+ */
 export function liftListItem(itemType: NodeType): (state: EditorState, dispatch?: (tr: Transaction) => void) => boolean;
+/**
+ * Create a command to sink the list item around the selection down
+ * into an inner list.
+ */
 export function sinkListItem(itemType: NodeType): (state: EditorState, dispatch?: (tr: Transaction) => void) => boolean;

prosemirror-schema-list/package.json

 {
     "name": "@types/prosemirror-schema-list",
-    "version": "0.21.0",
+    "version": "1.0.0",
     "description": "TypeScript definitions for prosemirror-schema-list",
@@ -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"
         }
@@ -28,5 +35,4 @@ ],
     },
-    "peerDependencies": {},
-    "typesPublisherContentHash": "5154da58ecf4183cc803ca0bed7c613e8de6fec52f23d9807bd33d7f1948fd48",
+    "typesPublisherContentHash": "5324e0b3946fcdae3138002babe7f36070687b36bb09a3a780ae72d11ab177fe",
     "typeScriptVersion": "2.1"
 }

prosemirror-schema-list/README.md

@@ -11,3 +11,3 @@ # Installation
 Additional Details
- * Last updated: Thu, 01 Jun 2017 05:11:21 GMT
+ * Last updated: Wed, 25 Oct 2017 16:18:55 GMT
  * Dependencies: orderedmap, prosemirror-model, 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

6098

increased by54.38%

Lines of code

65

increased by282.35%

Number of low quality alerts

1

decreased by-50%

No dependency changes