These docs describe changes that aren’t released yet. For the newest release, see the released docs.
SaveJob
A save in progress, stepped by the caller with a budget of work units (ADR 0028 §3). Freed with
its document; every call after that throws disposed.
Extends
Section titled “Extends”Handle<BaseGlue>
Methods
Section titled “Methods”[dispose]()
Section titled “[dispose]()”[dispose]():
void
Frees the handle at the end of a using block (an alias of free()).
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”Handle.[dispose]
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 handle’s memory now; without it, the garbage collector frees it later. A second
call does nothing, and any other call afterwards throws disposed. Prefer using, which
calls this at the end of the block.
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”Handle.free
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”LaminaPdfError cancelled, document-changed, job-finished, or the save’s errors.