Refactor types to use node types, not strings

Author: wooorm

lib/index.js

@@ -8,7 +8,7 @@
 
 import {zwitch} from 'zwitch'
 import {configure} from './configure.js'
-import {handle} from './handle/index.js'
+import {handle as handlers} from './handle/index.js'
 import {join} from './join.js'
 import {unsafe} from './unsafe.js'
 
@@ -29,14 +29,15 @@ export function toMarkdown(tree, options = {}) {
     stack: [],
     unsafe: [],
     join: [],
+    // @ts-expect-error: we’ll fill it next.
     handlers: {},
     options: {},
     indexStack: [],
     // @ts-expect-error: we’ll add `handle` later.
     handle: undefined
   }
 
-  configure(state, {unsafe, join, handlers: handle})
+  configure(state, {unsafe, join, handlers})
   configure(state, options)
 
   if (state.options.tightDefinitions) {

lib/types.js

@@ -80,7 +80,7 @@
  * @returns {string}
  *   Serialized markdown representing `node`.
  *
- * @typedef {Record<string, Handle>} Handlers
+ * @typedef {Record<Node['type'], Handle>} Handlers
  *   Handle particular nodes.
  *
  *   Each key is a node type, each value its corresponding handler.
@@ -238,7 +238,7 @@
  *     }
  *   }
  *   ```
- * @property {Handlers | null | undefined} [handlers={}]
+ * @property {Partial<Handlers> | null | undefined} [handlers={}]
  *   Handle particular nodes.
  *
  *   Each key is a node type, each value its corresponding handler.

readme.md

@@ -208,7 +208,7 @@ Serialized markdown representing `node` (`string`).
 
 Handle particular nodes (TypeScript type).
 
-Each key is a node type (`string`), each value its corresponding handler
+Each key is a node type (`Node['type']`), each value its corresponding handler
 ([`Handle`][handle]).
 
 ###### Type

test/index.js

@@ -1,6 +1,7 @@
 /**
  * @typedef {import('mdast').BlockContent} BlockContent
  * @typedef {import('mdast').List} List
+ * @typedef {import('../index.js').Handle} Handle
  */
 
 import assert from 'node:assert/strict'
@@ -3810,7 +3811,10 @@ test('position (output)', function () {
       },
       {
         handlers: {
-          /** @param {unknown} _ */
+          /**
+           * @type {Handle}
+           * @param {unknown} _
+           */
           unknown(_, _2, _3, info) {
             const {now, lineShift} = info
             assert.deepEqual(
@@ -3849,7 +3853,10 @@ test('position (output)', function () {
       },
       {
         handlers: {
-          /** @param {unknown} _ */
+          /**
+           * @type {Handle}
+           * @param {unknown} _
+           */
           unknown(_, _2, _3, info) {
             const {now, lineShift} = info
             assert.deepEqual(