mirror/slate
1
0
Fork 0
mirror of https://github.com/ianstormtaylor/slate.git synced 2025-08-10 01:06:37 +02:00
Code Issues Releases Wiki Activity

docs: Organize the Point docs into sections by type

Browse Source
This commit is contained in:
Sunny Hirai
2021-03-29 23:23:18 -07:00
parent 59343b2633
commit cffbdb1afd
1 changed files with 10 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/api/point.md
View File

@@ -12,10 +12,18 @@ interface Point {
## Static methods ## Static methods
- [Relationship methods](#relationship-methods)
- [Check methods](#check-methods)
- [Transform method](#transform-method)
### Relationship methods
###### `Point.compare(point: Point, another: Point): -1 | 0 | 1` ###### `Point.compare(point: Point, another: Point): -1 | 0 | 1`
Compare a `point` to `another`, returning an integer indicating whether the point was before, at or after the other. Compare a `point` to `another`, returning an integer indicating whether the point was before, at or after the other.
### Check methods
###### `Point.isAfter(point: Point, another: Point): boolean` ###### `Point.isAfter(point: Point, another: Point): boolean`
Check if a `point` is after `another`. Check if a `point` is after `another`.
@@ -32,6 +40,8 @@ Check if a `point` is exactly equal to `another`.
Check if a `value` implements the `Point` interface. Check if a `value` implements the `Point` interface.
### Transform methods
###### `Point.transform(point: Point, op: Operation, options?): Point | null` ###### `Point.transform(point: Point, op: Operation, options?): Point | null`
Transform a `point` by an `op`. Transform a `point` by an `op`.