Class Transaction

An ordered list of steps applied to a document, plus selection, stored marks and metadata. Build one via state.tr, then dispatch it.

Implements

PositionMapper

Index

Constructors

Properties

docs steps time

Accessors

doc docChanged selection storedMarks

Methods

getMeta mapPosition maybeStep metaKeys setMeta setSelection setStoredMarks step

Constructors

constructor

new Transaction(state: EditorState): Transaction
Parameters
- state: EditorState
Returns Transaction
- Defined in packages/core/src/state/transaction.ts:25

Properties

`Readonly`docs

docs: EditorNode[] = []

The document before each step, parallel to steps.

`Readonly`steps

steps: Step[] = []

`Readonly`time

time: number = ...

Creation time, used by the undo history for grouping.

Accessors

doc

get doc(): EditorNode
Returns EditorNode
- Defined in packages/core/src/state/transaction.ts:31

docChanged

get docChanged(): boolean
Returns boolean
- Defined in packages/core/src/state/transaction.ts:35

selection

get selection(): Selection
The selection after this transaction: the explicitly set one (remapped through any later steps), or the input selection mapped through all steps.

Returns Selection
- Defined in packages/core/src/state/transaction.ts:79

storedMarks

get storedMarks(): readonly Mark[] | null
Returns readonly Mark[] | null
- Defined in packages/core/src/state/transaction.ts:95

Methods

getMeta

getMeta(key: string): unknown
Parameters
- key: string
Returns unknown
- Defined in packages/core/src/state/transaction.ts:110

mapPosition

mapPosition(position: Position, bias?: Bias): Position
Map a position from before this transaction to after it.
Parameters
- position: Position
- Optionalbias: Bias
Returns Position
Implementation of PositionMapper.mapPosition
- Defined in packages/core/src/state/transaction.ts:63

maybeStep

maybeStep(step: Step): boolean
Apply a step; returns false (leaving the transaction untouched) on failure.
Parameters
- step: Step
Returns boolean
- Defined in packages/core/src/state/transaction.ts:40

metaKeys

metaKeys(): readonly string[]
Every metadata key set on this transaction, in the order it was set.

For the one caller that has to hand a transaction's whole provenance on: a dispatch transform that replaces a transaction with a different one (suggestion mode rewriting an edit, say) drops every key the original carried unless it copies them, and the keys it does not know about are exactly the ones it cannot afford to guess at. A replay guard silently lost is an editing loop.

Returns readonly string[]
- Defined in packages/core/src/state/transaction.ts:124

setMeta

setMeta(key: string, value: unknown): this
Parameters
- key: string
- value: unknown
Returns this
- Defined in packages/core/src/state/transaction.ts:104

setSelection

setSelection(selection: Selection): this
Parameters
- selection: Selection
Returns this
- Defined in packages/core/src/state/transaction.ts:89

setStoredMarks

setStoredMarks(marks: readonly Mark[] | null): this
Parameters
- marks: readonly Mark[] | null
Returns this
- Defined in packages/core/src/state/transaction.ts:99

step

step(step: Step): this
Apply a step; throws on failure.
Parameters
- step: Step
Returns this
- Defined in packages/core/src/state/transaction.ts:45