mirror of
https://github.com/ianstormtaylor/slate.git
synced 2025-09-03 04:02:33 +02:00
7d9d25e179
* Adds clarification & examples to demystify Transforms. * Fleshes out documentation of NodeOptions for Transforms * Update docs/concepts/04-transforms.md Co-authored-by: Dylan Schiemann <dylan@dojotoolkit.org> * Uses 'API' in the title of all API documents Co-authored-by: Dylan Schiemann <dylan@dojotoolkit.org>
19 lines
532 B
Markdown
19 lines
532 B
Markdown
# Location API
|
|
|
|
The Location interface is a union of the ways to refer to a specific location in a Slate document: paths, points or ranges. Methods will often accept a Location instead of requiring only a Path, Point or Range.
|
|
|
|
```typescript
|
|
type Location = Path | Point | Range
|
|
```
|
|
|
|
- [Static methods](location.md#static-methods)
|
|
- [Check methods](location.md#check-methods)
|
|
|
|
## Static methods
|
|
|
|
### Check methods
|
|
|
|
#### `Location.isLocation(value: any) => value is Location`
|
|
|
|
Check if a value implements the `Location` interface.
|