happypdf / PDFObjectStream

Class: PDFObjectStream

Defined in: src/core/structures/PDFObjectStream.ts:12

Extends

• PDFFlateStream

Properties

contentsCache

protected contentsCache: Cache<Uint8Array<ArrayBufferLike>>;

Defined in: src/core/structures/PDFFlateStream.ts:10

Inherited from

PDFFlateStream.contentsCache

---

dict

readonly dict: PDFDict;

Defined in: src/core/objects/PDFStream.ts:10

Inherited from

PDFFlateStream.dict

---

encode

protected readonly encode: boolean;

Defined in: src/core/structures/PDFFlateStream.ts:11

Inherited from

PDFFlateStream.encode

Methods

clone()

clone(context?): PDFObjectStream;

Defined in: src/core/structures/PDFObjectStream.ts:43

Parameters

Parameter	Type
context?	PDFContext

Returns

PDFObjectStream

Overrides

PDFFlateStream.clone

---

computeContents()

computeContents(): Uint8Array;

Defined in: src/core/structures/PDFFlateStream.ts:22

Returns

Uint8Array

Inherited from

PDFFlateStream.computeContents

---

copyBytesInto()

copyBytesInto(buffer, offset): number;

Defined in: src/core/objects/PDFStream.ts:65

Parameters

Parameter	Type
buffer	Uint8Array
offset	number

Returns

number

Inherited from

PDFFlateStream.copyBytesInto

---

getContents()

getContents(): Uint8Array;

Defined in: src/core/structures/PDFFlateStream.ts:27

Returns

Uint8Array

Inherited from

PDFFlateStream.getContents

---

getContentsSize()

getContentsSize(): number;

Defined in: src/core/structures/PDFFlateStream.ts:31

Returns

number

Inherited from

PDFFlateStream.getContentsSize

---

getContentsString()

getContentsString(): string;

Defined in: src/core/structures/PDFObjectStream.ts:51

Returns

string

Overrides

PDFFlateStream.getContentsString

---

getObjectsCount()

getObjectsCount(): number;

Defined in: src/core/structures/PDFObjectStream.ts:39

Returns

number

---

getUnencodedContents()

getUnencodedContents(): Uint8Array;

Defined in: src/core/structures/PDFObjectStream.ts:60

Returns

Uint8Array

Overrides

PDFFlateStream.getUnencodedContents

---

getUnencodedContentsSize()

getUnencodedContentsSize(): number;

Defined in: src/core/structures/PDFObjectStream.ts:71

Returns

number

---

registerChange()

registerChange(): void;

Defined in: src/core/objects/PDFObject.ts:5

Returns

void

Inherited from

PDFFlateStream.registerChange

---

sizeInBytes()

sizeInBytes(): number;

Defined in: src/core/objects/PDFStream.ts:51

Returns

number

Inherited from

PDFFlateStream.sizeInBytes

---

toString()

toString(): string;

Defined in: src/core/objects/PDFStream.ts:56

Returns

string

Inherited from

PDFFlateStream.toString

---

updateContents()

updateContents(contents): void;

Defined in: src/core/structures/PDFFlateStream.ts:42

Parameters

Parameter	Type
contents	Uint8Array

Returns

void

Inherited from

PDFFlateStream.updateContents

---

updateDict()

updateDict(): void;

Defined in: src/core/objects/PDFStream.ts:46

Returns

void

Inherited from

PDFFlateStream.updateDict

---

withContextAndObjects()

static withContextAndObjects(
   context, 
   objects, 
   encode?): PDFObjectStream;

Defined in: src/core/structures/PDFObjectStream.ts:13

Parameters

Parameter	Type	Default value
context	PDFContext	undefined
objects	IndirectObject[]	undefined
encode	boolean	true

Returns

PDFObjectStream