Add types

package.json

@@ -1,87 +1,91 @@
 {
-  "name": "unist-util-remove",
-  "version": "2.0.1",
-  "description": "unist utility to remove nodes from a tree",
-  "license": "MIT",
-  "keywords": [
-    "unist",
-    "unist-util",
-    "util",
-    "utility",
-    "ast",
-    "tree",
-    "node",
-    "cascade",
-    "delete",
-    "mutable",
-    "remove",
-    "squeeze",
-    "strip"
-  ],
-  "repository": "syntax-tree/unist-util-remove",
-  "bugs": "https://github.com/syntax-tree/unist-util-remove/issues",
-  "funding": {
-    "type": "opencollective",
-    "url": "https://opencollective.com/unified"
-  },
-  "author": "Eugene Sharygin <eush77@gmail.com>",
-  "contributors": [
-    "Eugene Sharygin <eush77@gmail.com>",
-    "Titus Wormer <tituswormer@gmail.com> (https://wooorm.com)"
-  ],
-  "files": [
-    "index.js"
-  ],
-  "dependencies": {
-    "unist-util-is": "^4.0.0"
-  },
-  "devDependencies": {
-    "nyc": "^15.0.0",
-    "prettier": "^2.0.0",
-    "remark-cli": "^9.0.0",
-    "remark-preset-wooorm": "^8.0.0",
-    "tape": "^5.0.0",
-    "unist-builder": "^2.0.0",
-    "xo": "^0.35.0"
-  },
-  "scripts": {
-    "format": "remark . -qfo && prettier . -w --loglevel warn && xo --fix",
-    "test-api": "node test",
-    "test-coverage": "nyc --reporter lcov tape test.js",
-    "test": "npm run format && npm run test-coverage"
-  },
-  "nyc": {
-    "check-coverage": true,
-    "lines": 100,
-    "functions": 100,
-    "branches": 100
-  },
-  "prettier": {
-    "tabWidth": 2,
-    "useTabs": false,
-    "singleQuote": true,
-    "bracketSpacing": false,
-    "semi": false,
-    "trailingComma": "none"
-  },
-  "xo": {
-    "prettier": true,
-    "esnext": false,
-    "rules": {
-      "eqeqeq": [
-        "error",
-        "always",
-        {
-          "null": "ignore"
+    "name": "unist-util-remove",
+    "version": "2.0.1",
+    "description": "unist utility to remove nodes from a tree",
+    "license": "MIT",
+    "keywords": [
+        "unist",
+        "unist-util",
+        "util",
+        "utility",
+        "ast",
+        "tree",
+        "node",
+        "cascade",
+        "delete",
+        "mutable",
+        "remove",
+        "squeeze",
+        "strip"
+    ],
+    "repository": "syntax-tree/unist-util-remove",
+    "bugs": "https://github.com/syntax-tree/unist-util-remove/issues",
+    "funding": {
+        "type": "opencollective",
+        "url": "https://opencollective.com/unified"
+    },
+    "author": "Eugene Sharygin <eush77@gmail.com>",
+    "contributors": [
+        "Eugene Sharygin <eush77@gmail.com>",
+        "Titus Wormer <tituswormer@gmail.com> (https://wooorm.com)"
+    ],
+    "files": [
+        "index.js",
+        "types/index.d.ts"
+    ],
+    "types": "types/index.d.ts",
+    "dependencies": {
+        "dtslint": "^4.0.7",
+        "unist-util-is": "^4.0.0"
+    },
+    "devDependencies": {
+        "nyc": "^15.0.0",
+        "prettier": "^2.0.0",
+        "remark-cli": "^9.0.0",
+        "remark-preset-wooorm": "^8.0.0",
+        "tape": "^5.0.0",
+        "unist-builder": "^2.0.0",
+        "xo": "^0.35.0"
+    },
+    "scripts": {
+        "format": "remark . -qfo && prettier . -w --loglevel warn && xo --fix",
+        "test-api": "node test",
+        "test-coverage": "nyc --reporter lcov tape test.js",
+        "test": "npm run format && npm run test-coverage",
+        "test-types": "dtslint types"
+    },
+    "nyc": {
+        "check-coverage": true,
+        "lines": 100,
+        "functions": 100,
+        "branches": 100
+    },
+    "prettier": {
+        "tabWidth": 2,
+        "useTabs": false,
+        "singleQuote": true,
+        "bracketSpacing": false,
+        "semi": false,
+        "trailingComma": "none"
+    },
+    "xo": {
+        "prettier": true,
+        "esnext": false,
+        "rules": {
+            "eqeqeq": [
+                "error",
+                "always",
+                {
+                    "null": "ignore"
+                }
+            ],
+            "no-eq-null": "off",
+            "unicorn/explicit-length-check": "off"
         }
-      ],
-      "no-eq-null": "off",
-      "unicorn/explicit-length-check": "off"
+    },
+    "remarkConfig": {
+        "plugins": [
+            "preset-wooorm"
+        ]
     }
-  },
-  "remarkConfig": {
-    "plugins": [
-      "preset-wooorm"
-    ]
-  }
 }

types/index.d.ts

@@ -0,0 +1,26 @@
+// TypeScript Version: 3.5
+
+import { Node } from 'unist';
+import { Test } from 'unist-util-is';
+
+declare namespace remove {
+  interface RemoveOptions {
+    cascade?: boolean;
+  }
+}
+
+/**
+ *
+ * Mutate the given tree by removing all nodes that pass test. The tree is walked in preorder (NLR), visiting the node itself, then its head, etc.
+ *
+ * @param tree      Tree to filter
+ * @param options   Whether to drop parent nodes if they had children, but all their children were filtered out
+ * @param test      is-compatible test (such as a type)
+ */
+declare function remove(
+  tree: Node,
+  options: remove.RemoveOptions = {cascade: true},
+  test?: Test<Node>
+): Node;
+
+export = remove;