Method to convert all descendants to an array

Author: Joris-van-der-Wel

lib/SymbolTree.js

@@ -231,6 +231,9 @@ class SymbolTree {
          * Append all children of the given object to an array.
          *
          * `O(n)`
+         *
+         * @method childrenToArray
+         * @memberOf module:symbol-tree#
          * @param {Object} object
          * @param {Object[]} [array=[]]
          * @return {Object[]}
@@ -250,6 +253,35 @@ class SymbolTree {
                 return array;
         }
 
+        /**
+         * Append all descendants of the given object to an array (in tree order).
+         *
+         * `O(n)`
+         *
+         * @method treeToArray
+         * @memberOf module:symbol-tree#
+         * @param {Object} root
+         * @param {Object[]} [array=[]]
+         * @param {Boolean} [includeRoot=true] Include the given `root` object in the array?
+         * @return {Object[]}
+         */
+        treeToArray(root, array, includeRoot) {
+                if (!array) {
+                        array = [];
+                }
+
+                let object = includeRoot || includeRoot === undefined
+                        ? root
+                        : this.following(root, root);
+
+                while (object) {
+                        array.push(object);
+                        object = this.following(object, root);
+                }
+
+                return array;
+        }
+
         /**
          * Remove the object from this tree.
          * Has no effect if already removed.

test/SymbolTree.js

@@ -637,3 +637,28 @@ test('childrenToArray', function(t) {
 
         t.end();
 });
+
+test('treeToArray', function(t) {
+        const tree = new SymbolTree();
+        const a = {};
+        const aa = {};
+        const ab = {};
+        const aba = {};
+        const abaa = {};
+        const b = {};
+
+        tree.insertLast(aa, a);
+        tree.insertLast(ab, a);
+        tree.insertLast(aba, ab);
+        tree.insertLast(abaa, aba);
+        tree.insertAfter(b, a);
+
+        t.deepEqual([a, aa, ab, aba, abaa], tree.treeToArray(a));
+        t.deepEqual([aa, ab, aba, abaa], tree.treeToArray(a, null, false));
+
+        const arr = ['a', 5];
+        tree.treeToArray(a, arr);
+        t.deepEqual(['a', 5, a, aa, ab, aba, abaa], arr);
+
+        t.end();
+});