EditorHandle
Defined in: editor-handle.ts:21
Properties
Section titled “Properties”| Property | Modifier | Type | Defined in |
|---|---|---|---|
actions | readonly | ActionDescriptor[] | editor-handle.ts:36 |
blocks | readonly | BlockDescriptor[] | editor-handle.ts:34 |
history | readonly | History | editor-handle.ts:33 |
isReady | readonly | boolean | editor-handle.ts:23 |
marks | readonly | MarkDescriptor[] | editor-handle.ts:35 |
plim | readonly | PlimDriver | editor-handle.ts:22 |
Methods
Section titled “Methods”createTransaction()
Section titled “createTransaction()”createTransaction(): Transaction;Defined in: editor-handle.ts:27
Returns
Section titled “Returns”dispatch()
Section titled “dispatch()”dispatch(tx): void;Defined in: editor-handle.ts:26
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
tx | Transaction |
Returns
Section titled “Returns”void
getState()
Section titled “getState()”getState(): EditorState;Defined in: editor-handle.ts:24
Returns
Section titled “Returns”onAsyncEvent()
Section titled “onAsyncEvent()”onAsyncEvent<T>(name, handler): () => void;Defined in: editor-handle.ts:29
Type Parameters
Section titled “Type Parameters”| Type Parameter | Default type |
|---|---|
T | unknown |
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
name | string |
handler | AsyncEventHandler<T> |
Returns
Section titled “Returns”() => void
onTransaction()
Section titled “onTransaction()”onTransaction(cb): () => void;Defined in: editor-handle.ts:28
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
cb | (tx, state) => void |
Returns
Section titled “Returns”() => void
restoreSnapshot()
Section titled “restoreSnapshot()”restoreSnapshot(snap): void;Defined in: editor-handle.ts:32
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
snap | Snapshot |
Returns
Section titled “Returns”void
setState()
Section titled “setState()”setState(s): void;Defined in: editor-handle.ts:25
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
s | EditorState |
Returns
Section titled “Returns”void
supportsDecoration()
Section titled “supportsDecoration()”supportsDecoration(blockType): boolean;Defined in: editor-handle.ts:37
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
blockType | string |
Returns
Section titled “Returns”boolean
triggerAsyncEvent()
Section titled “triggerAsyncEvent()”triggerAsyncEvent<T>(name, payload?): Promise<T>;Defined in: editor-handle.ts:30
Type Parameters
Section titled “Type Parameters”| Type Parameter | Default type |
|---|---|
T | unknown |
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
name | string |
payload? | unknown |
Returns
Section titled “Returns”Promise<T>
whenReady()
Section titled “whenReady()”whenReady(cb): void;Defined in: editor-handle.ts:31
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
cb | () => void |
Returns
Section titled “Returns”void