Change to return undefined

syntax-tree · Jul 8, 2023 · 35d35b1 · 35d35b1
1 parent 9bf44ad
commit 35d35b1
Show file tree

Hide file tree

Showing 3 changed files with 183 additions and 144 deletions.
diff --git a/lib/index.js b/lib/index.js
@@ -98,7 +98,7 @@ const own = {}.hasOwnProperty
  * @param {Options | null | undefined} [options]
  *   Configuration (when `find` is not `Find`).
  * @returns {undefined}
- *   Given, modified, tree.
+ *   Nothing.
  */
 // To do: next major: remove `find` & `replace` combo, remove schema.
 export function findAndReplace(tree, find, replace, options) {
@@ -129,9 +129,6 @@ export function findAndReplace(tree, find, replace, options) {
     visitParents(tree, 'text', visitor)
   }
 
-  // @ts-expect-error: To do: remove.
-  return tree
-
   /** @type {import('unist-util-visit-parents').BuildVisitor<Root, 'text'>} */
   function visitor(node, parents) {
     let index = -1

diff --git a/readme.md b/readme.md
@@ -152,7 +152,7 @@ Partial matches are not supported.
 
 ###### Returns
 
-Given, modified, tree ([`Node`][node]).
+Nothing (`undefined`).
 
 ### `Find`
 
@@ -163,7 +163,7 @@ Strings are escaped and then turned into global expressions.
 ###### Type
 
 ```ts
-type Find = string | RegExp
+type Find = RegExp | string
 ```
 
 ### `FindAndReplaceList`
@@ -231,7 +231,7 @@ Thing to replace with (TypeScript type).
 ###### Type
 
 ```ts
-type Replace = string | ReplaceFunction
+type Replace = ReplaceFunction | string
 ```
 
 See [`ReplaceFunction`][api-replacefunction].