IDocumentReader
Defined in: src/core/interfaces.ts:34
Interface for reading PDF documents.
Extends
Section titled “Extends”Disposable
Properties
Section titled “Properties”attachmentCount
Section titled “attachmentCount”
readonlyattachmentCount:number
Defined in: src/core/interfaces.ts:72
Get the number of attachments.
fileVersion
Section titled “fileVersion”
readonlyfileVersion:number|undefined
Defined in: src/core/interfaces.ts:57
Get the PDF file version.
pageCount
Section titled “pageCount”
readonlypageCount:number
Defined in: src/core/interfaces.ts:36
Get the number of pages in the document.
pageMode
Section titled “pageMode”
readonlypageMode:PageMode
Defined in: src/core/interfaces.ts:39
Get the document’s initial page mode.
rawPermissions
Section titled “rawPermissions”
readonlyrawPermissions:number
Defined in: src/core/interfaces.ts:42
Get the raw document permissions bitmask.
securityHandlerRevision
Section titled “securityHandlerRevision”
readonlysecurityHandlerRevision:number
Defined in: src/core/interfaces.ts:45
Get the security handler revision.
Methods
Section titled “Methods”[dispose]()
Section titled “[dispose]()”[dispose]():
void
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.esnext.disposable.d.ts:36
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”Disposable.[dispose]
attachments()
Section titled “attachments()”attachments():
IterableIterator<PDFAttachment>
Defined in: src/core/interfaces.ts:78
Iterate over attachments.
Returns
Section titled “Returns”IterableIterator<PDFAttachment>
bookmarks()
Section titled “bookmarks()”bookmarks():
IterableIterator<Bookmark>
Defined in: src/core/interfaces.ts:69
Iterate over bookmarks.
Returns
Section titled “Returns”IterableIterator<Bookmark>
getAttachment()
Section titled “getAttachment()”getAttachment(
index):PDFAttachment
Defined in: src/core/interfaces.ts:75
Get an attachment by index.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
index | number |
Returns
Section titled “Returns”getAttachments()
Section titled “getAttachments()”getAttachments():
PDFAttachment[]
Defined in: src/core/interfaces.ts:81
Get all attachments.
Returns
Section titled “Returns”getBookmarks()
Section titled “getBookmarks()”getBookmarks():
Bookmark[]
Defined in: src/core/interfaces.ts:66
Get the bookmark tree.
Returns
Section titled “Returns”Bookmark[]
getMetadata()
Section titled “getMetadata()”getMetadata():
DocumentMetadata
Defined in: src/core/interfaces.ts:51
Get all standard metadata fields.
Returns
Section titled “Returns”getMetaText()
Section titled “getMetaText()”getMetaText(
tag):string|undefined
Defined in: src/core/interfaces.ts:54
Get a specific metadata field.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
tag | string |
Returns
Section titled “Returns”string | undefined
getNamedDestinationByName()
Section titled “getNamedDestinationByName()”getNamedDestinationByName(
name):NamedDestination|undefined
Defined in: src/core/interfaces.ts:87
Get a named destination by name.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
name | string |
Returns
Section titled “Returns”NamedDestination | undefined
getNamedDestinations()
Section titled “getNamedDestinations()”getNamedDestinations():
NamedDestination[]
Defined in: src/core/interfaces.ts:84
Get all named destinations.
Returns
Section titled “Returns”getPage()
Section titled “getPage()”getPage(
pageIndex):IPageReader
Defined in: src/core/interfaces.ts:60
Load a specific page.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
pageIndex | number |
Returns
Section titled “Returns”getPermissions()
Section titled “getPermissions()”getPermissions():
DocumentPermissions
Defined in: src/core/interfaces.ts:48
Get structured document permissions with named boolean fields.
Returns
Section titled “Returns”pages()
Section titled “pages()”pages():
IterableIterator<IPageReader>
Defined in: src/core/interfaces.ts:63
Iterate over all pages.
Returns
Section titled “Returns”IterableIterator<IPageReader>
save()
Section titled “save()”save(
options?):Uint8Array
Defined in: src/core/interfaces.ts:90
Save the document.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
options? | SaveOptions |
Returns
Section titled “Returns”Uint8Array