Skip to content

Commit 1d8f30b

Browse files
committed
Add more JSDocs
1 parent 412e8ff commit 1d8f30b

File tree

1 file changed

+17
-2
lines changed

1 file changed

+17
-2
lines changed

index.js

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,21 @@
22
* @typedef {import('xast').Root} Root
33
* @typedef {import('xast').Element} Element
44
* @typedef {import('xast').RootChildMap} RootChildMap
5+
*/
6+
7+
/**
58
* @typedef {RootChildMap[keyof RootChildMap]} Child
6-
* @typedef {Root|Child} Node
7-
* @typedef {Root|Element} Parent
9+
* @typedef {Root | Child} Node
10+
* @typedef {Root | Element} Parent
811
*/
912

1013
/**
14+
* Get the plain-text value of a node.
15+
*
1116
* @param {Node} node
17+
* Node to serialize.
1218
* @returns {string}
19+
* Serialized node.
1320
*/
1421
export function toString(node) {
1522
// A root or an element
@@ -18,8 +25,12 @@ export function toString(node) {
1825
}
1926

2027
/**
28+
* Serialize a child.
29+
*
2130
* @param {Node} node
31+
* Child to serialize.
2232
* @returns {string}
33+
* Serialized node.
2334
*/
2435
function one(node) {
2536
if (node.type === 'text') return node.value
@@ -28,8 +39,12 @@ function one(node) {
2839
}
2940

3041
/**
42+
* Serialize a parent.
43+
*
3144
* @param {Parent} node
45+
* Parent to serialize.
3246
* @returns {string}
47+
* Serialized node.
3348
*/
3449
function all(node) {
3550
const children = node.children

0 commit comments

Comments
 (0)