NativePDFiumInstance

@scaryterry/pdfium

---

Defined in: src/document/native-instance.ts:42

A PDFium instance backed by the native addon.

Use PDFium.initNative() to create an instance. Provides core document operations (page count, page access, text extraction, rendering) without requiring the WASM module.

Example

const pdfium = await PDFium.initNative();
if (pdfium) {
  using doc = pdfium.openDocument(pdfBytes);
  console.log(`Document has ${doc.pageCount} pages`);
}

Extends

• Disposable

Accessors

disposed

Get Signature

get disposed(): boolean

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

Whether this resource has been disposed.

Returns

boolean

Inherited from

Disposable.disposed

---

limits

Get Signature

get limits(): Readonly<Required<PDFiumLimits>>

Defined in: src/document/native-instance.ts:140

Get the configured resource limits.

Returns

Readonly<Required<PDFiumLimits>>

Methods

[dispose]()

[dispose](): void

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

Dispose of this resource, freeing WASM memory.

This method is idempotent - calling it multiple times has no effect after the first call.

Returns

void

Inherited from

Disposable.[dispose]

---

dispose()

dispose(): void

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

Alias for Symbol.dispose for explicit calls.

Returns

void

Example

document.dispose();

Inherited from

Disposable.dispose

---

openDocument()

openDocument(data, options): NativePDFiumDocument

Defined in: src/document/native-instance.ts:116

Open a PDF document from binary data.

Parameters

Parameter	Type	Description
data	ArrayBuffer | Uint8Array<ArrayBufferLike>	PDF file data
options	OpenDocumentOptions	Document options (e.g., password)

Returns

NativePDFiumDocument

The loaded document

Throws

If the document cannot be opened