diff --git a/docs/api/nodes/editor.md b/docs/api/nodes/editor.md index 93b6b7941..d06f8e1fe 100644 --- a/docs/api/nodes/editor.md +++ b/docs/api/nodes/editor.md @@ -52,10 +52,24 @@ Creates a new, empty `Editor` object. #### `Editor.above(editor: Editor, options?) => NodeEntry | undefined` -Get the ancestor above a location in the document. +Get the matching ancestor above a location in the document. Options: `{at?: Location, match?: NodeMatch, mode?: 'highest' | 'lowest', voids?: boolean}` +```ts +type Options = { + at?: Location + match?: NodeMatch + mode?: 'highest' | 'lowest' + voids?: boolean +} +``` + +- `mode?`: If `lowest` (default), returns the lowest matching ancestor. If `highest`, returns the highest matching ancestor. +- `voids?`: If `false` (default), ignore void objects. If `true`, include `void` objects. +- `at?`: Where to start at which is `editor.selection` by default. +- `match?`: Narrow the match + #### `Editor.after(editor: Editor, at: Location, options?) => Point | undefined` Get the point after a location.