Fix name of type

Author: wooorm

index.js

@@ -3,7 +3,13 @@
  * @typedef {import('./lib/index.js').Options} Options
  * @typedef {import('./lib/index.js').TestFunction} TestFunction
  * @typedef {import('./lib/index.js').Test} Test
- * @typedef {import('./lib/index.js').ZoneInfo} ZoneInfo
+ * @typedef {import('./lib/index.js').Info} Info
+ */
+
+// To do: next major: remove.
+/**
+ * @typedef {Info} ZoneInfo
+ *   Deprecated: use `Info`
  */
 
 export {headingRange} from './lib/index.js'

lib/index.js

@@ -33,7 +33,7 @@
  * @property {boolean | null | undefined} [ignoreFinalDefinitions=false]
  *   Ignore final definitions otherwise in the section.
  *
- * @typedef ZoneInfo
+ * @typedef Info
  *   Extra info.
  * @property {Parent} parent
  *   Parent of the section.
@@ -50,7 +50,7 @@
  *   Nodes between `start` and `end`.
  * @param {Node | undefined} end
  *   End of section, if any.
- * @param {ZoneInfo} scope
+ * @param {Info} scope
  *   Extra info.
  * @returns {Array<Node | null | undefined> | null | undefined | void}
  *   Results.
@@ -62,6 +62,10 @@
 
 import {toString} from 'mdast-util-to-string'
 
+// To do: next major: remove `null` in API output.
+// To do: next major: remove `value` parameter in `TestFunction`?
+// Add support for `unist-util-is`?
+
 /**
  * Search `tree` for a heading matching `test` and change its “section” with
  * `handler`.

readme.md

@@ -19,10 +19,10 @@
 *   [API](#api)
     *   [`headingRange(tree, test|options, handler)`](#headingrangetree-testoptions-handler)
     *   [`Handler`](#handler)
+    *   [`Info`](#info)
     *   [`Options`](#options)
     *   [`Test`](#test)
     *   [`TestFunction`](#testfunction)
-    *   [`ZoneInfo`](#zoneinfo)
 *   [Types](#types)
 *   [Compatibility](#compatibility)
 *   [Security](#security)
@@ -160,9 +160,22 @@ Callback called when a section is found (TypeScript type).
     — nodes between `start` and `end`
 *   `end` ([`Node`][node] or `undefined`)
     — end of section, if any
-*   `info` ([`ZoneInfo`][api-zoneinfo])
+*   `info` ([`Info`][api-info])
     — extra info
 
+### `Info`
+
+Extra info (TypeScript type).
+
+###### Fields
+
+*   `parent` ([`Node`][node])
+    — parent of the section
+*   `start` (`number`)
+    — index of `start` in `parent`
+*   `end` (`number` or `null`)
+    — index of `end` in `parent`
+
 ###### Returns
 
 Results (`Array<Node | null | undefined>`, optional).
@@ -210,25 +223,12 @@ Check if a node matches (TypeScript type).
 
 Whether this is the heading that is searched for (`boolean`, optional).
 
-### `ZoneInfo`
-
-Extra info (TypeScript type).
-
-###### Fields
-
-*   `parent` ([`Node`][node])
-    — parent of the section
-*   `start` (`number`)
-    — index of `start` in `parent`
-*   `end` (`number` or `null`)
-    — index of `end` in `parent`
-
 ## Types
 
 This package is fully typed with [TypeScript][].
 This package exports the types [`Handler`][api-handler],
-[`Options`][api-options], [`Test`][api-test],
-[`TestFunction`][api-testfunction], and [`ZoneInfo`][api-zoneinfo].
+[`Info`][api-info], [`Options`][api-options], [`Test`][api-test],
+and [`TestFunction`][api-testfunction].
 
 ## Compatibility
 
@@ -358,4 +358,4 @@ abide by its terms.
 
 [api-testfunction]: #testfunction
 
-[api-zoneinfo]: #zoneinfo
+[api-info]: #info