mirror/slate
1
0
Fork 0
mirror of https://github.com/ianstormtaylor/slate.git synced 2025-04-16 11:22:15 +02:00
Code Issues Releases Wiki Activity

docs: Add details for how the Range static methods work

Browse Source
This commit is contained in:
Sunny Hirai 2021-06-06 12:53:20 -07:00
parent a451d3eed1
commit 0c30c55355
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/api/locations/range.md
View File

@ -26,19 +26,19 @@ Options: `{reverse?: boolean}`
#### `Range.end(range: Range) => Point`
Get the end point of a `range`.
Get the end point of a `range` according to the order in which it appears in the document.
#### `Range.intersection(range: Range, another: Range) => Range | null`
Get the intersection of one `range` with `another`.
Get the intersection of one `range` with `another`. If the two ranges do not overlap, return `null`.
#### `Range.points(range: Range) => Generator<PointEntry>`
Iterate through all the point entries in a `range`.
Iterate through the two point entries in a `Range`. First it will yield a `PointEntry` representing the `anchor`, then it will yield a `PointEntry` representing the `focus`.
#### `Range.start(range: Range) => Point`
Get the start point of a `range`
Get the start point of a `range` according to the order in which it appears in the document.
### Check methods