mirror/slate
1
0
Fork 0
mirror of https://github.com/ianstormtaylor/slate.git synced 2025-08-11 01:33:58 +02:00
Code Issues Releases Wiki Activity

Update Operation API documentation (#5239)

Browse Source 
* fix typo in implementation

* doc based on implementation

* fix doc typo
This commit is contained in:
Sim Ho
2022-12-29 18:38:03 -05:00
committed by GitHub
parent d7353677e3
commit 55effa953c
2 changed files with 31 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
docs/api/operation.md
View File

@@ -2,4 +2,30 @@
`Operation` objects define the low-level instructions that Slate editors use to apply changes to their internal state. Representing all changes as operations is what allows Slate editors to easily implement history, collaboration, and other features.
_The `Operation` API reference needs to be added._
### Check methods
#### `isNodeOperation(value: any) => boolean`
Check if a value is a `NodeOperation` object. Returns the value as a `NodeOperation` if it is one.
#### `isOperation(value: any) => boolean`
Check if a value is an `Operation` object. Returns the value as an `Operation` if it is one.
#### `isOperationList(value: any) => boolean`
Check if a value is a list of `Operation` objects. Returns the value as an `Operation[]` if it is one.
#### `isSelectionOperation(value: any) => boolean`
Check if a value is a `SelectionOperation` object. Returns the value as a `SelectionOperation` if it is one.
#### `isTextOperation(value: any) => boolean`
Check if a value is a `TextOperation` object. Returns the value as a `TextOperation` if it is one.
### Static methods
#### `inverse(op: Operation) => Operation`
Invert an operation, returning a new operation that will exactly undo the original when applied.