happypdf / PDFStreamWriter

Class: PDFStreamWriter

Defined in: src/core/writers/PDFStreamWriter.ts:21

Extends

• 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.

Inherited from

PDFWriter._largestSkippedObjectNum

---

_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.

Inherited from

PDFWriter._lastXRefObjectNumber

---

context

protected readonly context: PDFContext;

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

Inherited from

PDFWriter.context

---

objectsPerTick

protected readonly objectsPerTick: number;

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

Inherited from

PDFWriter.objectsPerTick

---

snapshot

protected readonly snapshot: DocumentSnapshot;

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

Inherited from

PDFWriter.snapshot

Methods

computeBufferSize()

protected computeBufferSize(incremental): Promise<{
  header: PDFHeader;
  indirectObjects: [PDFRef, PDFObject][];
  size: number;
  trailer: PDFTrailer;
}>;

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

Parameters

Parameter	Type
incremental	boolean

Returns

Promise<{ header: PDFHeader; indirectObjects: [PDFRef, PDFObject][]; size: number; trailer: PDFTrailer; }>

Overrides

PDFWriter.computeBufferSize

---

computeIndirectObjectSize()

protected computeIndirectObjectSize(__namedParameters): number;

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

Parameters

Parameter	Type
__namedParameters	[PDFRef, PDFObject]

Returns

number

Inherited from

PDFWriter.computeIndirectObjectSize

---

createTrailerDict()

protected createTrailerDict(prevStartXRef?): PDFDict;

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

Parameters

Parameter	Type
prevStartXRef?	number

Returns

PDFDict

Inherited from

PDFWriter.createTrailerDict

---

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

Inherited from

PDFWriter.encrypt

---

forContext()

static forContext(
   context, 
   objectsPerTick, 
   encodeStreams?, 
   objectsPerStream?): PDFStreamWriter;

Defined in: src/core/writers/PDFStreamWriter.ts:22

Parameters

Parameter	Type	Default value
context	PDFContext	undefined
objectsPerTick	number	undefined
encodeStreams	boolean	true
objectsPerStream	number	50

Returns

PDFStreamWriter

Overrides

PDFWriter.forContext

---

forContextWithSnapshot()

static forContextWithSnapshot(
   context, 
   objectsPerTick, 
   snapshot, 
   encodeStreams?, 
   objectsPerStream?): PDFStreamWriter;

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

Parameters

Parameter	Type	Default value
context	PDFContext	undefined
objectsPerTick	number	undefined
snapshot	DocumentSnapshot	undefined
encodeStreams	boolean	true
objectsPerStream	number	50

Returns

PDFStreamWriter

Overrides

PDFWriter.forContextWithSnapshot

---

serializeToBuffer()

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

Defined in: src/core/writers/PDFStreamWriter.ts:199

Returns

Promise<Uint8Array<ArrayBuffer>>

Overrides

PDFWriter.serializeToBuffer

---

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

Inherited from

PDFWriter.shouldSave

---

shouldSkipCopiedObjectStream()

protected shouldSkipCopiedObjectStream(object): boolean;

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

Parameters

Parameter	Type
object	PDFObject

Returns

boolean

Inherited from

PDFWriter.shouldSkipCopiedObjectStream

---

shouldWaitForTick()

protected shouldWaitForTick(n): boolean;

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

Parameters

Parameter	Type
n	number

Returns

boolean

Inherited from

PDFWriter.shouldWaitForTick