NativePDFiumDocument
Defined in: src/document/native-document.ts:36
A PDF document backed by the native PDFium addon.
Supports core operations: page count, page access, text extraction, rendering, bookmarks, signatures, attachments, and import/export.
Extends
Section titled “Extends”Accessors
Section titled “Accessors”attachmentCount
Section titled “attachmentCount”Get Signature
Section titled “Get Signature”get attachmentCount():
number
Defined in: src/document/native-document.ts:308
Get the number of attachments in this document.
Returns
Section titled “Returns”number
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”fileVersion
Section titled “fileVersion”Get Signature
Section titled “Get Signature”get fileVersion():
number|undefined
Defined in: src/document/native-document.ts:155
Get the PDF file version (e.g. 14 for PDF 1.4).
Returns
Section titled “Returns”number | undefined
pageCount
Section titled “pageCount”Get Signature
Section titled “Get Signature”get pageCount():
number
Defined in: src/document/native-document.ts:67
Get the number of pages in this document.
Returns
Section titled “Returns”number
pageMode
Section titled “pageMode”Get Signature
Section titled “Get Signature”get pageMode():
PageMode
Defined in: src/document/native-document.ts:173
Get the document’s initial page mode.
Returns
Section titled “Returns”rawPermissions
Section titled “rawPermissions”Get Signature
Section titled “Get Signature”get rawPermissions():
number
Defined in: src/document/native-document.ts:161
Get the raw document permissions bitmask.
Returns
Section titled “Returns”number
securityHandlerRevision
Section titled “securityHandlerRevision”Get Signature
Section titled “Get Signature”get securityHandlerRevision():
number
Defined in: src/document/native-document.ts:180
Get the security handler revision, or -1 if unencrypted.
Returns
Section titled “Returns”number
signatureCount
Section titled “signatureCount”Get Signature
Section titled “Get Signature”get signatureCount():
number
Defined in: src/document/native-document.ts:238
Get the number of digital signatures in this document.
Returns
Section titled “Returns”number
userPermissions
Section titled “userPermissions”Get Signature
Section titled “Get Signature”get userPermissions():
number
Defined in: src/document/native-document.ts:167
Get the document user permissions bitmask.
Returns
Section titled “Returns”number
Methods
Section titled “Methods”[dispose]()
Section titled “[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
Section titled “Returns”void
Inherited from
Section titled “Inherited from”bookmarks()
Section titled “bookmarks()”bookmarks():
IterableIterator<Bookmark>
Defined in: src/document/native-document.ts:219
Iterate over top-level bookmarks lazily.
Each yielded bookmark includes its full subtree of children (eagerly loaded). Use this to avoid building the entire bookmark array up-front.
Returns
Section titled “Returns”IterableIterator<Bookmark>
copyViewerPreferences()
Section titled “copyViewerPreferences()”copyViewerPreferences(
source):boolean
Defined in: src/document/native-document.ts:385
Copy viewer preferences from another document.
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
source | NativePDFiumDocument | Source document to copy preferences from |
Returns
Section titled “Returns”boolean
true if preferences were copied
createNUpDocument()
Section titled “createNUpDocument()”createNUpDocument(
options):NativePDFiumDocument|undefined
Defined in: src/document/native-document.ts:398
Create a new document with N-up layout.
The caller must manage the returned document’s lifecycle.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
options | NUpLayoutOptions |
Returns
Section titled “Returns”NativePDFiumDocument | undefined
A new document handle, or undefined on failure.
dispose()
Section titled “dispose()”dispose():
void
Defined in: src/core/disposable.ts:164
Alias for Symbol.dispose for explicit calls.
Returns
Section titled “Returns”void
Example
Section titled “Example”document.dispose();Inherited from
Section titled “Inherited from”getAttachment()
Section titled “getAttachment()”getAttachment(
index):PDFAttachment|undefined
Defined in: src/document/native-document.ts:314
Get an attachment by index.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
index | number |
Returns
Section titled “Returns”PDFAttachment | undefined
getAttachments()
Section titled “getAttachments()”getAttachments():
PDFAttachment[]
Defined in: src/document/native-document.ts:330
Get all attachments.
Returns
Section titled “Returns”getBookmarks()
Section titled “getBookmarks()”getBookmarks():
Bookmark[]
Defined in: src/document/native-document.ts:207
Get the bookmark (outline) tree for this document.
Returns an array of top-level bookmarks, each with nested children. Returns an empty array if the document has no bookmarks.
For large bookmark trees, prefer the lazy bookmarks generator.
Returns
Section titled “Returns”Bookmark[]
getMetadata()
Section titled “getMetadata()”getMetadata():
DocumentMetadata
Defined in: src/document/native-document.ts:116
Get all standard metadata fields.
Returns
Section titled “Returns”getMetaText()
Section titled “getMetaText()”getMetaText(
tag):string|undefined
Defined in: src/document/native-document.ts:149
Get a specific metadata field by tag name.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
tag | string |
Returns
Section titled “Returns”string | undefined
getPage()
Section titled “getPage()”getPage(
pageIndex):NativePDFiumPage
Defined in: src/document/native-document.ts:78
Load a specific page from the document.
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
pageIndex | number | Zero-based page index |
Returns
Section titled “Returns”The loaded page
getPageLabel()
Section titled “getPageLabel()”getPageLabel(
pageIndex):string|undefined
Defined in: src/document/native-document.ts:192
Get the label for a specific page.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
pageIndex | number |
Returns
Section titled “Returns”string | undefined
getSignature()
Section titled “getSignature()”getSignature(
index):PDFSignature|undefined
Defined in: src/document/native-document.ts:249
Get a digital signature by index.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
index | number |
Returns
Section titled “Returns”PDFSignature | undefined
getSignatures()
Section titled “getSignatures()”getSignatures():
PDFSignature[]
Defined in: src/document/native-document.ts:276
Get all digital signatures.
Returns
Section titled “Returns”hasSignatures()
Section titled “hasSignatures()”hasSignatures():
boolean
Defined in: src/document/native-document.ts:244
Check if this document has digital signatures.
Returns
Section titled “Returns”boolean
importPages()
Section titled “importPages()”importPages(
source,options):void
Defined in: src/document/native-document.ts:350
Import pages from a source document.
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
source | NativePDFiumDocument | Source document to import from |
options | ImportPagesOptions | Import options (pageRange, insertIndex) |
Returns
Section titled “Returns”void
importPagesByIndex()
Section titled “importPagesByIndex()”importPagesByIndex(
source,pageIndices,insertIndex?):void
Defined in: src/document/native-document.ts:367
Import pages by index array.
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
source | NativePDFiumDocument | Source document to import from |
pageIndices | readonly number[] | Zero-based page indices |
insertIndex? | number | Insertion point (default: end) |
Returns
Section titled “Returns”void
isTagged()
Section titled “isTagged()”isTagged():
boolean
Defined in: src/document/native-document.ts:186
Check if the document is tagged (accessible).
Returns
Section titled “Returns”boolean
pages()
Section titled “pages()”pages():
IterableIterator<NativePDFiumPage>
Defined in: src/document/native-document.ts:106
Iterate over all pages in the document.
Each page is yielded and must be disposed by the caller.
Returns
Section titled “Returns”IterableIterator<NativePDFiumPage>
save()
Section titled “save()”save(
options):Uint8Array
Defined in: src/document/native-document.ts:296
Save the document to a byte array.
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
options | SaveOptions | Save options (flags, version). |
Returns
Section titled “Returns”Uint8Array
The serialised PDF bytes.