Interface: PatchSenderOptions
Defined in: src/lib/messages/PatchSender/index.ts:64
Options for sending patches
Properties
createCanvas
createCanvas:
CanvasFactory
Defined in: src/lib/messages/PatchSender/index.ts:71
delayMs?
optionaldelayMs?:number
Defined in: src/lib/messages/PatchSender/index.ts:72
height
height:
number
Defined in: src/lib/messages/PatchSender/index.ts:66
layers
layers: () => readonly
DrawableLayer[]
Defined in: src/lib/messages/PatchSender/index.ts:68
The user's own layers, top first
Returns
readonly DrawableLayer[]
send
send: (
message) =>void|Promise<void>
Defined in: src/lib/messages/PatchSender/index.ts:70
Delivers a patch (if it throws or rejects, the changes go with the next patch)
Parameters
message
Returns
void | Promise<void>
whenIdle?
optionalwhenIdle?: (run) =>void
Defined in: src/lib/messages/PatchSender/index.ts:74
Runs the sync once it's due, e.g. waiting for a pause in drawing (runs it straight away by default)
Parameters
run
() => unknown
Returns
void
width
width:
number
Defined in: src/lib/messages/PatchSender/index.ts:65