Skip to content

Interface: OperationDef<Doc, Op> ​

Defined in: packages/core/src/plugin.ts:24

Type Parameters ​

Doc ​

Doc

Op ​

Op extends OperationBase<string> = OperationBase<string>

Properties ​

migrate? ​

optional migrate?: (fromVersion, op) => unknown

Defined in: packages/core/src/plugin.ts:33

Upgrades an op written by an older plugin version. Called with the raw value before validation. Return the op in the current shape.

Parameters ​

fromVersion ​

number

op ​

unknown

Returns ​

unknown


reduce ​

reduce: (slice, op) => Doc

Defined in: packages/core/src/plugin.ts:28

Pure: returns the plugin's next document slice.

Parameters ​

slice ​

Doc

op ​

Op

Returns ​

Doc


schema ​

schema: OperationSchema<Op>

Defined in: packages/core/src/plugin.ts:26


type ​

type: Op["type"]

Defined in: packages/core/src/plugin.ts:25