# EditorTransaction

Source: /tuil/docs/reference/packages/editor/api/editor-transaction
Locale: en

interface exported by @mwillbanks/tuil-editor.



{/* Generated by tooling/docs/generate-reference.ts. */}

## interface [#interface]

Public interface exported by `@mwillbanks/tuil-editor`.

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

## Members [#members]

| Member         | Type                                             | Required | Description                                                                                  | Related types                                                             |
| -------------- | ------------------------------------------------ | -------- | -------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
| `changes`      | `readonly EditorChange[] \| undefined`           | No       | The `changes` member uses the `readonly EditorChange[] \| undefined` contract.               | [`EditorChange`](/tuil/docs/reference/packages/editor/api/editor-change)       |
| `selections`   | `readonly EditorSelection[] \| undefined`        | No       | The `selections` member uses the `readonly EditorSelection[] \| undefined` contract.         | [`EditorSelection`](/tuil/docs/reference/packages/editor/api/editor-selection) |
| `annotations`  | `Readonly<Record<string, unknown>> \| undefined` | No       | The `annotations` member uses the `Readonly<Record<string, unknown>> \| undefined` contract. | —                                                                         |
| `addToHistory` | `boolean \| undefined`                           | No       | The `addToHistory` member uses the `boolean \| undefined` contract.                          | —                                                                         |

## Parameters [#parameters]

This declaration has no public members.

## Returns [#returns]

This declaration does not return a value.

## Throws [#throws]

No thrown errors are documented for this declaration.

## Related types [#related-types]

* [`EditorChange`](/tuil/docs/reference/packages/editor/api/editor-change)
* [`EditorSelection`](/tuil/docs/reference/packages/editor/api/editor-selection)

## Source [#source]

[View the secondary source reference](https://github.com/mwillbanks/tuil/blob/main/packages/editor/src/index.ts)

## Package [#package]

[@mwillbanks/tuil-editor](/tuil/docs/reference/packages/editor)