collect-your-stuff 2.1.1 → 2.2.0

package/dist/services/parseTree.js

@@ -1,24 +1,23 @@
-'use strict'
-
-Object.defineProperty(exports, '__esModule', {
-  value: true
-})
-exports.parseTree = void 0
-var _parseTreeNext = require('./parseTreeNext')
-/**
- * Loop over all the nodes in a tree starting from left and apply a callback for each
- * @param {IsArrayable<IsTreeNode>} tree
- * @param {forEachCallback} callback
- * @returns {IsArrayable<IsTreeNode>}
- */
-const parseTree = (tree, callback) => {
-  let index = 0
-  let current = tree.rootParent
-  while (current !== null) {
-    callback(current, index, tree)
-    current = (0, _parseTreeNext.parseTreeNext)(current)
-    ++index
-  }
-  return tree
-}
-exports.parseTree = parseTree
+'use strict'
+
+Object.defineProperty(exports, '__esModule', {
+  value: true
+})
+exports.parseTree = void 0
+const _parseTreeNext = require('./parseTreeNext')
+/**
+ * Loop over all the nodes in a tree starting from left and apply a callback for each
+ * @param tree
+ * @param callback
+ */
+const parseTree = (tree, callback) => {
+  let index = 0
+  let current = tree.rootParent
+  while (current !== null) {
+    callback(current, index, tree)
+    current = (0, _parseTreeNext.parseTreeNext)(current)
+    ++index
+  }
+  return tree
+}
+exports.parseTree = parseTree

package/dist/services/parseTreeNext.d.ts

@@ -1,17 +1,16 @@
-import { IsTreeNode } from '../recipes/IsTreeNode';
-/**
- * Be able to parse over every node in a tree.
- * 1. Start at root (get root parent)
- * 2. Get first child (repeat until no children)
- * 3. Check next child
- * 4. Repeat 2
- * 5. Repeat 3
- * 6. If no next child, return to parent and repeat 3
- * 7. Stop at root (next is null and parent is null
- * A boundary can be given to parse only part of a tree: going back up to the parents stops at the boundary, so the
- * parsing stays within the nodes whose parent is the boundary (and everything below them).
- * @param {IsTreeNode} treeNode Provide a node in a tree and get the next node (left-first approach)
- * @param {IsTreeNode|null} [boundaryParent] The parent of the nodes to stay within, null for the nodes at the top of a tree. When it is not given the whole tree is parsed.
- * @returns {IsTreeNode|null}
- */
-export declare const parseTreeNext: (treeNode: IsTreeNode, boundaryParent?: IsTreeNode | null) => IsTreeNode | null;
+import { IsTreeNode } from '../recipes/IsTreeNode';
+/**
+ * Be able to parse over every node in a tree.
+ * 1. Start at root (get root parent)
+ * 2. Get first child (repeat until no children)
+ * 3. Check next child
+ * 4. Repeat 2
+ * 5. Repeat 3
+ * 6. If no next child, return to parent and repeat 3
+ * 7. Stop at root (next is null and parent is null
+ * A boundary can be given to parse only part of a tree: going back up to the parents stops at the boundary, so the
+ * parsing stays within the nodes whose parent is the boundary (and everything below them).
+ * @param treeNode Provide a node in a tree and get the next node (left-first approach)
+ * @param boundaryParent The parent of the nodes to stay within, null for the nodes at the top of a tree. When it is not given the whole tree is parsed.
+ */
+export declare const parseTreeNext: (treeNode: IsTreeNode, boundaryParent?: IsTreeNode | null) => IsTreeNode | null;

package/dist/services/parseTreeNext.js

@@ -1,42 +1,41 @@
-'use strict'
-
-Object.defineProperty(exports, '__esModule', {
-  value: true
-})
-exports.parseTreeNext = void 0
-/**
- * Be able to parse over every node in a tree.
- * 1. Start at root (get root parent)
- * 2. Get first child (repeat until no children)
- * 3. Check next child
- * 4. Repeat 2
- * 5. Repeat 3
- * 6. If no next child, return to parent and repeat 3
- * 7. Stop at root (next is null and parent is null
- * A boundary can be given to parse only part of a tree: going back up to the parents stops at the boundary, so the
- * parsing stays within the nodes whose parent is the boundary (and everything below them).
- * @param {IsTreeNode} treeNode Provide a node in a tree and get the next node (left-first approach)
- * @param {IsTreeNode|null} [boundaryParent] The parent of the nodes to stay within, null for the nodes at the top of a tree. When it is not given the whole tree is parsed.
- * @returns {IsTreeNode|null}
- */
-const parseTreeNext = (treeNode, boundaryParent) => {
-  if (!treeNode) {
-    return null
-  }
-  if (treeNode.children && treeNode.children.length) {
-    return treeNode.children.first
-  }
-  if (treeNode.next) {
-    return treeNode.next
-  }
-  // Nothing more below or beside this node, so go back up until there is a node which has a next (or the boundary)
-  let parent = treeNode.parent
-  while (parent && parent !== boundaryParent) {
-    if (parent.next) {
-      return parent.next
-    }
-    parent = parent.parent
-  }
-  return null
-}
-exports.parseTreeNext = parseTreeNext
+'use strict'
+
+Object.defineProperty(exports, '__esModule', {
+  value: true
+})
+exports.parseTreeNext = void 0
+/**
+ * Be able to parse over every node in a tree.
+ * 1. Start at root (get root parent)
+ * 2. Get first child (repeat until no children)
+ * 3. Check next child
+ * 4. Repeat 2
+ * 5. Repeat 3
+ * 6. If no next child, return to parent and repeat 3
+ * 7. Stop at root (next is null and parent is null
+ * A boundary can be given to parse only part of a tree: going back up to the parents stops at the boundary, so the
+ * parsing stays within the nodes whose parent is the boundary (and everything below them).
+ * @param treeNode Provide a node in a tree and get the next node (left-first approach)
+ * @param boundaryParent The parent of the nodes to stay within, null for the nodes at the top of a tree. When it is not given the whole tree is parsed.
+ */
+const parseTreeNext = (treeNode, boundaryParent) => {
+  if (!treeNode) {
+    return null
+  }
+  if (treeNode.children && treeNode.children.length) {
+    return treeNode.children.first
+  }
+  if (treeNode.next) {
+    return treeNode.next
+  }
+  // Nothing more below or beside this node, so go back up until there is a node which has a next (or the boundary)
+  let parent = treeNode.parent
+  while (parent && parent !== boundaryParent) {
+    if (parent.next) {
+      return parent.next
+    }
+    parent = parent.parent
+  }
+  return null
+}
+exports.parseTreeNext = parseTreeNext

package/dist/services/services.d.ts

@@ -1,13 +1,10 @@
-/**
- * @file some useful resources when working with collections.
- * @author Joshua Heagle <joshuaheagle@gmail.com>
- * @version 1.1.0
- * @memberOf module:collect-your-stuff
- */
-/**
- * List helpful functions when dealing with collections.
- */
-export declare const services: {
-    parseTree: (tree: import("../main").IsTree, callback: import("../main").forEachCallback) => import("../main").IsTree;
-    parseTreeNext: (treeNode: import("../main").IsTreeNode, boundaryParent?: import("../main").IsTreeNode | null) => import("../main").IsTreeNode | null;
-};
+/**
+ * some useful resources when working with collections.
+ */
+/**
+ * List helpful functions when dealing with collections.
+ */
+export declare const services: {
+    parseTree: (tree: import("../main").IsTree, callback: import("../main").forEachCallback) => import("../main").IsTree;
+    parseTreeNext: (treeNode: import("../main").IsTreeNode, boundaryParent?: import("../main").IsTreeNode | null) => import("../main").IsTreeNode | null;
+};

package/dist/services/services.js

@@ -1,22 +1,19 @@
-'use strict'
-
-Object.defineProperty(exports, '__esModule', {
-  value: true
-})
-exports.services = void 0
-var _parseTree = require('./parseTree')
-var _parseTreeNext = require('./parseTreeNext')
-/**
- * @file some useful resources when working with collections.
- * @author Joshua Heagle <joshuaheagle@gmail.com>
- * @version 1.1.0
- * @memberOf module:collect-your-stuff
- */
-
-/**
- * List helpful functions when dealing with collections.
- */
-const services = exports.services = {
-  parseTree: _parseTree.parseTree,
-  parseTreeNext: _parseTreeNext.parseTreeNext
-}
+'use strict'
+
+Object.defineProperty(exports, '__esModule', {
+  value: true
+})
+exports.services = void 0
+const _parseTree = require('./parseTree')
+const _parseTreeNext = require('./parseTreeNext')
+/**
+ * some useful resources when working with collections.
+ */
+
+/**
+ * List helpful functions when dealing with collections.
+ */
+const services = exports.services = {
+  parseTree: _parseTree.parseTree,
+  parseTreeNext: _parseTreeNext.parseTreeNext
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "collect-your-stuff",
   "description": "Use a variety of collections to collect your stuff when building code.",
-  "version": "2.1.1",
+  "version": "2.2.0",
   "main": "dist/main.js",
   "types": "dist/main.d.ts",
   "author": "Joshua Heagle",
@@ -16,8 +16,7 @@
   "scripts": {
     "build": "gulp build",
     "dev": "gulp",
-    "htmldocs": "jsdoc -R MAIN.md -c ./.jsdoc.conf.js -d docs",
-    "readme": "gulp readme",
+    "docs": "gulp docs",
     "test": "gulp testFull",
     "typecheck": "tsc --noEmit -p tsconfig.json",
     "test:quick": "gulp testQuick",
@@ -25,7 +24,8 @@
     "watch:test": "gulp watchTest"
   },
   "devDependencies": {
-    "js-build-tools": "^4.1.1"
+    "js-build-tools": "^5.3.2",
+    "typedoc": "^0.28.20"
   },
   "repository": {
     "type": "git",