feat(core dom): Introduce to_element_array.

This method can be passed a single object, a NodeList or an array and
will return an array, filtered for DOM elements.

Author: thet

src/core/dom.js

@@ -52,6 +52,20 @@ const toNodeArray = (nodes) => {
     return nodes;
 };
 
+/**
+ * Return an array of DOM elements.
+ *
+ * @param {Node|NodeList|jQuery} nodes - The object which whould be returned as array.
+ *
+ * @returns {Array} - An array of DOM elements.
+ */
+const to_element_array = (nodes) => {
+    nodes = toNodeArray(nodes);
+    // Filter for DOM elements only.
+    nodes = nodes.filter(node => node instanceof Node)
+    return nodes;
+};
+
 /**
  * Like querySelectorAll but including the element where it starts from.
  * Returns an Array, not a NodeList
@@ -620,6 +634,7 @@ const find_inputs = (el) => {
 
 const dom = {
     document_ready: document_ready,
+    to_element_array: to_element_array,
     toNodeArray: toNodeArray,
     querySelectorAllAndMe: querySelectorAllAndMe,
     wrap: wrap,

src/core/dom.test.js

@@ -167,6 +167,85 @@ describe("core.dom tests", () => {
         });
     });
 
+    describe("to_element_array tests", () => {
+        it("returns an array of DOM elements, if a jQuery object was passed.", (done) => {
+            const html = document.createElement("div");
+            html.innerHTML = `
+                <span id="id1" />
+                <span id="id2" />
+            `;
+            const el1 = html.querySelector("#id1");
+            const el2 = html.querySelector("#id2");
+            const testee = $("span", html);
+            expect(testee.length).toBe(2);
+
+            const ret = dom.to_element_array(testee);
+
+            expect(ret.jquery).toBeFalsy();
+            expect(ret.length).toBe(2);
+
+            expect(ret[0]).toBe(el1);
+            expect(ret[0].jquery).toBeFalsy();
+            expect(ret[0] instanceof Element).toBe(true);
+
+            expect(ret[1]).toBe(el2);
+            expect(ret[1].jquery).toBeFalsy();
+            expect(ret[1] instanceof Element).toBe(true);
+
+            done();
+        });
+
+        it("returns an array of elements, if a NodeList was passed.", (done) => {
+            const html = document.createElement("div");
+            html.innerHTML = `
+                <span id="id1" />
+                <span id="id2" />
+            `;
+            const el1 = html.querySelector("#id1");
+            const el2 = html.querySelector("#id2");
+            const testee = html.querySelectorAll("span");
+            expect(testee.length).toBe(2);
+
+            const ret = dom.to_element_array(testee);
+            expect(ret instanceof NodeList).toBeFalsy();
+            expect(ret.length).toBe(2);
+            expect(ret[0]).toBe(el1);
+            expect(ret[1]).toBe(el2);
+
+            done();
+        });
+
+        it("returns an array with a single element, if a single element was passed.", (done) => {
+            const html = document.createElement("div");
+
+            const ret = dom.to_element_array(html);
+            expect(ret instanceof Array).toBeTruthy();
+            expect(ret.length).toBe(1);
+            expect(ret[0]).toBe(html);
+
+            done();
+        });
+
+        it("returns an empty array, if nothing was passed", (done) => {
+            const ret = dom.to_element_array();
+            expect(ret.length).toBe(0);
+            expect(ret instanceof Array).toBe(true);
+
+            done();
+        });
+
+        it("returns only DOM Elements, no Nodes or others", (done) => {
+            const el = document.body;
+            const txt = document.createTextNode("okay");
+            const ret = dom.to_element_array([1, false, txt, "okay", el]);
+            expect(ret.length).toBe(1);
+            expect(ret[0]).toBe(el);
+
+            done();
+        });
+    });
+
+
     describe("querySelectorAllAndMe tests", () => {
         it("return also starting node if query matches.", (done) => {
             const el = document.createElement("div");