Add types

Closes GH-5.

Reviewed-by: Christian Murphy <[email protected]>
Reviewed-by: Titus Wormer <[email protected]>

Author: mrzmmr

index.d.ts

@@ -0,0 +1,20 @@
+// TypeScript Version: 3.5
+
+import {Node, Parent} from 'unist'
+import {Test} from 'unist-util-is'
+
+export = findAllBefore
+
+/**
+ * Unist utility to get all children of a parent before a node or index
+ *
+ * @param parent Parent to search in
+ * @param index or Node to start from
+ * @param test that Nodes must pass to be included
+ * @returns Array of found Nodes
+ */
+declare function findAllBefore<T extends Node>(
+  parent: Parent,
+  index: number | Node,
+  test?: Test<T> | Array<Test<T>>
+): Node[]

package.json

@@ -22,11 +22,17 @@
   "contributors": [
     "Titus Wormer <[email protected]> (https://wooorm.com)"
   ],
+  "files": [
+    "index.js",
+    "index.d.ts"
+  ],
+  "types": "index.d.ts",
   "dependencies": {
     "unist-util-is": "^4.0.0"
   },
   "devDependencies": {
     "browserify": "^16.0.0",
+    "dtslint": "^3.6.14",
     "nyc": "^15.0.0",
     "prettier": "^2.0.0",
     "remark": "^12.0.0",
@@ -43,7 +49,8 @@
     "build": "npm run build-bundle && npm run build-mangle",
     "test-api": "node test",
     "test-coverage": "nyc --reporter lcov tape test.js",
-    "test": "npm run format && npm run build && npm run test-coverage"
+    "test-types": "dtslint .",
+    "test": "npm run format && npm run build && npm run test-coverage && npm run test-types"
   },
   "nyc": {
     "check-coverage": true,
@@ -66,7 +73,8 @@
       "unicorn/prefer-number-properties": "off"
     },
     "ignore": [
-      "unist-util-find-all-before.js"
+      "unist-util-find-all-before.js",
+      "*.ts"
     ]
   },
   "remarkConfig": {

tsconfig.json

@@ -0,0 +1,10 @@
+{
+  "compilerOptions": {
+    "lib": ["es2015"],
+    "strict": true,
+    "baseUrl": ".",
+    "paths": {
+      "unist-util-find-all-before": ["index.d.ts"]
+    }
+  }
+}

tslint.json

@@ -0,0 +1,8 @@
+{
+  "extends": "dtslint/dtslint.json",
+  "rules": {
+    "semicolon": false,
+    "whitespace": false,
+    "strict-export-declare-modifiers": false
+  }
+}

unist-util-find-all-before-test.ts

@@ -0,0 +1,38 @@
+import {Node, Parent} from 'unist'
+import findAllBefore = require('unist-util-find-all-before')
+
+const heading: Node = {
+  type: 'heading',
+  depth: 2,
+  children: []
+}
+
+const parent: Parent = {
+  type: 'root',
+  children: [heading]
+}
+
+// Missing params
+// $ExpectError
+findAllBefore()
+
+// $ExpectError
+findAllBefore(parent)
+
+// Find by index or node
+findAllBefore(parent, 1)
+findAllBefore(parent, heading)
+
+// Invalid test type
+// $ExpectError
+findAllBefore(parent, 1, false)
+
+// Valid test type
+findAllBefore(parent, 1, 'paragraph')
+
+// Invalid retrurn type
+// $ExpectError
+const returnsString: string = findAllBefore(parent, 1)
+
+// Valid return type
+const nodes: Node[] = findAllBefore(parent, 1)