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

docs: Provide additional details for Path.next and Path.previous

Browse Source
This commit is contained in:
Sunny Hirai
2021-06-06 12:33:05 -07:00
parent c05d4c4e55
commit cbe8e1a481
1 changed files with 2 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/api/locations/path.md
View File

@@ -41,7 +41,7 @@ Options: `{reverse?: boolean}`
#### `Path.next(path: Path): Path`
Given a path, get the path to the next sibling node.
Given a path, gets the path to the next sibling node. The method does not ensure that the returned `Path` is valid in the document.
#### `Path.parent(path: Path): Path`
@@ -49,7 +49,7 @@ Given a path, return a new path referring to the parent node above it.
#### `Path.previous(path: Path): Path`
Given a path, get the path to the previous sibling node.
Given a path, get the path to the previous sibling node. The method will throw an error if there are no previous siblings (e.g. if the Path is currently `[1, 0]`, the previous path would be `[1, -1]` which is illegal and will throw an error).
#### `Path.relative(path: Path, ancestor: Path): Path`