mirror/slate
1
0
Fork 0
mirror of https://github.com/ianstormtaylor/slate.git synced 2025-08-13 02:34:05 +02:00
Code Issues Releases Wiki Activity

update docs on Node.ancestors/levels and Path.ancestors (#4987)

Browse Source
This commit is contained in:
Haakon Borch
2022-05-18 01:23:47 +02:00
committed by GitHub
parent 863357f994
commit f5ccab241c
4 changed files with 7 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/api/nodes/node.md
View File

@@ -15,7 +15,7 @@ Get the node at a specific `path`, asserting that it is an ancestor node. If the
#### `Node.ancestors(root: Node, path: Path, options?) => Generator<NodeEntry<Ancestor>>`
Return a generator of all the ancestor nodes above a specific path. By default, the order is bottom-up, from lowest to highest ancestor in the tree, but you can pass the `reverse: true` option to go top-down.
Return a generator of all the ancestor nodes above a specific path. By default, the order is top-down, from highest to lowest ancestor in the tree, but you can pass the `reverse: true` option to go bottom-up.
Options: `{reverse?: boolean}`
@@ -71,7 +71,7 @@ Get the node at a specific `path`, ensuring it's a leaf text node. If the node i
#### `Node.levels(root: Node, path: Path, options?) => Generator<NodeEntry>`
Return a generator of the nodes in a branch of the tree, from a specific `path`. By default, the order is top-down, from the lowest to the highest node in the tree, but you can pass the `reverse: true` option to go bottom-up.
Return a generator of the nodes in a branch of the tree, from a specific `path`. By default, the order is top-down, from the highest to the lowest node in the tree, but you can pass the `reverse: true` option to go bottom-up.
Options: `{reverse?: boolean}`