diff --git a/docs/api/point.md b/docs/api/point.md index 06d38eb1e..efc82b038 100644 --- a/docs/api/point.md +++ b/docs/api/point.md @@ -12,10 +12,18 @@ interface Point { ## 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` 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` 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. +### Transform methods + ###### `Point.transform(point: Point, op: Operation, options?): Point | null` Transform a `point` by an `op`.