Skip to content

happypdf / PDFFlateStream

Class: PDFFlateStream ​

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

Extends ​

Extended by ​

Constructors ​

Constructor ​

ts
new PDFFlateStream(dict, encode): PDFFlateStream;

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

Parameters ​

ParameterType
dictPDFDict
encodeboolean

Returns ​

PDFFlateStream

Overrides ​

PDFStream.constructor

Properties ​

contentsCache ​

ts
protected contentsCache: Cache<Uint8Array<ArrayBufferLike>>;

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


dict ​

ts
readonly dict: PDFDict;

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

Inherited from ​

PDFStream.dict


encode ​

ts
protected readonly encode: boolean;

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

Methods ​

clone() ​

ts
clone(_context?): PDFStream;

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

Parameters ​

ParameterType
_context?PDFContext

Returns ​

PDFStream

Inherited from ​

PDFStream.clone


computeContents() ​

ts
computeContents(): Uint8Array;

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

Returns ​

Uint8Array


copyBytesInto() ​

ts
copyBytesInto(buffer, offset): number;

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

Parameters ​

ParameterType
bufferUint8Array
offsetnumber

Returns ​

number

Inherited from ​

PDFStream.copyBytesInto


getContents() ​

ts
getContents(): Uint8Array;

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

Returns ​

Uint8Array

Overrides ​

PDFStream.getContents


getContentsSize() ​

ts
getContentsSize(): number;

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

Returns ​

number

Overrides ​

PDFStream.getContentsSize


getContentsString() ​

ts
getContentsString(): string;

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

Returns ​

string

Inherited from ​

PDFStream.getContentsString


getUnencodedContents() ​

ts
getUnencodedContents(): Uint8Array;

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

Returns ​

Uint8Array


registerChange() ​

ts
registerChange(): void;

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

Returns ​

void

Inherited from ​

PDFStream.registerChange


sizeInBytes() ​

ts
sizeInBytes(): number;

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

Returns ​

number

Inherited from ​

PDFStream.sizeInBytes


toString() ​

ts
toString(): string;

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

Returns ​

string

Inherited from ​

PDFStream.toString


updateContents() ​

ts
updateContents(contents): void;

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

Parameters ​

ParameterType
contentsUint8Array

Returns ​

void

Overrides ​

PDFStream.updateContents


updateDict() ​

ts
updateDict(): void;

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

Returns ​

void

Inherited from ​

PDFStream.updateDict

MIT Licensed. A fork of pdf-lib.