Class PdfDocument

Represents a PDF document with support for reading, writing, and modifying PDF files. Handles document structure, revisions, encryption, and digital signatures.

Example

// Create a new document
const document = new PdfDocument()

// Read from bytes
const document = await PdfDocument.fromBytes(fileBytes)

// Add objects and commit
document.add(pdfObject)
await document.commit()

Hierarchy (View Summary)

PdfObject
- PdfDocument

Constructors

constructor

new PdfDocument(
    options?: {
        ownerPassword?: string;
        password?: string;
        revisions?: PdfRevision[];
        securityHandler?: PdfSecurityHandler;
        signer?: PdfSigner;
        version?: string | PdfComment;
    },
): PdfDocument
Creates a new PDF document instance.
Parameters
- Optionaloptions: {
      ownerPassword?: string;
      password?: string;
      revisions?: PdfRevision[];
      securityHandler?: PdfSecurityHandler;
      signer?: PdfSigner;
      version?: string | PdfComment;
  }
  Configuration options for the document
  - OptionalownerPassword?: string
    Owner password for encryption
  - Optionalpassword?: string
    User password for encryption
  - Optionalrevisions?: PdfRevision[]
    Pre-existing revisions for the document
  - OptionalsecurityHandler?: PdfSecurityHandler
    Custom security handler for encryption
  - Optionalsigner?: PdfSigner
    Custom signer for digital signatures
  - Optionalversion?: string | PdfComment
    PDF version string (e.g., '1.7', '2.0') or version comment
Returns PdfDocument
Overrides PdfObject.constructor
- Defined in packages/pdf-lite/src/pdf/pdf-document.ts:76

Properties

header: PdfComment = ...

PDF version comment header

`Protected`modified

modified: boolean = true

Indicates whether the object has been modified. By default, assume it has been modified because it's a new object

`Optional`postTokens

postTokens?: PdfToken[]

Optional tokens to prepend or append during serialization

`Optional`preTokens

preTokens?: PdfToken[]

Optional tokens to prepend or append during serialization

revisions

revisions: PdfRevision[]

List of document revisions for incremental updates

`Optional`securityHandler

securityHandler?: PdfSecurityHandler

Security handler for encryption/decryption operations

signer

signer: PdfSigner

Signer instance for digital signature operations

Accessors

encryptionDictionary

get encryptionDictionary(): PdfEncryptionDictionaryObject | undefined
Gets the encryption dictionary from the document if present.

Returns PdfEncryptionDictionaryObject | undefined
The encryption dictionary object or undefined if not encrypted

Throws
Error if the encryption dictionary reference points to a non-dictionary object
- Defined in packages/pdf-lite/src/pdf/pdf-document.ts:241

latestRevision

get latestRevision(): PdfRevision
Gets the latest (most recent) revision of the document.

Returns PdfRevision
The latest PdfRevision

Throws
Error if the revision for the last StartXRef cannot be found
- Defined in packages/pdf-lite/src/pdf/pdf-document.ts:186

metadataStreamReference

get metadataStreamReference(): PdfObjectReference | undefined
Gets the reference to the metadata stream from the document catalog.

Returns PdfObjectReference | undefined
The metadata stream reference or undefined if not present
- Defined in packages/pdf-lite/src/pdf/pdf-document.ts:293

objects

get objects(): readonly PdfObject[]
Gets all objects across all revisions in the document.

Returns readonly PdfObject[]
A readonly array of all PDF objects
- Defined in packages/pdf-lite/src/pdf/pdf-document.ts:231

objectType

get objectType(): string
The type of this PDF object

Returns string
Inherited from PdfObject.objectType
- Defined in packages/pdf-lite/src/core/objects/pdf-object.ts:17

rootDictionary

get rootDictionary(): PdfDictionary<PdfDictionaryEntries> | undefined
Gets the document catalog (root) dictionary.

Returns PdfDictionary<PdfDictionaryEntries> | undefined
The root dictionary or undefined if not found

Throws
Error if the Root reference points to a non-dictionary object
- Defined in packages/pdf-lite/src/pdf/pdf-document.ts:270

trailerDict

get trailerDict(): PdfDictionary<PdfTrailerEntries>
Gets the trailer dictionary from the cross-reference lookup.

Returns PdfDictionary<PdfTrailerEntries>
The trailer dictionary containing document metadata references
- Defined in packages/pdf-lite/src/pdf/pdf-document.ts:222

xrefLookup

get xrefLookup(): PdfXrefLookup
Gets the cross-reference lookup table for the latest revision.

Returns PdfXrefLookup
The PdfXrefLookup for the latest revision
- Defined in packages/pdf-lite/src/pdf/pdf-document.ts:213

Methods

add

add(...objects: PdfObject[]): void
Adds objects to the document's latest revision. Automatically starts a new revision if the current one is locked.
Parameters
- ...objects: PdfObject[]
  PDF objects to add to the document
Returns void
- Defined in packages/pdf-lite/src/pdf/pdf-document.ts:169

as

as<T extends PdfObject>(ctor: new (...args: any[]) => T): T
Attempts to cast the object to a specific PdfObject subclass
Type Parameters
- T extends PdfObject
Parameters
- ctor: new (...args: any[]) => T
Returns T
Inherited from PdfObject.as
- Defined in packages/pdf-lite/src/core/objects/pdf-object.ts:65

clone

clone(): this
Creates a deep copy of the document.

Returns this
A cloned PdfDocument instance
Overrides PdfObject.clone
- Defined in packages/pdf-lite/src/pdf/pdf-document.ts:898

commit

commit(...newObjects: PdfObject[]): Promise<void>
Commits pending objects to the document. Adds objects, applies encryption if configured, and updates the document structure.
Parameters
- ...newObjects: PdfObject[]
  Additional objects to add before committing
Returns Promise<void>
- Defined in packages/pdf-lite/src/pdf/pdf-document.ts:703

decrypt

decrypt(): Promise<void>
Decrypts all encrypted objects in the document. Removes the security handler and encryption dictionary after decryption.

Returns Promise<void>
- Defined in packages/pdf-lite/src/pdf/pdf-document.ts:427

deleteObject

deleteObject(obj: PdfObject | undefined): Promise<void>
Deletes an object from all revisions in the document.
Parameters
- obj: PdfObject | undefined
  The PDF object to delete
Returns Promise<void>
- Defined in packages/pdf-lite/src/pdf/pdf-document.ts:650

encrypt

encrypt(): Promise<void>
Encrypts all objects in the document using the security handler. Creates and adds an encryption dictionary to all revisions.

Returns Promise<void>
- Defined in packages/pdf-lite/src/pdf/pdf-document.ts:460

equals

equals(other?: PdfObject): boolean
Compares this object to another for equality based on their token representations
Parameters
- Optionalother: PdfObject
Returns boolean
Inherited from PdfObject.equals
- Defined in packages/pdf-lite/src/core/objects/pdf-object.ts:79

findCompressedObject

findCompressedObject(
    options:
        | PdfObjectReference
        | { generationNumber?: number; objectNumber: number },
): Promise<PdfIndirectObject<PdfObject> | undefined>
Finds a compressed object by its object number within an object stream.
Parameters
- options: PdfObjectReference | { generationNumber?: number; objectNumber: number }
  Object identifier with objectNumber and optional generationNumber
Returns Promise<PdfIndirectObject<PdfObject> | undefined>
The found indirect object or undefined if not found

Throws
Error if the object cannot be found in the expected object stream
- Defined in packages/pdf-lite/src/pdf/pdf-document.ts:509

findUncompressedObject

findUncompressedObject(
    options:
        | PdfObjectReference
        | { generationNumber?: number; objectNumber: number },
): PdfIndirectObject<PdfObject> | undefined
Finds an uncompressed indirect object by its object number.
Parameters
- options: PdfObjectReference | { generationNumber?: number; objectNumber: number }
  Object identifier with objectNumber and optional generationNumber
Returns PdfIndirectObject<PdfObject> | undefined
The found indirect object or undefined if not found

Throws
FoundCompressedObjectError if the object is compressed (in an object stream)
- Defined in packages/pdf-lite/src/pdf/pdf-document.ts:560

hasObject

hasObject(obj: PdfObject): boolean
Checks if a PDF object exists in the document.
Parameters
- obj: PdfObject
  The PDF object to check
Returns boolean
True if the object exists in the document
- Defined in packages/pdf-lite/src/pdf/pdf-document.ts:396

isIncremental

isIncremental(): boolean
Checks if the document is in incremental mode.

Returns boolean
True if all revisions are locked for incremental updates
- Defined in packages/pdf-lite/src/pdf/pdf-document.ts:693

isModified

isModified(): boolean
Indicates whether the object has been modified. Override this method if the modified state is determined differently

Returns boolean
Overrides PdfObject.isModified
- Defined in packages/pdf-lite/src/pdf/pdf-document.ts:919

readObject

readObject(
    options: {
        allowUnindexed?: boolean;
        generationNumber?: number;
        objectNumber: number;
    },
): Promise<PdfIndirectObject<PdfObject> | undefined>
Reads and optionally decrypts an object by its object number. Handles both compressed and uncompressed objects.
Parameters
- options: { allowUnindexed?: boolean; generationNumber?: number; objectNumber: number }
  Object lookup options
  - OptionalallowUnindexed?: boolean
    If true, searches unindexed objects as fallback
  - OptionalgenerationNumber?: number
    Optional generation number filter
  - objectNumber: number
    The object number to find
Returns Promise<PdfIndirectObject<PdfObject> | undefined>
A cloned and decrypted copy of the object, or undefined if not found
- Defined in packages/pdf-lite/src/pdf/pdf-document.ts:604

setDocumentSecurityStore

setDocumentSecurityStore(dss: PdfDocumentSecurityStoreObject): Promise<void>
Sets the Document Security Store (DSS) for the document. Used for long-term validation of digital signatures.
Parameters
- dss: PdfDocumentSecurityStoreObject
  The Document Security Store object to set
Returns Promise<void>
Throws
Error if the document has no root dictionary
- Defined in packages/pdf-lite/src/pdf/pdf-document.ts:745

setIncremental

setIncremental(value: boolean): void
Sets whether the document should use incremental updates. When true, locks all existing revisions to preserve original content.
Parameters
- value: boolean
  True to enable incremental mode, false to disable
Returns void
- Defined in packages/pdf-lite/src/pdf/pdf-document.ts:682

setModified

setModified(modified?: boolean): void
Sets the modified state of the object. Override this method if the modified state is determined differently
Parameters
- modified: boolean = true
Returns void
Inherited from PdfObject.setModified
- Defined in packages/pdf-lite/src/core/objects/pdf-object.ts:27

setOwnerPassword

setOwnerPassword(ownerPassword: string): void
Sets the owner password for document encryption.
Parameters
- ownerPassword: string
  The owner password to set
Returns void
Throws
Error if the security handler doesn't support password setting
- Defined in packages/pdf-lite/src/pdf/pdf-document.ts:378

setPassword

setPassword(password: string): void
Sets the user password for document encryption.
Parameters
- password: string
  The user password to set
Returns void
Throws
Error if the security handler doesn't support password setting
- Defined in packages/pdf-lite/src/pdf/pdf-document.ts:360

setVersion

setVersion(version: string): void
Sets the PDF version for the document.
Parameters
- version: string
  The PDF version string (e.g., '1.7', '2.0')
Returns void
Throws
Error if attempting to change version after objects have been added in incremental mode
- Defined in packages/pdf-lite/src/pdf/pdf-document.ts:666

startNewRevision

startNewRevision(): PdfDocument
Starts a new revision for incremental updates. Creates a new revision linked to the previous one.

Returns PdfDocument
The document instance for method chaining
- Defined in packages/pdf-lite/src/pdf/pdf-document.ts:149

toBytes

toBytes(): ByteArray
Serializes the document to a byte array.

Returns ByteArray
The PDF document as a Uint8Array
Overrides PdfObject.toBytes
- Defined in packages/pdf-lite/src/pdf/pdf-document.ts:885

`Protected`tokenize

tokenize(): PdfToken[]
Tokenizes the object into an array of PdfTokens

Returns PdfToken[]
Overrides PdfObject.tokenize
- Defined in packages/pdf-lite/src/pdf/pdf-document.ts:792

tokensWithObjects

tokensWithObjects(): { object: PdfObject | undefined; token: PdfToken }[]
Returns tokens paired with their source objects. Useful for debugging and analysis of document structure.

Returns { object: PdfObject | undefined; token: PdfToken }[]
Array of token-object pairs
- Defined in packages/pdf-lite/src/pdf/pdf-document.ts:765

toString

toString(): string
Converts the object to a string representation

Returns string
Inherited from PdfObject.toString
- Defined in packages/pdf-lite/src/core/objects/pdf-object.ts:56

toTokens

toTokens(): PdfToken[]
Converts the object to an array of PdfTokens, including any pre or post tokens

Returns PdfToken[]
Inherited from PdfObject.toTokens
- Defined in packages/pdf-lite/src/core/objects/pdf-object.ts:32

`Static`fromBytes

fromBytes(
    input:
        | Iterable<ByteArray, any, any>
        | AsyncIterable<ByteArray, any, any>,
): Promise<PdfDocument>
Creates a PdfDocument from a byte stream.
Parameters
- input: Iterable<ByteArray, any, any> | AsyncIterable<ByteArray, any, any>
  Async or sync iterable of byte arrays
Returns Promise<PdfDocument>
A promise that resolves to the parsed PdfDocument
- Defined in packages/pdf-lite/src/pdf/pdf-document.ts:913

`Static`fromObjects

fromObjects(objects: PdfObject[]): PdfDocument
Creates a PdfDocument from an array of PDF objects. Parses objects into revisions based on EOF comments.
Parameters
- objects: PdfObject[]
  Array of PDF objects to construct the document from
Returns PdfDocument
A new PdfDocument instance
- Defined in packages/pdf-lite/src/pdf/pdf-document.ts:118

Class PdfDocument

Example

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

OptionalownerPassword?: string

Optionalpassword?: string

Optionalrevisions?: PdfRevision[]

OptionalsecurityHandler?: PdfSecurityHandler

Optionalsigner?: PdfSigner

Optionalversion?: string | PdfComment

Returns PdfDocument

Properties

header

Protectedmodified

OptionalpostTokens

OptionalpreTokens

revisions

OptionalsecurityHandler

signer

Accessors

encryptionDictionary

Returns PdfEncryptionDictionaryObject | undefined

Throws

latestRevision

Returns PdfRevision

Throws

metadataStreamReference

Returns PdfObjectReference | undefined

objects

Returns readonly PdfObject[]

objectType

Returns string

rootDictionary

Returns PdfDictionary<PdfDictionaryEntries> | undefined

Throws

trailerDict

Returns PdfDictionary<PdfTrailerEntries>

xrefLookup

Returns PdfXrefLookup

Methods

add

Parameters

Returns void

as

Type Parameters

Parameters

Returns T

clone

Returns this

commit

Parameters

Returns Promise<void>

decrypt

Returns Promise<void>

deleteObject

Parameters

Returns Promise<void>

encrypt

Returns Promise<void>

equals

Parameters

Returns boolean

findCompressedObject

Parameters

Returns Promise<PdfIndirectObject<PdfObject> | undefined>

Throws

findUncompressedObject

Parameters

Returns PdfIndirectObject<PdfObject> | undefined

Throws

hasObject

Parameters

Returns boolean

`Optional`ownerPassword?: string

`Optional`password?: string

`Optional`revisions?: PdfRevision[]

`Optional`securityHandler?: PdfSecurityHandler

`Optional`signer?: PdfSigner

`Optional`version?: string | PdfComment

`Protected`modified

`Optional`postTokens

`Optional`preTokens

`Optional`securityHandler

`Optional`allowUnindexed?: boolean

`Optional`generationNumber?: number

`Protected`tokenize

`Static`fromBytes

`Static`fromObjects