Fix to improve return type

Author: wooorm

index.js

@@ -1,25 +1,29 @@
 /**
  * @typedef {import('unist').Node} Node
- * @typedef {Node & {position: undefined}} NodeWithUndefinedPosition
- * @typedef {Omit<Node, 'position'>} NodeWithoutPosition
  */
 
 import {visit} from 'unist-util-visit'
 
+/**
+ * Utility to remove positions from a tree
+ *
+ * @param node The unist tree
+ * @param force if `force` is given, uses `delete`, otherwise, sets positions to `undefined`.
+ * @returns The same node, but either with `position: undefined` or w/o `position` fields
+ */
 export const removePosition =
   /**
    * @type {(
-   *   ((tree: Node, force?: false) => NodeWithUndefinedPosition) &
-   *   ((tree: Node, force: true) => NodeWithoutPosition)
+   *   (<Tree extends Node>(tree: Tree, force?: false) => Tree) &
+   *   (<Tree extends Node>(tree: Tree, force: true) => Tree)
    * )}
    */
   (
     /**
-     * Utility to remove positions from a tree
-     *
-     * @param {Node} node the unist tree
-     * @param {boolean} [force=false] if `force` is given, uses `delete`, otherwise, sets positions to `undefined`.
-     * @returns {NodeWithUndefinedPosition}
+     * @template {Node} Tree
+     * @param {Tree} node
+     * @param {boolean} [force=false]
+     * @returns {Tree}
      */
     function (node, force) {
       visit(node, remove)

index.test-d.ts

@@ -1,19 +1,15 @@
 import {expectType} from 'tsd'
 import {Node} from 'unist'
+import {Root} from 'mdast'
 import remark from 'remark'
-import {
-  removePosition,
-  NodeWithUndefinedPosition,
-  NodeWithoutPosition
-} from './index.js'
+import {removePosition} from './index.js'
 
-const tree: Node = remark().parse(
-  'Some _emphasis_, **importance**, and `code`.'
-)
+const tree: Root = {type: 'root', children: []}
 
-expectType<NodeWithUndefinedPosition>(removePosition(tree))
-expectType<NodeWithUndefinedPosition>(removePosition(tree, false))
-expectType<NodeWithoutPosition>(removePosition(tree, true))
+expectType<Root>(removePosition(tree))
+expectType<Root>(removePosition(tree, false))
+expectType<Root>(removePosition(tree, true))
+expectType<Root>(removePosition(tree, true))
 
 // Used as a plugin
 void remark()

package.json

@@ -38,6 +38,7 @@
     "unist-util-visit": "^4.0.0"
   },
   "devDependencies": {
+    "@types/mdast": "^3.0.0",
     "@types/tape": "^4.0.0",
     "c8": "^7.0.0",
     "prettier": "^2.0.0",