modern-pdf-lib / PdfDict
Class: PdfDict
Defined in: src/core/pdfObjects.ts:275
A PDF dictionary << … >>.
Constructors
Constructor
new PdfDict(
entries?):PdfDict
Defined in: src/core/pdfObjects.ts:281
Parameters
entries?
Iterable<readonly [string, PdfObject], any, any>
Returns
PdfDict
Accessors
size
Get Signature
get size():
number
Defined in: src/core/pdfObjects.ts:318
Number of entries.
Returns
number
Methods
[iterator]()
[iterator]():
IterableIterator<[string,PdfObject]>
Defined in: src/core/pdfObjects.ts:323
Iterate over entries as [key, value] pairs.
Returns
IterableIterator<[string, PdfObject]>
delete()
delete(
key):boolean
Defined in: src/core/pdfObjects.ts:312
Delete a key.
Parameters
key
string
Returns
boolean
get()
get(
key):PdfObject|undefined
Defined in: src/core/pdfObjects.ts:300
Get a value by key.
Parameters
key
string
Returns
PdfObject | undefined
has()
has(
key):boolean
Defined in: src/core/pdfObjects.ts:306
Check if a key exists.
Parameters
key
string
Returns
boolean
serialize()
serialize(
writer):void
Defined in: src/core/pdfObjects.ts:327
Parameters
writer
Returns
void
set()
set(
key,value):this
Defined in: src/core/pdfObjects.ts:293
Set a key-value pair. Keys are always stored / looked up with the leading /.
Parameters
key
string
value
Returns
this