Merge pull request #8 from paescuj/types

Add types via JSDoc

Author: Rik

.gitignore

@@ -40,6 +40,9 @@ jspm_packages
 # Optional REPL history
 .node_repl_history
 
+# Type Declarations
+index.d.ts
+
 
 ### OSX ###
 *.DS_Store

index.js

@@ -4,19 +4,34 @@
  * @license MIT
  * @module unist:find
  * @fileoverview Unist node finder
+ *
+ * @typedef {import('unist').Node} Node
+ *
+ * @typedef {string} TestStr
+ *   Finds first node with a truthy property matching string.
+ * @typedef {Object.<string, unknown>} TestObj
+ *   Finds first node that has matching values for all properties of object.
+ * @typedef {<V extends Node>(node: V) => boolean} TestFn
+ *   Finds first node for which function returns true when passed node as argument.
  */
+
 import { visit } from 'unist-util-visit'
 import iteratee from 'lodash.iteratee'
 
 /**
- * Find
+ * Unist node finder utility.
  *
- * @param {Node} tree - Root node
- * @param {string|object|function} [condition] - Condition to match node.
+ * @param tree
+ *   Node to search.
+ * @param condition
+ *   Condition used to test each node.
+ * @returns
+ *   The first node that matches condition, or undefined if no node matches.
+ * @type {<V extends Node>(tree: Node, condition: TestStr | TestObj | TestFn) => V | undefined}
  */
 function find (tree, condition) {
-  if (!tree) throw new Error('unist-find requires a tree to search')
-  if (!condition) throw new Error('unist-find requires a condition')
+  if (!tree) throw new Error('unist-util-find requires a tree to search')
+  if (!condition) throw new Error('unist-util-find requires a condition')
 
   const predicate = iteratee(condition)
   let result
@@ -31,7 +46,4 @@ function find (tree, condition) {
   return result
 }
 
-/*
- * Expose.
- */
 export default find