diff --git a/docs/Summary.md b/docs/Summary.md index 1dc25ef1d..aa0f3a587 100644 --- a/docs/Summary.md +++ b/docs/Summary.md @@ -40,6 +40,7 @@ - [Location](api/locations/location.md) - [Path](api/locations/path.md) - [Point](api/locations/point.md) + - [PointEntry](api/locations/point-entry.md) - [PointRef](api/locations/point-ref.md) - [Range](api/locations/range.md) - [RangeRef](api/locations/range-ref.md) diff --git a/docs/api/locations/README.md b/docs/api/locations/README.md index 8342c336f..edc8aeda0 100644 --- a/docs/api/locations/README.md +++ b/docs/api/locations/README.md @@ -9,4 +9,5 @@ type Location = Path | Point | Range - [Location](./location.md) - [Path](./path.md) - [Point](./point.md) +- [PointEntry](./pointe-entry.md) - [Range](./range.md) diff --git a/docs/api/locations/point-entry.md b/docs/api/locations/point-entry.md new file mode 100644 index 000000000..46ff6c4a0 --- /dev/null +++ b/docs/api/locations/point-entry.md @@ -0,0 +1,7 @@ +# PointEntry + +`PointEntry` objects are returned when iterating over `Point` objects that belong to a range. + +```typescript +type PointEntry = [Point, 'anchor' | 'focus'] +```