EditorCommand
interface exported by @mwillbanks/tuil-editor.
interface
Public interface exported by @mwillbanks/tuil-editor.
export interface EditorCommand {
readonly id: string;
readonly title: string;
execute(
session: EditorSession,
argument?: unknown,
): boolean | Promise<boolean>;
}Members
| Member | Type | Required | Description | Related types |
|---|---|---|---|---|
id | string | Yes | The id member uses the string contract. | — |
title | string | Yes | The title member uses the string contract. | — |
execute | (session: EditorSession, argument?: unknown) => boolean | Promise<boolean> | Yes | The execute member uses the (session: EditorSession, argument?: unknown) => boolean | Promise<boolean> contract. | EditorSession |
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