happypdf / PDFContext

Class: PDFContext

Defined in: src/core/PDFContext.ts:56

Properties

header

header: PDFHeader;

Defined in: src/core/PDFContext.ts:61

---

isDecrypted

isDecrypted: boolean = true;

Defined in: src/core/PDFContext.ts:57

---

largestObjectNumber

largestObjectNumber: number;

Defined in: src/core/PDFContext.ts:60

---

pdfFileDetails

pdfFileDetails: {
  originalBytes?: Uint8Array<ArrayBufferLike>;
  pdfSize: number;
  prevStartXRef: number;
  useObjectStreams: boolean;
};

Defined in: src/core/PDFContext.ts:70

originalBytes?

optional originalBytes?: Uint8Array<ArrayBufferLike>;

pdfSize

pdfSize: number;

prevStartXRef

prevStartXRef: number;

useObjectStreams

useObjectStreams: boolean;

---

rng

rng: SimpleRNG;

Defined in: src/core/PDFContext.ts:69

---

security?

optional security?: PDFSecurity;

Defined in: src/core/PDFContext.ts:78

---

snapshot?

optional snapshot?: DocumentSnapshot;

Defined in: src/core/PDFContext.ts:76

---

trailerInfo

trailerInfo: {
  Encrypt?: PDFObject;
  ID?: PDFObject;
  Info?: PDFObject;
  Root?: PDFObject;
  Size?: PDFNumber;
};

Defined in: src/core/PDFContext.ts:62

Encrypt?

optional Encrypt?: PDFObject;

ID?

optional ID?: PDFObject;

Info?

optional Info?: PDFObject;

Root?

optional Root?: PDFObject;

Size?

optional Size?: PDFNumber;

Methods

addRandomSuffix()

addRandomSuffix(prefix, suffixLength?): string;

Defined in: src/core/PDFContext.ts:391

Parameters

Parameter	Type	Default value
prefix	string	undefined
suffixLength	number	4

Returns

string

---

assign()

assign(ref, object): void;

Defined in: src/core/PDFContext.ts:99

Parameters

Parameter	Type
ref	PDFRef
object	PDFObject

Returns

void

---

contentStream()

contentStream(operators, dict?): PDFContentStream;

Defined in: src/core/PDFContext.ts:337

Parameters

Parameter	Type
operators	PDFOperator[]
dict	LiteralObject

Returns

PDFContentStream

---

create()

static create(): PDFContext;

Defined in: src/core/PDFContext.ts:58

Returns

PDFContext

---

delete()

delete(ref): boolean;

Defined in: src/core/PDFContext.ts:119

Parameters

Parameter	Type
ref	PDFRef

Returns

boolean

---

enumerateIndirectObjects()

enumerateIndirectObjects(): [PDFRef, PDFObject][];

Defined in: src/core/PDFContext.ts:214

Returns

[PDFRef, PDFObject][]

---

flateStream()

flateStream(contents, dict?): PDFRawStream;

Defined in: src/core/PDFContext.ts:327

Parameters

Parameter	Type
contents	string | Uint8Array<ArrayBufferLike>
dict	LiteralObject

Returns

PDFRawStream

---

formXObject()

formXObject(operators, dict?): PDFContentStream;

Defined in: src/core/PDFContext.ts:344

Parameters

Parameter	Type
operators	PDFOperator[]
dict	LiteralObject

Returns

PDFContentStream

---

getLiteral()

Call Signature

getLiteral(obj, cfg?): LiteralArray;

Defined in: src/core/PDFContext.ts:267

Parameters

Parameter	Type
obj	PDFArray
cfg?	LiteralConfig

Returns

LiteralArray

Call Signature

getLiteral(obj, cfg?): boolean;

Defined in: src/core/PDFContext.ts:268

Parameters

Parameter	Type
obj	PDFBool
cfg?	LiteralConfig

Returns

boolean

Call Signature

getLiteral(obj, cfg?): LiteralObject;

Defined in: src/core/PDFContext.ts:269

Parameters

Parameter	Type
obj	PDFDict
cfg?	LiteralConfig

Returns

LiteralObject

Call Signature

getLiteral(obj, cfg?): string | PDFHexString;

Defined in: src/core/PDFContext.ts:270

Parameters

Parameter	Type
obj	PDFHexString
cfg?	LiteralConfig

Returns

string | PDFHexString

Call Signature

getLiteral(obj, cfg?): string;

Defined in: src/core/PDFContext.ts:271

Parameters

Parameter	Type
obj	PDFName
cfg?	LiteralConfig

Returns

string

Call Signature

getLiteral(obj, cfg?): null;

Defined in: src/core/PDFContext.ts:272

Parameters

Parameter	Type
obj	PDFNull
cfg?	LiteralConfig

Returns

null

Call Signature

getLiteral(obj, cfg?): number;

Defined in: src/core/PDFContext.ts:273

Parameters

Parameter	Type
obj	PDFNumber
cfg?	LiteralConfig

Returns

number

Call Signature

getLiteral(obj, cfg?): number | PDFRef;

Defined in: src/core/PDFContext.ts:274

Parameters

Parameter	Type
obj	PDFRef
cfg?	LiteralConfig

Returns

number | PDFRef

Call Signature

getLiteral(obj, cfg?): PDFStream | LiteralObject;

Defined in: src/core/PDFContext.ts:275

Parameters

Parameter	Type
obj	PDFStream
cfg?	LiteralConfig

Returns

PDFStream | LiteralObject

Call Signature

getLiteral(obj, cfg?): string | PDFString;

Defined in: src/core/PDFContext.ts:276

Parameters

Parameter	Type
obj	PDFString
cfg?	LiteralConfig

Returns

string | PDFString

Call Signature

getLiteral(obj, cfg?): PDFObject;

Defined in: src/core/PDFContext.ts:277

Parameters

Parameter	Type
obj	PDFObject
cfg?	LiteralConfig

Returns

PDFObject

---

getObjectRef()

getObjectRef(pdfObject): PDFRef | undefined;

Defined in: src/core/PDFContext.ts:202

Parameters

Parameter	Type
pdfObject	PDFObject

Returns

PDFRef | undefined

---

getPopGraphicsStateContentStream()

getPopGraphicsStateContentStream(): PDFRef;

Defined in: src/core/PDFContext.ts:380

Returns

PDFRef

---

getPushGraphicsStateContentStream()

getPushGraphicsStateContentStream(): PDFRef;

Defined in: src/core/PDFContext.ts:363

Returns

PDFRef

---

getRef()

getRef(pdfObject): PDFRef | undefined;

Defined in: src/core/PDFContext.ts:197

Parameters

Parameter	Type
pdfObject	PDFObject | PDFRef

Returns

PDFRef | undefined

---

lookup()

Call Signature

lookup(ref): PDFObject | undefined;

Defined in: src/core/PDFContext.ts:163

Parameters

Parameter	Type
ref	LookupKey

Returns

PDFObject | undefined

Call Signature

lookup(ref, type): PDFArray;

Defined in: src/core/PDFContext.ts:164

Parameters

Parameter	Type
ref	LookupKey
type	typeof PDFArray

Returns

PDFArray

Call Signature

lookup(ref, type): PDFBool;

Defined in: src/core/PDFContext.ts:165

Parameters

Parameter	Type
ref	LookupKey
type	typeof PDFBool

Returns

PDFBool

Call Signature

lookup(ref, type): PDFDict;

Defined in: src/core/PDFContext.ts:166

Parameters

Parameter	Type
ref	LookupKey
type	typeof PDFDict

Returns

PDFDict

Call Signature

lookup(ref, type): PDFHexString;

Defined in: src/core/PDFContext.ts:167

Parameters

Parameter	Type
ref	LookupKey
type	typeof PDFHexString

Returns

PDFHexString

Call Signature

lookup(ref, type): PDFName;

Defined in: src/core/PDFContext.ts:168

Parameters

Parameter	Type
ref	LookupKey
type	typeof PDFName

Returns

PDFName

Call Signature

lookup(ref, type): PDFNull;

Defined in: src/core/PDFContext.ts:169

Parameters

Parameter	Type
ref	LookupKey
type	PDFNull

Returns

PDFNull

Call Signature

lookup(ref, type): PDFNumber;

Defined in: src/core/PDFContext.ts:170

Parameters

Parameter	Type
ref	LookupKey
type	typeof PDFNumber

Returns

PDFNumber

Call Signature

lookup(ref, type): PDFStream;

Defined in: src/core/PDFContext.ts:171

Parameters

Parameter	Type
ref	LookupKey
type	typeof PDFStream

Returns

PDFStream

Call Signature

lookup(ref, type): PDFRef;

Defined in: src/core/PDFContext.ts:172

Parameters

Parameter	Type
ref	LookupKey
type	typeof PDFRef

Returns

PDFRef

Call Signature

lookup(ref, type): PDFString;

Defined in: src/core/PDFContext.ts:173

Parameters

Parameter	Type
ref	LookupKey
type	typeof PDFString

Returns

PDFString

Call Signature

lookup(
   ref, 
   type1, 
   type2): PDFHexString | PDFString;

Defined in: src/core/PDFContext.ts:174

Parameters

Parameter	Type
ref	LookupKey
type1	typeof PDFString
type2	typeof PDFHexString

Returns

PDFHexString | PDFString

---

lookupMaybe()

Call Signature

lookupMaybe(ref, type): PDFArray | undefined;

Defined in: src/core/PDFContext.ts:124

Parameters

Parameter	Type
ref	LookupKey
type	typeof PDFArray

Returns

PDFArray | undefined

Call Signature

lookupMaybe(ref, type): PDFBool | undefined;

Defined in: src/core/PDFContext.ts:125

Parameters

Parameter	Type
ref	LookupKey
type	typeof PDFBool

Returns

PDFBool | undefined

Call Signature

lookupMaybe(ref, type): PDFDict | undefined;

Defined in: src/core/PDFContext.ts:126

Parameters

Parameter	Type
ref	LookupKey
type	typeof PDFDict

Returns

PDFDict | undefined

Call Signature

lookupMaybe(ref, type): PDFHexString | undefined;

Defined in: src/core/PDFContext.ts:127

Parameters

Parameter	Type
ref	LookupKey
type	typeof PDFHexString

Returns

PDFHexString | undefined

Call Signature

lookupMaybe(ref, type): PDFName | undefined;

Defined in: src/core/PDFContext.ts:131

Parameters

Parameter	Type
ref	LookupKey
type	typeof PDFName

Returns

PDFName | undefined

Call Signature

lookupMaybe(ref, type): PDFNull | undefined;

Defined in: src/core/PDFContext.ts:132

Parameters

Parameter	Type
ref	LookupKey
type	PDFNull

Returns

PDFNull | undefined

Call Signature

lookupMaybe(ref, type): PDFNumber | undefined;

Defined in: src/core/PDFContext.ts:133

Parameters

Parameter	Type
ref	LookupKey
type	typeof PDFNumber

Returns

PDFNumber | undefined

Call Signature

lookupMaybe(ref, type): PDFStream | undefined;

Defined in: src/core/PDFContext.ts:134

Parameters

Parameter	Type
ref	LookupKey
type	typeof PDFStream

Returns

PDFStream | undefined

Call Signature

lookupMaybe(ref, type): PDFRef | undefined;

Defined in: src/core/PDFContext.ts:135

Parameters

Parameter	Type
ref	LookupKey
type	typeof PDFRef

Returns

PDFRef | undefined

Call Signature

lookupMaybe(ref, type): PDFString | undefined;

Defined in: src/core/PDFContext.ts:136

Parameters

Parameter	Type
ref	LookupKey
type	typeof PDFString

Returns

PDFString | undefined

Call Signature

lookupMaybe(
   ref, 
   type1, 
   type2): 
  | PDFHexString
  | PDFString
  | undefined;

Defined in: src/core/PDFContext.ts:137

Parameters

Parameter	Type
ref	LookupKey
type1	typeof PDFString
type2	typeof PDFHexString

Returns

| PDFHexString | PDFString | undefined

---

nextRef()

nextRef(): PDFRef;

Defined in: src/core/PDFContext.ts:106

Returns

PDFRef

---

obj()

Call Signature

obj(literal): PDFNull;

Defined in: src/core/PDFContext.ts:220

Parameters

Parameter	Type
literal	null | undefined

Returns

PDFNull

Call Signature

obj(literal): PDFName;

Defined in: src/core/PDFContext.ts:221

Parameters

Parameter	Type
literal	string

Returns

PDFName

Call Signature

obj(literal): PDFNumber;

Defined in: src/core/PDFContext.ts:222

Parameters

Parameter	Type
literal	number

Returns

PDFNumber

Call Signature

obj(literal): PDFBool;

Defined in: src/core/PDFContext.ts:223

Parameters

Parameter	Type
literal	boolean

Returns

PDFBool

Call Signature

obj(literal): PDFDict;

Defined in: src/core/PDFContext.ts:224

Parameters

Parameter	Type
literal	LiteralObject

Returns

PDFDict

Call Signature

obj(literal): PDFArray;

Defined in: src/core/PDFContext.ts:225

Parameters

Parameter	Type
literal	LiteralArray

Returns

PDFArray

---

register()

register(object): PDFRef;

Defined in: src/core/PDFContext.ts:113

Parameters

Parameter	Type
object	PDFObject

Returns

PDFRef

---

registerObjectChange()

registerObjectChange(obj): void;

Defined in: src/core/PDFContext.ts:395

Parameters

Parameter	Type
obj	PDFObject

Returns

void

---

stream()

stream(contents, dict?): PDFRawStream;

Defined in: src/core/PDFContext.ts:320

Parameters

Parameter	Type
contents	string | Uint8Array<ArrayBufferLike>
dict	LiteralObject

Returns

PDFRawStream