happypdf / PDFWriter

Class: PDFWriter

Defined in: src/core/writers/PDFWriter.ts:32

Extended by

• PDFStreamWriter

Constructors

Constructor

protected new PDFWriter(
   context, 
   objectsPerTick, 
   snapshot): PDFWriter;

Defined in: src/core/writers/PDFWriter.ts:48

Parameters

Parameter	Type
context	PDFContext
objectsPerTick	number
snapshot	DocumentSnapshot

Returns

PDFWriter

Properties

_largestSkippedObjectNum

protected _largestSkippedObjectNum: number = 0;

Defined in: src/core/writers/PDFWriter.ts:63

If PDF has an XRef Stream, then the last object will be probably be skipped on saving. If that's the case, this property will have that object number, and the PDF /Size can be corrected, to be accurate.

---

_lastXRefObjectNumber

protected _lastXRefObjectNumber: number = 0;

Defined in: src/core/writers/PDFWriter.ts:69

Used to check wheter an object should be saved or not, preserves the object number of the last XRef Stream object, if there is one.

---

context

protected readonly context: PDFContext;

Defined in: src/core/writers/PDFWriter.ts:42

---

objectsPerTick

protected readonly objectsPerTick: number;

Defined in: src/core/writers/PDFWriter.ts:44

---

snapshot

protected readonly snapshot: DocumentSnapshot;

Defined in: src/core/writers/PDFWriter.ts:45

Methods

computeBufferSize()

protected computeBufferSize(incremental): Promise<SerializationInfo>;

Defined in: src/core/writers/PDFWriter.ts:213

Parameters

Parameter	Type
incremental	boolean

Returns

Promise<SerializationInfo>

---

computeIndirectObjectSize()

protected computeIndirectObjectSize(__namedParameters): number;

Defined in: src/core/writers/PDFWriter.ts:184

Parameters

Parameter	Type
__namedParameters	[PDFRef, PDFObject]

Returns

number

---

createTrailerDict()

protected createTrailerDict(prevStartXRef?): PDFDict;

Defined in: src/core/writers/PDFWriter.ts:193

Parameters

Parameter	Type
prevStartXRef?	number

Returns

PDFDict

---

encrypt()

protected encrypt(
   ref, 
   object, 
   security): void;

Defined in: src/core/writers/PDFWriter.ts:276

Parameters

Parameter	Type
ref	PDFRef
object	PDFObject
security	PDFSecurity

Returns

void

---

forContext()

static forContext(context, objectsPerTick): PDFWriter;

Defined in: src/core/writers/PDFWriter.ts:33

Parameters

Parameter	Type
context	PDFContext
objectsPerTick	number

Returns

PDFWriter

---

forContextWithSnapshot()

static forContextWithSnapshot(
   context, 
   objectsPerTick, 
   snapshot): PDFWriter;

Defined in: src/core/writers/PDFWriter.ts:36

Parameters

Parameter	Type
context	PDFContext
objectsPerTick	number
snapshot	DocumentSnapshot

Returns

PDFWriter

---

serializeToBuffer()

serializeToBuffer(): Promise<Uint8Array<ArrayBuffer>>;

Defined in: src/core/writers/PDFWriter.ts:114

Returns

Promise<Uint8Array<ArrayBuffer>>

---

shouldSave()

protected shouldSave(
   incremental, 
   objNum, 
   objects): boolean;

Defined in: src/core/writers/PDFWriter.ts:78

For incremental saves, defers the decision to the snapshot. For full saves, checks that the object is not the last XRef stream object.

Parameters

Parameter	Type	Description
incremental	boolean	If making an incremental save, or a full save of the PDF
objNum	number	Object number
objects	[PDFRef, PDFObject][]	List of objects that form the PDF

Returns

boolean

whether the object should be saved or not

---

shouldSkipCopiedObjectStream()

protected shouldSkipCopiedObjectStream(object): boolean;

Defined in: src/core/writers/PDFWriter.ts:288

Parameters

Parameter	Type
object	PDFObject

Returns

boolean

---

shouldWaitForTick()

protected shouldWaitForTick(n): boolean;

Defined in: src/core/writers/PDFWriter.ts:295

Parameters

Parameter	Type
n	number

Returns

boolean