tuil
ReferencePackages@mwillbanks/tuil-editorAPI

EditorBackend

interface exported by @mwillbanks/tuil-editor.

View rawEdit

interface

Public interface exported by @mwillbanks/tuil-editor.

export interface EditorBackend {
  readonly id: string;
  readonly version: string;
  readonly capabilities: ReadonlySet<EditorCapability>;
  create(options: EditorProviderOptions): EditorSession;
}

Members

MemberTypeRequiredDescriptionRelated types
idstringYesThe id member uses the string contract.
versionstringYesThe version member uses the string contract.
capabilitiesReadonlySet<EditorCapability>YesThe capabilities member uses the ReadonlySet<EditorCapability> contract.EditorCapability
create(options: EditorProviderOptions) => EditorSessionYesThe create member uses the (options: EditorProviderOptions) => EditorSession contract.EditorProviderOptions, 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.

Source

View the secondary source reference

Package

@mwillbanks/tuil-editor

On this page