Skip to content

happypdf / IncrementalDocumentSnapshot

Class: IncrementalDocumentSnapshot ​

Defined in: src/api/snapshot/IncrementalDocumentSnapshot.ts:4

Implements ​

Constructors ​

Constructor ​

ts
new IncrementalDocumentSnapshot(
   lastObjectNumber, 
   indirectObjects, 
   pdfSize, 
   prevStartXRef, 
   context): IncrementalDocumentSnapshot;

Defined in: src/api/snapshot/IncrementalDocumentSnapshot.ts:15

Parameters ​

ParameterType
lastObjectNumbernumber
indirectObjectsSet<number>
pdfSizenumber
prevStartXRefnumber
contextPDFContext

Returns ​

IncrementalDocumentSnapshot

Properties ​

context ​

ts
context: PDFContext;

Defined in: src/api/snapshot/IncrementalDocumentSnapshot.ts:13


deletedCount ​

ts
deletedCount: number = 0;

Defined in: src/api/snapshot/IncrementalDocumentSnapshot.ts:7

Implementation of ​

DocumentSnapshot.deletedCount


pdfSize ​

ts
pdfSize: number;

Defined in: src/api/snapshot/IncrementalDocumentSnapshot.ts:5

Implementation of ​

DocumentSnapshot.pdfSize


prevStartXRef ​

ts
prevStartXRef: number;

Defined in: src/api/snapshot/IncrementalDocumentSnapshot.ts:6

Implementation of ​

DocumentSnapshot.prevStartXRef

Methods ​

deletedRef() ​

ts
deletedRef(index): PDFRef | null;

Defined in: src/api/snapshot/IncrementalDocumentSnapshot.ts:70

Parameters ​

ParameterType
indexnumber

Returns ​

PDFRef | null

Implementation of ​

DocumentSnapshot.deletedRef


markDeletedObj() ​

ts
markDeletedObj(obj): void;

Defined in: src/api/snapshot/IncrementalDocumentSnapshot.ts:65

Parameters ​

ParameterType
objPDFObject

Returns ​

void

Implementation of ​

DocumentSnapshot.markDeletedObj


markDeletedRef() ​

ts
markDeletedRef(ref): void;

Defined in: src/api/snapshot/IncrementalDocumentSnapshot.ts:56

Parameters ​

ParameterType
refPDFRef

Returns ​

void

Implementation of ​

DocumentSnapshot.markDeletedRef


markObjForSave() ​

ts
markObjForSave(obj): void;

Defined in: src/api/snapshot/IncrementalDocumentSnapshot.ts:44

Parameters ​

ParameterType
objPDFObject

Returns ​

void

Implementation of ​

DocumentSnapshot.markObjForSave


markObjsForSave() ​

ts
markObjsForSave(objs): void;

Defined in: src/api/snapshot/IncrementalDocumentSnapshot.ts:48

Parameters ​

ParameterType
objsPDFObject[]

Returns ​

void

Implementation of ​

DocumentSnapshot.markObjsForSave


markRefForSave() ​

ts
markRefForSave(ref): void;

Defined in: src/api/snapshot/IncrementalDocumentSnapshot.ts:34

Parameters ​

ParameterType
refPDFRef

Returns ​

void

Implementation of ​

DocumentSnapshot.markRefForSave


markRefsForSave() ​

ts
markRefsForSave(refs): void;

Defined in: src/api/snapshot/IncrementalDocumentSnapshot.ts:38

Parameters ​

ParameterType
refsPDFRef[]

Returns ​

void

Implementation of ​

DocumentSnapshot.markRefsForSave


shouldSave() ​

ts
shouldSave(objectNumber): boolean;

Defined in: src/api/snapshot/IncrementalDocumentSnapshot.ts:29

Parameters ​

ParameterType
objectNumbernumber

Returns ​

boolean

Implementation of ​

DocumentSnapshot.shouldSave

MIT Licensed. A fork of pdf-lib.