feat: add filter by type function

stfsy · Jul 6, 2021 · c3e11a8 · c3e11a8
1 parent c2a14ab
commit c3e11a8
Show file tree

Hide file tree

Showing 2 changed files with 50 additions and 1 deletion.
diff --git a/lib/node.js b/lib/node.js
@@ -253,14 +253,29 @@ class Node {
 
     /**
       * Search a node and its children for nodes passing a test function.
-      * @param {Node} node the root node
+      * @param {Function} callback the callback returns true for elements that should be in the returned array
       * @param {Number} [limit=Infinity] limit the max number of results
       * @returns {Array<Node>}
     */
     filter(callback, limit = Infinity) {
         return domUtils.filter(callback, this._element, true, limit).map(el => Node.of(el))
     }
 
+    /**
+    * Search a node and its children by type for nodes passing a test function.
+    * @param {Function} callback the callback returns true for elements that should be in the returned array
+    * @param {Array<String>} types for these types the callback will be fired @see i.e. Node.TYPE_TAG
+    * @param {Number} [limit=Infinity] limit the max number of results
+    * @returns {Array<Node>}
+    */
+    filterByType(callback, types, limit = Infinity) {
+        return this.filter((node) => {
+            if (types.includes(node.type)) {
+                callback(node)
+            }
+        }, limit)
+    }
+
     /**
       * Removes a child node
       * @param {Node|Array<Node>} child the child node to remove

diff --git a/test/spec/node.spec.js b/test/spec/node.spec.js
@@ -25,6 +25,40 @@ describe('Node', () => {
         expect(count).to.be.equal(5)
     })
 
+    it('should callback for each node and childnodes by type tag', () => {
+        const node = Node.fromString(['<head>',
+            '<meta content="" name="description">',
+            '<style></style>',
+            '<script></script>',
+            '<meta content="width=device-width,user-scalable=no" name="viewport">',
+            '<meta content="#795548" name="theme-color">',
+            '<title></title>',
+            '</head>'].join(''))
+
+        let count = 0
+        node.filterByType((el) => {
+            count += 1
+        }, [Node.TYPE_TAG])
+        expect(count).to.be.equal(5)
+    })
+
+    it('should callback for each node and childnodes by type style and script', () => {
+        const node = Node.fromString(['<head>',
+            '<meta content="" name="description">',
+            '<style></style>',
+            '<script></script>',
+            '<meta content="width=device-width,user-scalable=no" name="viewport">',
+            '<meta content="#795548" name="theme-color">',
+            '<title></title>',
+            '</head>'].join(''))
+
+        let count = 0
+        node.filterByType((el) => {
+            count += 1
+        }, [Node.TYPE_STYLE, Node.TYPE_SCRIPT])
+        expect(count).to.be.equal(2)
+    })
+
     it('returns children when callback returned true', () => {
         const node = Node.fromString(['<head>',
             '<meta content="" name="description">',