Skip to content

Commit 873ab0a

Browse files
committed
Add improved jsdoc
1 parent 1408662 commit 873ab0a

File tree

1 file changed

+16
-3
lines changed

1 file changed

+16
-3
lines changed

index.js

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,19 @@
99

1010
import {convert} from 'unist-util-is'
1111

12+
/**
13+
* Find the first node in `parent` after another `node` or after an index,
14+
* that passes `test`.
15+
16+
* @param parent
17+
* Parent node.
18+
* @param index
19+
* Child of `parent`, or it’s index.
20+
* @param [test]
21+
* `unist-util-is`-compatible test.
22+
* @returns
23+
* Child of `parent` that passes `test`, if found.
24+
*/
1225
export const findAfter =
1326
/**
1427
* @type {(
@@ -18,9 +31,9 @@ export const findAfter =
1831
*/
1932
(
2033
/**
21-
* @param {Parent} parent Parent node
22-
* @param {Node|number} index Child of `parent`, or it’s index
23-
* @param {null|undefined|Type|Props|TestFunctionAnything|Array<Type|Props|TestFunctionAnything>} [test] is-compatible test (such as a type)
34+
* @param {Parent} parent
35+
* @param {Node|number} index
36+
* @param {null|undefined|Type|Props|TestFunctionAnything|Array<Type|Props|TestFunctionAnything>} [test]
2437
* @returns {Node|null}
2538
*/
2639
function (parent, index, test) {

0 commit comments

Comments
 (0)