WorkerProxy

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

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:74

Whether this resource has been disposed.

Returns

boolean

Inherited from

AsyncDisposable.disposed

Methods

[asyncDispose]()

[asyncDispose](): Promise<void>

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

Asynchronously dispose of this resource.

Returns

Promise<void>

Inherited from

AsyncDisposable.[asyncDispose]

addInkStroke()

addInkStroke(pageId, annotationIndex, points): Promise<number>

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

Parameters

Parameter	Type
`pageId`	`string`
`annotationIndex`	`number`
`points`	`object`[]

Returns

Promise<number>

appendAnnotationAttachmentPoints()

appendAnnotationAttachmentPoints(pageId, annotationIndex, points): Promise<boolean>

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

Parameters

Parameter	Type
`pageId`	`string`
`annotationIndex`	`number`
`points`	`SerialisedQuadPoints`

Returns

Promise<boolean>

applyRedactions()

applyRedactions(pageId, fillColour?, removeIntersectingAnnotations?): Promise<ApplyRedactionsResponse>

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

Parameters

Parameter	Type
`pageId`	`string`
`fillColour?`	`Colour`
`removeIntersectingAnnotations?`	`boolean`

Returns

Promise<ApplyRedactionsResponse>

builderAddPage()

builderAddPage(builderId, options?): Promise<BuilderAddPageResponse>

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

Parameters

Parameter	Type
`builderId`	`string`
`options?`	{ `height?`: `number`; `width?`: `number`; }
`options.height?`	`number`
`options.width?`	`number`

Returns

Promise<BuilderAddPageResponse>

builderLoadStandardFont()

builderLoadStandardFont(builderId, fontName): Promise<BuilderLoadStandardFontResponse>

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

Parameters

Parameter	Type
`builderId`	`string`
`fontName`	`string`

Returns

Promise<BuilderLoadStandardFontResponse>

builderPageAddEllipse()

builderPageAddEllipse(pageBuilderId, cx, cy, rx, ry, style?): Promise<void>

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

Parameters

Parameter	Type
`pageBuilderId`	`string`
`cx`	`number`
`cy`	`number`
`rx`	`number`
`ry`	`number`
`style?`	`ShapeStyle`

Returns

Promise<void>

builderPageAddLine()

builderPageAddLine(pageBuilderId, x1, y1, x2, y2, style?): Promise<void>

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

Parameters

Parameter	Type
`pageBuilderId`	`string`
`x1`	`number`
`y1`	`number`
`x2`	`number`
`y2`	`number`
`style?`	`ShapeStyle`

Returns

Promise<void>

builderPageAddRectangle()

builderPageAddRectangle(pageBuilderId, x, y, w, h, style?): Promise<void>

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

Parameters

Parameter	Type
`pageBuilderId`	`string`
`x`	`number`
`y`	`number`
`w`	`number`
`h`	`number`
`style?`	`ShapeStyle`

Returns

Promise<void>

builderPageAddText()

builderPageAddText(pageBuilderId, text, x, y, fontId, fontSize, colour?): Promise<void>

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

Parameters

Parameter	Type
`pageBuilderId`	`string`
`text`	`string`
`x`	`number`
`y`	`number`
`fontId`	`string`
`fontSize`	`number`
`colour?`	`Colour`

Returns

Promise<void>

builderSave()

builderSave(builderId, options?): Promise<ArrayBuffer>

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

Parameters

Parameter	Type
`builderId`	`string`
`options?`	`SaveOptions`

Returns

Promise<ArrayBuffer>

canFormUndo()

canFormUndo(pageId): Promise<boolean>

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

Parameters

Parameter	Type
`pageId`	`string`

Returns

Promise<boolean>

closeDocument()

closeDocument(documentId): Promise<void>

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

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:334

Close a page.

Parameters

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

Returns

Promise<void>

Throws

If the page cannot be closed

createAnnotation()

createAnnotation(pageId, subtype): Promise<SerialisedAnnotation>

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

Parameters

Parameter	Type
`pageId`	`string`
`subtype`	`AnnotationType`

Returns

Promise<SerialisedAnnotation>

createDocumentBuilder()

createDocumentBuilder(): Promise<CreateDocumentBuilderResponse>

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

Returns

Promise<CreateDocumentBuilderResponse>

createNUp()

createNUp(documentId, options): Promise<CreateNUpResponse>

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

Parameters

Parameter	Type
`documentId`	`string`
`options`	`NUpLayoutOptions`

Returns

Promise<CreateNUpResponse>

deletePage()

deletePage(documentId, pageIndex): Promise<void>

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

Parameters

Parameter	Type
`documentId`	`string`
`pageIndex`	`number`

Returns

Promise<void>

dispose()

dispose(): Promise<void>

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

Alias for Symbol.asyncDispose for explicit calls.

Returns

Promise<void>

Inherited from

AsyncDisposable.dispose

disposeDocumentBuilder()

disposeDocumentBuilder(builderId): Promise<void>

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

Parameters

Parameter	Type
`builderId`	`string`

Returns

Promise<void>

findText()

findText(pageId, query, flags?): Promise<TextSearchResult[]>

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

Parameters

Parameter	Type
`pageId`	`string`
`query`	`string`
`flags?`	`TextSearchFlags`

Returns

Promise<TextSearchResult[]>

flattenPage()

flattenPage(pageId, flags?): Promise<FlattenResult>

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

Parameters

Parameter	Type
`pageId`	`string`
`flags?`	`FlattenFlags`

Returns

Promise<FlattenResult>

formUndo()

formUndo(pageId): Promise<boolean>

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

Parameters

Parameter	Type
`pageId`	`string`

Returns

Promise<boolean>

generatePageContent()

generatePageContent(pageId): Promise<boolean>

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

Parameters

Parameter	Type
`pageId`	`string`

Returns

Promise<boolean>

getAllPageDimensions()

getAllPageDimensions(documentId): Promise<object[]>

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

Parameters

Parameter	Type
`documentId`	`string`

Returns

Promise<object[]>

getAnnotations()

getAnnotations(pageId): Promise<SerialisedAnnotation[]>

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

Parameters

Parameter	Type
`pageId`	`string`

Returns

Promise<SerialisedAnnotation[]>

getAttachments()

getAttachments(documentId): Promise<SerialisedAttachment[]>

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

Parameters

Parameter	Type
`documentId`	`string`

Returns

Promise<SerialisedAttachment[]>

getBookmarks()

getBookmarks(documentId): Promise<Bookmark[]>

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

Parameters

Parameter	Type
`documentId`	`string`

Returns

Promise<Bookmark[]>

getCharacterInfo()

getCharacterInfo(pageId, charIndex): Promise<CharacterInfo | undefined>

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

Parameters

Parameter	Type
`pageId`	`string`
`charIndex`	`number`

Returns

Promise<CharacterInfo | undefined>

getCharAtPos()

getCharAtPos(pageId, x, y): Promise<CharAtPosResponse | null>

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

Parameters

Parameter	Type
`pageId`	`string`
`x`	`number`
`y`	`number`

Returns

Promise<CharAtPosResponse | null>

getCharBox()

getCharBox(pageId, charIndex): Promise<CharBox | undefined>

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

Parameters

Parameter	Type
`pageId`	`string`
`charIndex`	`number`

Returns

Promise<CharBox | undefined>

getDocumentInfo()

getDocumentInfo(documentId): Promise<DocumentInfoResponse>

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

Parameters

Parameter	Type
`documentId`	`string`

Returns

Promise<DocumentInfoResponse>

getExtendedDocumentInfo()

getExtendedDocumentInfo(documentId): Promise<ExtendedDocumentInfoResponse>

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

Parameters

Parameter	Type
`documentId`	`string`

Returns

Promise<ExtendedDocumentInfoResponse>

getFormSelectedText()

getFormSelectedText(pageId): Promise<string | null>

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

Parameters

Parameter	Type
`pageId`	`string`

Returns

Promise<string | null>

getFormWidgets()

getFormWidgets(pageId): Promise<SerialisedFormWidget[]>

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

Parameters

Parameter	Type
`pageId`	`string`

Returns

Promise<SerialisedFormWidget[]>

getJavaScriptActions()

getJavaScriptActions(documentId): Promise<JavaScriptAction[]>

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

Parameters

Parameter	Type
`documentId`	`string`

Returns

Promise<JavaScriptAction[]>

getLinks()

getLinks(pageId): Promise<SerialisedLink[]>

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

Parameters

Parameter	Type
`pageId`	`string`

Returns

Promise<SerialisedLink[]>

getMetadata()

getMetadata(documentId): Promise<DocumentMetadata>

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

Parameters

Parameter	Type
`documentId`	`string`

Returns

Promise<DocumentMetadata>

getNamedDestinationByName()

getNamedDestinationByName(documentId, name): Promise<NamedDestination | null>

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

Parameters

Parameter	Type
`documentId`	`string`
`name`	`string`

Returns

Promise<NamedDestination | null>

getNamedDestinations()

getNamedDestinations(documentId): Promise<NamedDestination[]>

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

Parameters

Parameter	Type
`documentId`	`string`

Returns

Promise<NamedDestination[]>

getPageCount()

getPageCount(documentId): Promise<number>

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

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

getPageInfo()

getPageInfo(pageId): Promise<PageInfoResponse>

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

Parameters

Parameter	Type
`pageId`	`string`

Returns

Promise<PageInfoResponse>

getPageLabel()

getPageLabel(documentId, pageIndex): Promise<string | null>

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

Parameters

Parameter	Type
`documentId`	`string`
`pageIndex`	`number`

Returns

Promise<string | null>

getPageObjects()

getPageObjects(pageId): Promise<SerialisedPageObject[]>

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

Parameters

Parameter	Type
`pageId`	`string`

Returns

Promise<SerialisedPageObject[]>

getPageSize()

getPageSize(pageId): Promise<PageSizeResponse>

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

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

getPermissions()

getPermissions(documentId): Promise<DocumentPermissions>

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

Parameters

Parameter	Type
`documentId`	`string`

Returns

Promise<DocumentPermissions>

getPrintPageRanges()

getPrintPageRanges(documentId): Promise<number[] | undefined>

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

Parameters

Parameter	Type
`documentId`	`string`

Returns

Promise<number[] | undefined>

getSignatures()

getSignatures(documentId): Promise<SerialisedSignature[]>

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

Parameters

Parameter	Type
`documentId`	`string`

Returns

Promise<SerialisedSignature[]>

getStructureTree()

getStructureTree(pageId): Promise<StructureElement[] | null>

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

Parameters

Parameter	Type
`pageId`	`string`

Returns

Promise<StructureElement[] | null>

getText()

getText(pageId): Promise<string>

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

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

getTextInRect()

getTextInRect(pageId, left, top, right, bottom): Promise<string>

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

Parameters

Parameter	Type
`pageId`	`string`
`left`	`number`
`top`	`number`
`right`	`number`
`bottom`	`number`

Returns

Promise<string>

getTextLayout()

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

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

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]

getViewerPreferences()

getViewerPreferences(documentId): Promise<ViewerPreferences>

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

Parameters

Parameter	Type
`documentId`	`string`

Returns

Promise<ViewerPreferences>

getWebLinks()

getWebLinks(pageId): Promise<WebLink[]>

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

Parameters

Parameter	Type
`pageId`	`string`

Returns

Promise<WebLink[]>

importPages()

importPages(targetDocId, sourceDocId, options?): Promise<void>

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

Parameters

Parameter	Type
`targetDocId`	`string`
`sourceDocId`	`string`
`options?`	`ImportPagesOptions`

Returns

Promise<void>

insertBlankPage()

insertBlankPage(documentId, pageIndex, width, height): Promise<void>

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

Parameters

Parameter	Type
`documentId`	`string`
`pageIndex`	`number`
`width`	`number`
`height`	`number`

Returns

Promise<void>

killFormFocus()

killFormFocus(documentId): Promise<boolean>

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

Parameters

Parameter	Type
`documentId`	`string`

Returns

Promise<boolean>

loadPage()

loadPage(documentId, pageIndex): Promise<LoadPageResponse>

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

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

movePages()

movePages(documentId, pageIndices, destPageIndex): Promise<void>

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

Parameters

Parameter	Type
`documentId`	`string`
`pageIndices`	`number`[]
`destPageIndex`	`number`

Returns

Promise<void>

openDocument()

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

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

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:795

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

removeAnnotation()

removeAnnotation(pageId, annotationIndex): Promise<boolean>

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

Parameters

Parameter	Type
`pageId`	`string`
`annotationIndex`	`number`

Returns

Promise<boolean>

renderPage()

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

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

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

renderPageStandalone()

renderPageStandalone(documentId, pageIndex, options, onProgress?): Promise<RenderResult>

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

Render a page in one round-trip: load, render, close — all inside the worker.

Eliminates 2 round-trips compared to loadPage → renderPage → closePage.

Parameters

Parameter	Type
`documentId`	`string`
`pageIndex`	`number`
`options`	`RenderOptions`
`onProgress?`	`ProgressCallback`

Returns

Promise<RenderResult>

saveDocument()

saveDocument(documentId, options?): Promise<ArrayBuffer>

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

Parameters

Parameter	Type
`documentId`	`string`
`options?`	`SaveOptions`

Returns

Promise<ArrayBuffer>

setAnnotationAttachmentPoints()

setAnnotationAttachmentPoints(pageId, annotationIndex, quadIndex, points): Promise<boolean>

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

Parameters

Parameter	Type
`pageId`	`string`
`annotationIndex`	`number`
`quadIndex`	`number`
`points`	`SerialisedQuadPoints`

Returns

Promise<boolean>

setAnnotationBorder()

setAnnotationBorder(pageId, annotationIndex, hRadius, vRadius, borderWidth): Promise<boolean>

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

Parameters

Parameter	Type
`pageId`	`string`
`annotationIndex`	`number`
`hRadius`	`number`
`vRadius`	`number`
`borderWidth`	`number`

Returns

Promise<boolean>

setAnnotationColour()

setAnnotationColour(pageId, annotationIndex, colourType, colour): Promise<boolean>

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

Parameters

Parameter	Type
`pageId`	`string`
`annotationIndex`	`number`
`colourType`	`AnnotationColourType`
`colour`	`Colour`

Returns

Promise<boolean>

setAnnotationFlags()

setAnnotationFlags(pageId, annotationIndex, flags): Promise<boolean>

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

Parameters

Parameter	Type
`pageId`	`string`
`annotationIndex`	`number`
`flags`	`number`

Returns

Promise<boolean>

setAnnotationRect()

setAnnotationRect(pageId, annotationIndex, rect): Promise<boolean>

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

Parameters

Parameter	Type
`pageId`	`string`
`annotationIndex`	`number`
`rect`	`Rect`

Returns

Promise<boolean>

setAnnotationString()

setAnnotationString(pageId, annotationIndex, key, value): Promise<boolean>

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

Parameters

Parameter	Type
`pageId`	`string`
`annotationIndex`	`number`
`key`	`string`
`value`	`string`

Returns

Promise<boolean>

setAnnotationURI()

setAnnotationURI(pageId, annotationIndex, uri): Promise<boolean>

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

Parameters

Parameter	Type
`pageId`	`string`
`annotationIndex`	`number`
`uri`	`string`

Returns

Promise<boolean>

setFormHighlight()

setFormHighlight(documentId, fieldType, colour, alpha): Promise<void>

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

Parameters

Parameter	Type
`documentId`	`string`
`fieldType`	`FormFieldType`
`colour`	`Colour`
`alpha`	`number`

Returns

Promise<void>

setPageRotation()

setPageRotation(pageId, rotation): Promise<void>

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

Parameters

Parameter	Type
`pageId`	`string`
`rotation`	`PageRotation`

Returns

Promise<void>

create()

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

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

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