diff --git a/docs/api/locations/range.md b/docs/api/locations/range.md index a3a362ff0..80fcfbbc3 100644 --- a/docs/api/locations/range.md +++ b/docs/api/locations/range.md @@ -18,25 +18,25 @@ interface Range { ### Retrieval methods -#### `Range.edges(range: Range, options?): [Point, Point]` +#### `Range.edges(range: Range, options?) => [Point, Point]` Get the start and end points of a `range`, in the order in which they appear in the document. Options: `{reverse?: boolean}` -#### `Range.end(range: Range): Point` +#### `Range.end(range: Range) => Point` Get the end point of a `range`. -#### `Range.intersection(range: Range, another: Range): Range | null` +#### `Range.intersection(range: Range, another: Range) => Range | null` Get the intersection of one `range` with `another`. -#### `Range.points(range: Range): Generator` +#### `Range.points(range: Range) => Generator` Iterate through all the point entries in a `range`. -#### `Range.start(range: Range): Point` +#### `Range.start(range: Range) => Point` Get the start point of a `range` @@ -44,39 +44,39 @@ Get the start point of a `range` Check some attribute of a Range. Always returns a boolean. -#### `Range.equals(range: Range, another: Range): boolean` +#### `Range.equals(range: Range, another: Range) => boolean` Check if a `range` is exactly equal to `another`. -#### `Range.includes(range: Range, target: Path | Point | Range): boolean` +#### `Range.includes(range: Range, target: Path | Point | Range) => boolean` Check if a `range` includes a path, a point, or part of another range. For clarity the definition of `includes` can mean partially includes. Another way to describe this is if one Range intersectns the other Range. -#### `Range.isBackward(range: Range): boolean` +#### `Range.isBackward(range: Range) => boolean` Check if a `range` is backward, meaning that its anchor point appears _after_ its focus point in the document. -#### `Range.isCollapsed(range: Range): boolean` +#### `Range.isCollapsed(range: Range) => boolean` Check if a `range` is collapsed, meaning that both its anchor and focus points refer to the exact same position in the document. -#### `Range.isExpanded(range: Range): boolean` +#### `Range.isExpanded(range: Range) => boolean` Check if a `range` is expanded. This is the opposite of `Range.isCollapsed` and is provided for legibility. -#### `Range.isForward(range: Range): boolean` +#### `Range.isForward(range: Range) => boolean` Check if a `range` is forward. This is the opposite of `Range.isBackward` and is provided for legibility. -#### `Range.isRange(value: any): value is Range` +#### `Range.isRange(value: any) => value is Range` Check if a `value` implements the `Range` interface. ### Transform methods -#### `Range.transform(range: Range, op: Operation, options): Range | null` +#### `Range.transform(range: Range, op: Operation, options) => Range | null` Transform a `range` by an `op`.