WorkerPDFiumDocument
Defined in: src/context/worker-client.ts:116
High-level worker-backed PDF document.
Extends
Section titled “Extends”Properties
Section titled “Properties”pageCount
Section titled “pageCount”
readonlypageCount:number
Defined in: src/context/worker-client.ts:125
Number of pages in this document.
Accessors
Section titled “Accessors”disposed
Section titled “disposed”Get Signature
Section titled “Get Signature”get disposed():
boolean
Defined in: src/core/disposable.ts:73
Whether this resource has been disposed.
Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”Get Signature
Section titled “Get Signature”get id():
string
Defined in: src/context/worker-client.ts:139
Internal document ID used by the worker protocol.
Returns
Section titled “Returns”string
Methods
Section titled “Methods”[asyncDispose]()
Section titled “[asyncDispose]()”[asyncDispose]():
Promise<void>
Defined in: src/core/disposable.ts:195
Asynchronously dispose of this resource.
Returns
Section titled “Returns”Promise<void>
Inherited from
Section titled “Inherited from”AsyncDisposable.[asyncDispose]
dispose()
Section titled “dispose()”dispose():
Promise<void>
Defined in: src/core/disposable.ts:206
Alias for Symbol.asyncDispose for explicit calls.
Returns
Section titled “Returns”Promise<void>
Inherited from
Section titled “Inherited from”getPage()
Section titled “getPage()”getPage(
pageIndex):Promise<WorkerPDFiumPage>
Defined in: src/context/worker-client.ts:146
Load a page and return a worker-backed page object.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
pageIndex | number |
Returns
Section titled “Returns”Promise<WorkerPDFiumPage>
renderPage()
Section titled “renderPage()”renderPage(
pageIndex,options,onProgress?):Promise<RenderResult>
Defined in: src/context/worker-client.ts:161
High-level convenience rendering method.
Loads the page, renders it, and closes the page automatically.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
pageIndex | number |
options | RenderOptions |
onProgress? | ProgressCallback |
Returns
Section titled “Returns”Promise<RenderResult>