mirror/slate
1
0
Fork 0
mirror of https://github.com/ianstormtaylor/slate.git synced 2025-08-23 23:42:56 +02:00
Code Issues Releases Wiki Activity

Prefix operation static methods in docs with Operation.

Browse Source
This commit is contained in:
Sunny Hirai
2023-04-12 09:37:38 -07:00
parent 7c2beea54e
commit dd2dfbdfc7
1 changed files with 6 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
docs/api/operation.md
View File

@@ -10,28 +10,28 @@
### Manipulation methods ### Manipulation methods
#### `inverse(op: Operation) => Operation` #### `Operation.inverse(op: Operation) => Operation`
Invert an operation, returning a new operation that will exactly undo the original when applied. Invert an operation, returning a new operation that will exactly undo the original when applied.
### Check methods ### Check methods
#### `isNodeOperation(value: any) => boolean` #### `Operation.isNodeOperation(value: any) => boolean`
Check if a value is a `NodeOperation` object. Returns the value as a `NodeOperation` if it is one. Check if a value is a `NodeOperation` object. Returns the value as a `NodeOperation` if it is one.
#### `isOperation(value: any) => boolean` #### `Operation.isOperation(value: any) => boolean`
Check if a value is an `Operation` object. Returns the value as an `Operation` if it is one. Check if a value is an `Operation` object. Returns the value as an `Operation` if it is one.
#### `isOperationList(value: any) => boolean` #### `Operation.isOperationList(value: any) => boolean`
Check if a value is a list of `Operation` objects. Returns the value as an `Operation[]` if it is one. Check if a value is a list of `Operation` objects. Returns the value as an `Operation[]` if it is one.
#### `isSelectionOperation(value: any) => boolean` #### `Operation.isSelectionOperation(value: any) => boolean`
Check if a value is a `SelectionOperation` object. Returns the value as a `SelectionOperation` if it is one. Check if a value is a `SelectionOperation` object. Returns the value as a `SelectionOperation` if it is one.
#### `isTextOperation(value: any) => boolean` #### `Operation.isTextOperation(value: any) => boolean`
Check if a value is a `TextOperation` object. Returns the value as a `TextOperation` if it is one. Check if a value is a `TextOperation` object. Returns the value as a `TextOperation` if it is one.