Skip to content

Function: defineOperation() ​

defineOperation<Doc, Op>(def): OperationDef<Doc, Op>

Defined in: plugin-sdk/src/index.ts:44

Declares one operation: its wire type, a runtime schema and a pure reducer over the plugin's document slice.

Type Parameters ​

Doc ​

Doc

Op ​

Op extends OperationBase<string>

Parameters ​

def ​

migrate? ​

(fromVersion, op) => unknown

reduce ​

(slice, op) => Doc

schema ​

OperationSchema<Op>

type ​

Op["type"]

Returns ​

OperationDef<Doc, Op>