collect-your-stuff 2.1.2 → 2.2.0

package/dist/services/parseTreeNext.d.ts

@@ -10,8 +10,7 @@ import { IsTreeNode } from '../recipes/IsTreeNode';
  * 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}
+ * @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

@@ -15,9 +15,8 @@ exports.parseTreeNext = void 0
  * 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}
+ * @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) {

package/dist/services/services.d.ts

@@ -1,8 +1,5 @@
 /**
- * @file some useful resources when working with collections.
- * @author Joshua Heagle <joshuaheagle@gmail.com>
- * @version 1.1.0
- * @memberOf module:collect-your-stuff
+ * some useful resources when working with collections.
  */
 /**
  * List helpful functions when dealing with collections.

package/dist/services/services.js

@@ -1,22 +1,19 @@
-'use strict'
-
-Object.defineProperty(exports, '__esModule', {
-  value: true
-})
-exports.services = void 0
-const _parseTree = require('./parseTree')
-const _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.2",
+  "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": "^5.2.0"
+    "js-build-tools": "^5.3.2",
+    "typedoc": "^0.28.20"
   },
   "repository": {
     "type": "git",