WorkerPDFium
Defined in: src/context/worker-client.ts:43
High-level worker-backed PDFium instance.
Use this when you want an ergonomic API over worker mode:
openDocument(...)document.getPage(...)document.renderPage(...)
Extends
Section titled “Extends”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”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”openDocument()
Section titled “openDocument()”openDocument(
data,options):Promise<WorkerPDFiumDocument>
Defined in: src/context/worker-client.ts:77
Open a document in the worker.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
data | ArrayBuffer | Uint8Array<ArrayBufferLike> |
options | OpenDocumentOptions |
Returns
Section titled “Returns”Promise<WorkerPDFiumDocument>
ping()
Section titled “ping()”ping(
timeout):Promise<boolean>
Defined in: src/context/worker-client.ts:95
Health-check the worker transport.
Parameters
Section titled “Parameters”| Parameter | Type | Default value |
|---|---|---|
timeout | number | 5_000 |
Returns
Section titled “Returns”Promise<boolean>
create()
Section titled “create()”
staticcreate(options):Promise<WorkerPDFium>
Defined in: src/context/worker-client.ts:55
Create a worker-backed PDFium instance.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
options | WorkerPDFiumOptions |
Returns
Section titled “Returns”Promise<WorkerPDFium>