sgauthier
6e64e138e2
All checks were successful
Publish To Prod / deploy_and_publish (push) Successful in 35s
45 lines
1.9 KiB
TypeScript
45 lines
1.9 KiB
TypeScript
import { Operation } from '..';
|
|
import { TextDirection } from './types';
|
|
/**
|
|
* `Path` arrays are a list of indexes that describe a node's exact position in
|
|
* a Slate node tree. Although they are usually relative to the root `Editor`
|
|
* object, they can be relative to any `Node` object.
|
|
*/
|
|
export declare type Path = number[];
|
|
export interface PathAncestorsOptions {
|
|
reverse?: boolean;
|
|
}
|
|
export interface PathLevelsOptions {
|
|
reverse?: boolean;
|
|
}
|
|
export interface PathTransformOptions {
|
|
affinity?: TextDirection | null;
|
|
}
|
|
export interface PathInterface {
|
|
ancestors: (path: Path, options?: PathAncestorsOptions) => Path[];
|
|
common: (path: Path, another: Path) => Path;
|
|
compare: (path: Path, another: Path) => -1 | 0 | 1;
|
|
endsAfter: (path: Path, another: Path) => boolean;
|
|
endsAt: (path: Path, another: Path) => boolean;
|
|
endsBefore: (path: Path, another: Path) => boolean;
|
|
equals: (path: Path, another: Path) => boolean;
|
|
hasPrevious: (path: Path) => boolean;
|
|
isAfter: (path: Path, another: Path) => boolean;
|
|
isAncestor: (path: Path, another: Path) => boolean;
|
|
isBefore: (path: Path, another: Path) => boolean;
|
|
isChild: (path: Path, another: Path) => boolean;
|
|
isCommon: (path: Path, another: Path) => boolean;
|
|
isDescendant: (path: Path, another: Path) => boolean;
|
|
isParent: (path: Path, another: Path) => boolean;
|
|
isPath: (value: any) => value is Path;
|
|
isSibling: (path: Path, another: Path) => boolean;
|
|
levels: (path: Path, options?: PathLevelsOptions) => Path[];
|
|
next: (path: Path) => Path;
|
|
operationCanTransformPath: (operation: Operation) => boolean;
|
|
parent: (path: Path) => Path;
|
|
previous: (path: Path) => Path;
|
|
relative: (path: Path, ancestor: Path) => Path;
|
|
transform: (path: Path, operation: Operation, options?: PathTransformOptions) => Path | null;
|
|
}
|
|
export declare const Path: PathInterface;
|
|
//# sourceMappingURL=path.d.ts.map
|