bianco.dom-to-array - npm Package Compare versions

Comparing version 0.0.4 to 0.0.5

index.js

@@ -6,3 +6,3 @@ 'use strict';
  * @param   { HTMLElement|NodeList } els - single html element or a node list
- * @returns { Object } always a loopable object
+ * @returns { Array } always a loopable object
  */
@@ -9,0 +9,0 @@ function domToArray(els) {

index.next.js

 /**
  * Converts any DOM node/s to a loopable array
  * @param   { HTMLElement|NodeList } els - single html element or a node list
- * @returns { Object } always a loopable object
+ * @returns { Array } always a loopable object
  */
@@ -6,0 +6,0 @@ export default function domToArray(els) {

package.json

 {
   "name": "bianco.dom-to-array",
-  "version": "0.0.4",
+  "version": "0.0.5",
   "description": "Converts any DOM node/s to a loopable array",
@@ -11,2 +11,3 @@ "main": "index.js",
     "build": "rollup -c",
+    "doc": "documentation readme index.next.js -s API",
     "test": "npm run lint && mocha test.js"
@@ -13,0 +14,0 @@ },

README.md

@@ -9,4 +9,2 @@ # bianco.dom-to-array
 
-
-
 ## Usage
@@ -37,18 +35,30 @@
 Array.isArray($li) // => true
-
 ```
 
+[travis-image]: https://img.shields.io/travis/biancojs/dom-to-array.svg?style=flat-square
+
+[travis-url]: https://travis-ci.org/biancojs/dom-to-array
+
+[license-image]: http://img.shields.io/badge/license-MIT-000000.svg?style=flat-square
+
+[license-url]: LICENSE.txt
+
+[npm-version-image]: http://img.shields.io/npm/v/bianco.dom-to-array.svg?style=flat-square
+
+[npm-downloads-image]: http://img.shields.io/npm/dm/bianco.dom-to-array.svg?style=flat-square
+
+[npm-url]: https://npmjs.org/package/bianco.dom-to-array
+
 ## API
 
-- `domToArray` Converts any DOM node/s to a loopable array
+<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
 
+### domToArray
 
-[travis-image]:https://img.shields.io/travis/biancojs/dom-to-array.svg?style=flat-square
-[travis-url]:https://travis-ci.org/biancojs/dom-to-array
+Converts any DOM node/s to a loopable array
 
-[license-image]:http://img.shields.io/badge/license-MIT-000000.svg?style=flat-square
-[license-url]:LICENSE.txt
+**Parameters**
 
-[npm-version-image]:http://img.shields.io/npm/v/bianco.dom-to-array.svg?style=flat-square
-[npm-downloads-image]:http://img.shields.io/npm/dm/bianco.dom-to-array.svg?style=flat-square
-[npm-url]:https://npmjs.org/package/bianco.dom-to-array
+-   `els` **([HTMLElement](https://developer.mozilla.org/en-US/docs/Web/HTML/Element) \| [NodeList](https://developer.mozilla.org/en-US/docs/Web/API/NodeList))** single html element or a node list
+
+Returns **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)** always a loopable object

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

4970

increased by11.34%

Number of lines in readme file

63

increased by18.87%

No dependency changes