Refactor code-style

Author: wooorm

Diff for: lib/index.js

@@ -5,7 +5,7 @@
  * @typedef {import('hast').Element} HastElement
  * @typedef {import('hast').Text} HastText
  * @typedef {import('hast').Comment} HastComment
- * @typedef {HastParent['children'][number]} HastChild
+ * @typedef {import('hast').Content} HastChild
  * @typedef {HastChild|HastRoot} HastNode
  *
  * @callback AfterTransform
@@ -18,9 +18,9 @@
  *
  * @typedef Options
  * @property {AfterTransform} [afterTransform]
- *
- * @typedef Context
- * @property {AfterTransform} [afterTransform]
+ *   Function called after a DOM node is transformed into a hast node.
+ *   Given the DOM node that was handled as the first parameter and the
+ *   corresponding hast node as the second parameter.
  */
 
 import {webNamespaces} from 'web-namespaces'
@@ -33,9 +33,25 @@ const DOCUMENT_NODE = 9
 const DOCUMENT_TYPE_NODE = 10
 const DOCUMENT_FRAGMENT_NODE = 11
 
+/**
+ * Transform a DOM tree to a hast tree.
+ *
+ * @param {Node} node
+ * @param {Options} [options]
+ * @returns {HastNode}
+ */
+export function fromDom(node, options = {}) {
+  return (
+    (node ? transform(node, options) : undefined) || {
+      type: 'root',
+      children: []
+    }
+  )
+}
+
 /**
  * @param {Node} node
- * @param {Context} ctx
+ * @param {Options} ctx
  * @returns {HastNode|undefined}
  */
 function transform(node, ctx) {
@@ -46,7 +62,7 @@ function transform(node, ctx) {
 
 /**
  * @param {Node} node
- * @param {Context} ctx
+ * @param {Options} ctx
  * @returns {HastNode|undefined}
  */
 function one(node, ctx) {
@@ -75,7 +91,7 @@ function one(node, ctx) {
  * Transform a document.
  *
  * @param {Document|DocumentFragment} node
- * @param {Context} ctx
+ * @param {Options} ctx
  * @returns {HastRoot}
  */
 function root(node, ctx) {
@@ -116,7 +132,7 @@ function comment(node) {
  * Transform an element.
  *
  * @param {Element} node
- * @param {Context} ctx
+ * @param {Options} ctx
  * @returns {HastElement}
  */
 function element(node, ctx) {
@@ -129,7 +145,7 @@ function element(node, ctx) {
     // @ts-expect-error Types are wrong.
     space === webNamespaces.html && tagName === 'template' ? node.content : node
   const attributes = node.getAttributeNames()
-  /** @type {Object.<string, string>} */
+  /** @type {Record<string, string>} */
   const props = {}
   let index = -1
 
@@ -144,12 +160,12 @@ function element(node, ctx) {
  * Transform an element.
  *
  * @param {Document|DocumentFragment|Element} node
- * @param {Context} ctx
- * @returns {Array.<HastChild>}
+ * @param {Options} ctx
+ * @returns {Array<HastChild>}
  */
 function all(node, ctx) {
   const nodes = node.childNodes
-  /** @type {Array.<HastChild>} */
+  /** @type {Array<HastChild>} */
   const children = []
   let index = -1
 
@@ -164,12 +180,3 @@ function all(node, ctx) {
 
   return children
 }
-
-/**
- * @param {Node} node
- * @param {Options} [options]
- * @returns {HastNode}
- */
-export function fromDom(node, options = {}) {
-  return transform(node || {}, options) || {type: 'root', children: []}
-}

Diff for: readme.md

@@ -77,7 +77,7 @@ Consequently, it does not maintain [positional info][positional-information].
 
 ###### `options.afterTransform`
 
-Function called when a DOM node is transformed into a hast node (`Function?`).
+Function called after a DOM node is transformed into a hast node (`Function?`).
 Given the DOM node that was handled as the first parameter and the
 corresponding hast node as the second parameter.