WorkerProxy

Defined in: src/context/worker-proxy.ts:138

Worker proxy for off-main-thread PDF processing.

Provides the same API as the main-thread implementation but executes all operations in a Web Worker.

Example

await using proxy = await WorkerProxy.create(workerUrl, wasmBinary);
const doc = await proxy.openDocument(pdfArrayBuffer);

Extends

AsyncDisposable

Accessors

disposed

Get Signature

get disposed(): boolean

Defined in: src/core/disposable.ts:73

Whether this resource has been disposed.

Returns

boolean

Inherited from

AsyncDisposable.disposed

Methods

[asyncDispose]()

[asyncDispose](): Promise<void>

Defined in: src/core/disposable.ts:195

Asynchronously dispose of this resource.

Returns

Promise<void>

Inherited from

AsyncDisposable.[asyncDispose]

closeDocument()

closeDocument(documentId): Promise<void>

Defined in: src/context/worker-proxy.ts:252

Close a document.

Parameters

Parameter	Type	Description
`documentId`	`string`	Document ID returned from openDocument

Returns

Promise<void>

Throws

If the document cannot be closed

closePage()

closePage(pageId): Promise<void>

Defined in: src/context/worker-proxy.ts:285

Close a page.

Parameters

Parameter	Type	Description
`pageId`	`string`	Page ID returned from loadPage

Returns

Promise<void>

Throws

If the page cannot be closed

dispose()

dispose(): Promise<void>

Defined in: src/core/disposable.ts:206

Alias for Symbol.asyncDispose for explicit calls.

Returns

Promise<void>

Inherited from

AsyncDisposable.dispose

getPageCount()

getPageCount(documentId): Promise<number>

Defined in: src/context/worker-proxy.ts:263

Get the page count of a document.

Parameters

Parameter	Type	Description
`documentId`	`string`	Document ID

Returns

Promise<number>

The page count

Throws

If the page count cannot be retrieved

getPageSize()

getPageSize(pageId): Promise<PageSizeResponse>

Defined in: src/context/worker-proxy.ts:296

Get the size of a page.

Parameters

Parameter	Type	Description
`pageId`	`string`	Page ID

Returns

Promise<PageSizeResponse>

The page size

Throws

If the page size cannot be retrieved

getText()

getText(pageId): Promise<string>

Defined in: src/context/worker-proxy.ts:333

Get text content from a page.

Parameters

Parameter	Type	Description
`pageId`	`string`	Page ID

Returns

Promise<string>

The text content

Throws

If text extraction fails

getTextLayout()

getTextLayout(pageId): Promise<{ rects: Float32Array; text: string; }>

Defined in: src/context/worker-proxy.ts:343

Get text rects from a page.

Parameters

Parameter	Type	Description
`pageId`	`string`	Page ID

Returns

Promise<{ rects: Float32Array; text: string; }>

Object with text and flat array of coordinates [left, right, bottom, top]

loadPage()

loadPage(documentId, pageIndex): Promise<LoadPageResponse>

Defined in: src/context/worker-proxy.ts:275

Load a page from a document.

Parameters

Parameter	Type	Description
`documentId`	`string`	Document ID
`pageIndex`	`number`	Zero-based page index

Returns

Promise<LoadPageResponse>

The page info

Throws

If the page cannot be loaded

openDocument()

openDocument(data, password?): Promise<OpenDocumentResponse>

Defined in: src/context/worker-proxy.ts:242

Open a PDF document.

Parameters

Parameter	Type	Description
`data`	`ArrayBuffer`	PDF file data
`password?`	`string`	Optional password for encrypted documents

Returns

Promise<OpenDocumentResponse>

The document info

Throws

If the document cannot be opened

ping()

ping(timeout): Promise<boolean>

Defined in: src/context/worker-proxy.ts:356

Check if the worker is alive and responsive.

Sends a lightweight PING message and waits for a response.

Parameters

Parameter	Type	Default value	Description
`timeout`	`number`	`5_000`	Timeout in milliseconds (default: 5000)

Returns

Promise<boolean>

true if the worker responded within the timeout, false otherwise

Throws

Never — errors are caught internally and returned as false

renderPage()

renderPage(pageId, options, onProgress?): Promise<RenderResult>

Defined in: src/context/worker-proxy.ts:309

Render a page.

Parameters

Parameter	Type	Description
`pageId`	`string`	Page ID
`options`	`RenderOptions`	Render options
`onProgress?`	`ProgressCallback`	Optional progress callback

Returns

Promise<RenderResult>

The render result

Throws

If rendering fails

create()

static create(workerUrl, wasmBinary, options?): Promise<WorkerProxy>

Defined in: src/context/worker-proxy.ts:175

Create a new worker proxy.

Parameters

Parameter	Type	Description
`workerUrl`	`string` \| `URL`	URL to the worker script
`wasmBinary`	`ArrayBuffer`	Pre-loaded WASM binary
`options?`	`WorkerProxyOptions`	Optional configuration

Returns

Promise<WorkerProxy>

The worker proxy instance

Throws

If worker creation or initialisation fails