RichEditorDocument
interface exported by @mwillbanks/tuil-editor.
interface
Public interface exported by @mwillbanks/tuil-editor.
export interface RichEditorDocument {
snapshot(): RichDocument;
dispatch(transaction: RichTransaction): RichDocument;
undo(): boolean;
redo(): boolean;
serialize(format?: "json" | "markdown"): string;
}Members
| Member | Type | Required | Description | Related types |
|---|---|---|---|---|
snapshot | () => RichDocument | Yes | The snapshot member uses the () => RichDocument contract. | RichDocument |
dispatch | (transaction: RichTransaction) => RichDocument | Yes | The dispatch member uses the (transaction: RichTransaction) => RichDocument contract. | RichDocument, RichTransaction |
undo | () => boolean | Yes | The undo member uses the () => boolean contract. | — |
redo | () => boolean | Yes | The redo member uses the () => boolean contract. | — |
serialize | (format?: "json" | "markdown") => string | Yes | The serialize member uses the (format?: "json" | "markdown") => string contract. | — |
Parameters
This declaration has no public members.
Returns
This declaration does not return a value.
Throws
No thrown errors are documented for this declaration.
Related types
Source
View the secondary source reference