# RichTransaction

Source: /tuil/docs/reference/packages/editor/api/rich-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 RichTransaction {
  readonly path: readonly number[];
  readonly node?: RichNode;
  readonly remove?: boolean;
}
```

## Members [#members]

| Member   | Type                    | Required | Description                                                   | Related types                                               |
| -------- | ----------------------- | -------- | ------------------------------------------------------------- | ----------------------------------------------------------- |
| `path`   | `readonly number[]`     | Yes      | The `path` member uses the `readonly number[]` contract.      | —                                                           |
| `node`   | `RichNode \| undefined` | No       | The `node` member uses the `RichNode \| undefined` contract.  | [`RichNode`](/tuil/docs/reference/packages/editor/api/rich-node) |
| `remove` | `boolean \| undefined`  | No       | The `remove` 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]

* [`RichNode`](/tuil/docs/reference/packages/editor/api/rich-node)

## Source [#source]

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

## Package [#package]

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