tuil
ReferencePackages@mwillbanks/tuil-editorAPI

EditorTransaction

interface exported by @mwillbanks/tuil-editor.

View rawEdit

interface

Public interface exported by @mwillbanks/tuil-editor.

export interface EditorTransaction {
  readonly changes?: readonly EditorChange[];
  readonly selections?: readonly EditorSelection[];
  readonly annotations?: Readonly<Record<string, unknown>>;
  readonly addToHistory?: boolean;
}

Members

MemberTypeRequiredDescriptionRelated types
changesreadonly EditorChange[] | undefinedNoThe changes member uses the readonly EditorChange[] | undefined contract.EditorChange
selectionsreadonly EditorSelection[] | undefinedNoThe selections member uses the readonly EditorSelection[] | undefined contract.EditorSelection
annotationsReadonly<Record<string, unknown>> | undefinedNoThe annotations member uses the Readonly<Record<string, unknown>> | undefined contract.
addToHistoryboolean | undefinedNoThe addToHistory member uses the boolean | undefined 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.

Source

View the secondary source reference

Package

@mwillbanks/tuil-editor

On this page