Skip to content

Commit acbed2f

Browse files
committed
docs: EditableTreeNode
1 parent b5745e1 commit acbed2f

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

src/core/extendRoutes.ts

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,14 @@ import { type TreeNode } from './tree'
44
import { warn } from './utils'
55

66
/**
7-
* A route node that can be modified by the user. The tree can be traversed with a `for of` loop.
7+
* A route node that can be modified by the user. The tree can be iterated to be traversed.
8+
* @example
9+
* ```js
10+
* [...node] // creates an array of all the children
11+
* for (const child of node) {
12+
* // do something with the child node
13+
* }
14+
* ```
815
*
916
* @experimental
1017
*/

0 commit comments

Comments
 (0)