bianco.query - npm Package Compare versions

Comparing version 0.0.3 to 0.0.4

index.js

@@ -11,3 +11,3 @@ 'use strict';
  * @param   { HTMLElement }        ctx      - context defining where the query will search for the DOM nodes
- * @returns { Object } DOM nodes in an array like object
+ * @returns { Array } DOM nodes found as array
  */
@@ -14,0 +14,0 @@ function $(selector, ctx) {

index.next.js

@@ -7,3 +7,3 @@ import domToArray from 'bianco.dom-to-array'
  * @param   { HTMLElement }        ctx      - context defining where the query will search for the DOM nodes
- * @returns { Object } DOM nodes in an array like object
+ * @returns { Array } DOM nodes found as array
  */
@@ -10,0 +10,0 @@ export default function $(selector, ctx) {

package.json

 {
   "name": "bianco.query",
-  "version": "0.0.3",
+  "version": "0.0.4",
   "description": "Modern DOM query selectors helpers written in es2015",
@@ -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

@@ -25,18 +25,31 @@ # bianco.query
 $('h1', 'main').forEach(h1 => h1.classList.add('main-title'))
-
 ```
 
+[travis-image]: https://img.shields.io/travis/biancojs/query.svg?style=flat-square
+
+[travis-url]: https://travis-ci.org/biancojs/query
+
+[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.query.svg?style=flat-square
+
+[npm-downloads-image]: http://img.shields.io/npm/dm/bianco.query.svg?style=flat-square
+
+[npm-url]: https://npmjs.org/package/bianco.query
+
 ## API
 
-- `$(selector|NodeList, context)` returns always an array like object containing the elements found
+<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
 
+### $
 
-[travis-image]:https://img.shields.io/travis/biancojs/query.svg?style=flat-square
-[travis-url]:https://travis-ci.org/biancojs/query
+Simple helper to find DOM nodes returning them as array like loopable object
 
-[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.query.svg?style=flat-square
-[npm-downloads-image]:http://img.shields.io/npm/dm/bianco.query.svg?style=flat-square
-[npm-url]:https://npmjs.org/package/bianco.query
+-   `selector` **([String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) | DOMNodeList)** either the query or the DOM nodes to arraify
+-   `ctx` **[HTMLElement](https://developer.mozilla.org/en-US/docs/Web/HTML/Element)** context defining where the query will search for the DOM nodes
+
+Returns **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)** DOM nodes found as array

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

5150

increased by13.29%

Number of lines in readme file

55

increased by30.95%

No dependency changes