SaveJob
A save in progress, stepped by the caller with a budget of work units (ADR 0028 §3).
Methods
Section titled “Methods”cancel()
Section titled “cancel()”cancel():
void
Stops the job: its next step fails with cancelled.
Returns
Section titled “Returns”void
free()
Section titled “free()”free():
void
Frees the job’s memory now (otherwise when it is garbage-collected).
Returns
Section titled “Returns”void
step()
Section titled “step()”step(
budget):any
Runs at most budget work units.
Parameters
Section titled “Parameters”budget
Section titled “budget”number
Returns
Section titled “Returns”any
{ state: "progress", … }, or { state: "done", bytes, report } at the end.
Throws
Section titled “Throws”LaminaError cancelled, document-changed, job-finished, or the save’s errors.