happypdf / PDFParser

Class: PDFParser

Defined in: src/core/parser/PDFParser.ts:28

Extends

• PDFObjectParser

Constructors

Constructor

new PDFParser(
   pdfBytes, 
   objectsPerTick?, 
   throwOnInvalidObject?, 
   warnOnInvalidObjects?, 
   capNumbers?, 
   cryptoFactory?, 
   forIncrementalUpdate?): PDFParser;

Defined in: src/core/parser/PDFParser.ts:54

Parameters

Parameter	Type	Default value
pdfBytes	Uint8Array	undefined
objectsPerTick	number	Infinity
throwOnInvalidObject	boolean	false
warnOnInvalidObjects	boolean	false
capNumbers	boolean	false
cryptoFactory?	CipherTransformFactory	undefined
forIncrementalUpdate?	boolean	false

Returns

PDFParser

Overrides

PDFObjectParser.constructor

Properties

bytes

protected readonly bytes: ByteStream;

Defined in: src/core/parser/BaseParser.ts:12

Inherited from

PDFObjectParser.bytes

---

capNumbers

protected readonly capNumbers: boolean;

Defined in: src/core/parser/BaseParser.ts:13

Inherited from

PDFObjectParser.capNumbers

---

context

protected readonly context: PDFContext;

Defined in: src/core/parser/PDFObjectParser.ts:47

Inherited from

PDFObjectParser.context

Methods

findEndOfStreamFallback()

protected findEndOfStreamFallback(startPos): number;

Defined in: src/core/parser/PDFObjectParser.ts:283

Parameters

Parameter	Type
startPos	Position

Returns

number

Inherited from

PDFObjectParser.findEndOfStreamFallback

---

forBytes()

static forBytes(
   bytes, 
   context, 
   capNumbers?): PDFObjectParser;

Defined in: src/core/parser/PDFObjectParser.ts:35

Parameters

Parameter	Type
bytes	Uint8Array
context	PDFContext
capNumbers?	boolean

Returns

PDFObjectParser

Inherited from

PDFObjectParser.forBytes

---

forByteStream()

static forByteStream(
   byteStream, 
   context, 
   capNumbers?): PDFObjectParser;

Defined in: src/core/parser/PDFObjectParser.ts:41

Parameters

Parameter	Type	Default value
byteStream	ByteStream	undefined
context	PDFContext	undefined
capNumbers	boolean	false

Returns

PDFObjectParser

Inherited from

PDFObjectParser.forByteStream

---

forBytesWithOptions()

static forBytesWithOptions(
   pdfBytes, 
   objectsPerTick?, 
   throwOnInvalidObject?, 
   warnOnInvalidObjects?, 
   capNumbers?, 
   cryptoFactory?, 
   forIncrementalUpdate?): PDFParser;

Defined in: src/core/parser/PDFParser.ts:29

Parameters

Parameter	Type
pdfBytes	Uint8Array
objectsPerTick?	number
throwOnInvalidObject?	boolean
warnOnInvalidObjects?	boolean
capNumbers?	boolean
cryptoFactory?	CipherTransformFactory
forIncrementalUpdate?	boolean

Returns

PDFParser

---

matchKeyword()

protected matchKeyword(keyword): boolean;

Defined in: src/core/parser/BaseParser.ts:107

Parameters

Parameter	Type
keyword	number[]

Returns

boolean

Inherited from

PDFObjectParser.matchKeyword

---

parseArray()

protected parseArray(ref?): PDFArray;

Defined in: src/core/parser/PDFObjectParser.ts:188

Parameters

Parameter	Type
ref?	PDFRef

Returns

PDFArray

Inherited from

PDFObjectParser.parseArray

---

parseDict()

protected parseDict(ref?): PDFDict;

Defined in: src/core/parser/PDFObjectParser.ts:202

Parameters

Parameter	Type
ref?	PDFRef

Returns

PDFDict

Inherited from

PDFObjectParser.parseDict

---

parseDictOrStream()

protected parseDictOrStream(ref?): PDFStream | PDFDict;

Defined in: src/core/parser/PDFObjectParser.ts:237

Parameters

Parameter	Type
ref?	PDFRef

Returns

PDFStream | PDFDict

Inherited from

PDFObjectParser.parseDictOrStream

---

parseDocument()

parseDocument(): Promise<PDFContext>;

Defined in: src/core/parser/PDFParser.ts:79

Returns

Promise<PDFContext>

---

parseHexString()

protected parseHexString(ref?): PDFHexString;

Defined in: src/core/parser/PDFObjectParser.ts:104

Parameters

Parameter	Type
ref?	PDFRef

Returns

PDFHexString

Inherited from

PDFObjectParser.parseHexString

---

parseName()

protected parseName(): PDFName;

Defined in: src/core/parser/PDFObjectParser.ts:174

Returns

PDFName

Inherited from

PDFObjectParser.parseName

---

parseNumberOrRef()

protected parseNumberOrRef(): PDFNumber | PDFRef;

Defined in: src/core/parser/PDFObjectParser.ts:86

Returns

PDFNumber | PDFRef

Inherited from

PDFObjectParser.parseNumberOrRef

---

parseObject()

parseObject(ref?): PDFObject;

Defined in: src/core/parser/PDFObjectParser.ts:62

Parameters

Parameter	Type
ref?	PDFRef

Returns

PDFObject

Inherited from

PDFObjectParser.parseObject

---

parseRawInt()

protected parseRawInt(): number;

Defined in: src/core/parser/BaseParser.ts:20

Returns

number

Inherited from

PDFObjectParser.parseRawInt

---

parseRawNumber()

protected parseRawNumber(): number;

Defined in: src/core/parser/BaseParser.ts:40

Returns

number

Inherited from

PDFObjectParser.parseRawNumber

---

parseString()

protected parseString(ref?): PDFString;

Defined in: src/core/parser/PDFObjectParser.ts:128

Parameters

Parameter	Type
ref?	PDFRef

Returns

PDFString

Inherited from

PDFObjectParser.parseString

---

skipComment()

protected skipComment(): boolean;

Defined in: src/core/parser/BaseParser.ts:92

Returns

boolean

Inherited from

PDFObjectParser.skipComment

---

skipLine()

protected skipLine(): void;

Defined in: src/core/parser/BaseParser.ts:84

Returns

void

Inherited from

PDFObjectParser.skipLine

---

skipWhitespace()

protected skipWhitespace(): void;

Defined in: src/core/parser/BaseParser.ts:78

Returns

void

Inherited from

PDFObjectParser.skipWhitespace

---

skipWhitespaceAndComments()

protected skipWhitespaceAndComments(): void;

Defined in: src/core/parser/BaseParser.ts:102

Returns

void

Inherited from

PDFObjectParser.skipWhitespaceAndComments