node-zugferd
node-zugferd
@node-zugferd/validator-xsd
@node-zugferd/validator-mustang
@node-zugferd/traffiqx
@node-zugferd/templates
@node-zugferd/pdf-template
T
Align
F
aspectRatio
T
AssetSource
T
BackgroundImage
T
Border
T
BorderSides
I
BoxStyle
T
BoxTransform
T
BreakInside
F
brutalistTheme
F
button
I
ButtonOptions
T
CellVerticalAlign
F
checkbox
I
CheckboxOptions
F
cleanTheme
V
Colors
I
ColumnSpec
T
ColumnWidth
T
CrossAxis
F
definePdfTemplate
F
defineStyles
I
DocumentMetadata
F
dropdown
I
DropdownOptions
T
Edges
T
EdgesInput
F
editorialTheme
F
embedFont
F
flattenForm
F
flex
F
flowContinuation
I
FlowOptions
F
flowToPdf
I
FlowToPdfOptions
F
formatCurrency
I
FormFieldAppearance
T
FormFieldNode
T
FormFieldOptions
T
FormValue
T
Fragmentation
F
getFormValues
F
group
F
hex
F
hline
F
hstack
F
image
F
imageFit
F
inlineNode
I
InlineNodeRun
T
InlineVerticalAlign
T
Justify
F
keepTogether
F
link
F
linkRun
F
loadFont
I
LoadFontOptions
F
loadImage
T
MainAxis
I
MainAxisLayout
F
measure
F
measureContent
I
MeasureProfileEvent
T
Node
F
nodeAdapter
F
optionList
I
OptionListOptions
T
Overflow
F
pageContent
I
PageContext
F
pageInner
I
PageOptions
I
PageSize
V
PageSizes
F
paragraph
I
ParagraphFloat
I
ParagraphFloatLayout
T
ParagraphItem
I
ParagraphLayout
I
ParagraphProps
I
ParagraphRun
C
PDFDocument
C
PdfEncryptionError
T
PdfEncryptionErrorCode
I
PdfEncryptionOptions
C
PDFFont
C
PDFImage
C
PDFPage
I
PdfPermissions
T
Position
F
radioOption
I
RadioOptionOptions
T
RelativeLength
F
render
F
renderFlow
T
RenderFlowProfileCallback
I
RenderFlowProfileEvent
I
RenderOptions
F
renderToPdf
I
RenderToPdfOptions
F
resolveMainAxis
T
RGB
F
rgb255
F
run
F
savePdf
I
SavePdfOptions
F
setFormValues
I
Size
F
spacer
T
StandardFontFamily
F
standardFonts
E
StandardFonts
I
StandardFontSet
F
streamFlow
I
StreamFlowOptions
I
StreamPageContext
F
stripeTheme
F
svgPath
F
table
I
TableCell
T
TableCellInput
I
TableDivider
I
TableOptions
V
text
F
textField
I
TextFieldOptions
I
TextOptions
I
TextProps
I
TextRunStyle
I
Theme
I
ThemeColors
I
ThemedTextStyle
I
ThemeFonts
I
ThemeRadii
I
ThemeSpacing
I
ThemeType
T
TransformOrigin
F
vline
F
vstack
@node-zugferd/parser
@node-zugferd/magic-bytes
@node-zugferd/instrumentation
@node-zugferd/docx-template
@node-zugferd/default-template
@node-zugferd/data-types
@node-zugferd/core

PDFDocument

Represents a PDF document.

Class PDFDocument

class PDFDocument

Represents a PDF document.

Properties

catalog

PDFCatalog

The catalog of this document.

context

PDFContext

The low-level context of this document.

defaultWordBreaks

string[]

The default word breaks used in PDFPage.drawText

isEncrypted

boolean

Whether or not this document is encrypted.

Methods

addJavaScript

addJavaScript(name: string, script: string): void

Add JavaScript to this document. The supplied script is executed when the document is opened. The script can be used to perform some operation when the document is opened (e.g. logging to the console), or it can be used to define a function that can be referenced later in a JavaScript action. For example:

// Show "Hello World!" in the console when the PDF is opened
pdfDoc.addJavaScript(
  'main',
  'console.show(); console.println("Hello World!");'
);

// Define a function named "foo" that can be called in JavaScript Actions
pdfDoc.addJavaScript(
  'foo',
  'function foo() { return "foo"; }'
);

See the JavaScript for Acrobat API Reference for details.

Parameters

  • name: string The name of the script. Must be unique per document.
  • script: string The JavaScript to execute.

Returns void

addPage

addPage(page?: PDFPage | [number, number]): PDFPage

Add a page to the end of this document. This method accepts three different value types for the page parameter:

TypeBehavior
undefinedCreate a new page and add it to the end of this document
[number, number]Create a new page with the given dimensions and add it to the end of this document
PDFPageAdd the existing page to the end of this document

For example:

// page=undefined
const newPage = pdfDoc.addPage()

// page=[number, number]
import { PageSizes } from 'pdf-lib'
const newPage1 = pdfDoc.addPage(PageSizes.A7)
const newPage2 = pdfDoc.addPage(PageSizes.Letter)
const newPage3 = pdfDoc.addPage([500, 750])

// page=PDFPage
const pdfDoc1 = await PDFDocument.create()
const pdfDoc2 = await PDFDocument.load(...)
const [existingPage] = await pdfDoc1.copyPages(pdfDoc2, [0])
pdfDoc1.addPage(existingPage)

Parameters

  • page?: PDFPage | [number, number] Optionally, the desired dimensions or existing page.

Returns PDFPage

The newly created (or existing) page.

attach

attach(attachment: string | ArrayBuffer | Uint8Array<ArrayBufferLike>, name: string, options?: AttachmentOptions): Promise<void>

Add an attachment to this document. Attachments are visible in the "Attachments" panel of Adobe Acrobat and some other PDF readers. Any type of file can be added as an attachment. This includes, but is not limited to, .png, .jpg, .pdf, .csv, .docx, and .xlsx files.

The input data can be provided in multiple formats:

TypeContents
stringA base64 encoded string (or data URI) containing an attachment
Uint8ArrayThe raw bytes of an attachment
ArrayBufferThe raw bytes of an attachment

For example:

// attachment=string
await pdfDoc.attach('/9j/4AAQSkZJRgABAQAAAQABAAD/2wBD...', 'cat_riding_unicorn.jpg', {
  mimeType: 'image/jpeg',
  description: 'Cool cat riding a unicorn! 🦄🐈🕶️',
  creationDate: new Date('2019/12/01'),
  modificationDate: new Date('2020/04/19'),
})
await pdfDoc.attach('data:image/jpeg;base64,/9j/4AAQ...', 'cat_riding_unicorn.jpg', {
  mimeType: 'image/jpeg',
  description: 'Cool cat riding a unicorn! 🦄🐈🕶️',
  creationDate: new Date('2019/12/01'),
  modificationDate: new Date('2020/04/19'),
})

// attachment=Uint8Array
import fs from 'fs'
const uint8Array = fs.readFileSync('cat_riding_unicorn.jpg')
await pdfDoc.attach(uint8Array, 'cat_riding_unicorn.jpg', {
  mimeType: 'image/jpeg',
  description: 'Cool cat riding a unicorn! 🦄🐈🕶️',
  creationDate: new Date('2019/12/01'),
  modificationDate: new Date('2020/04/19'),
})

// attachment=ArrayBuffer
const url = 'https://pdf-lib.js.org/assets/cat_riding_unicorn.jpg'
const arrayBuffer = await fetch(url).then(res => res.arrayBuffer())
await pdfDoc.attach(arrayBuffer, 'cat_riding_unicorn.jpg', {
  mimeType: 'image/jpeg',
  description: 'Cool cat riding a unicorn! 🦄🐈🕶️',
  creationDate: new Date('2019/12/01'),
  modificationDate: new Date('2020/04/19'),
})

Parameters

  • attachment: string | ArrayBuffer | Uint8Array<ArrayBufferLike> The input data containing the file to be attached.
  • name: string The name of the file to be attached.
  • options?: AttachmentOptions

Returns Promise<void>

Resolves when the attachment is complete.

copy

copy(): Promise<PDFDocument>

Get a copy of this document.

For example:

const srcDoc = await PDFDocument.load(...)
const pdfDoc = await srcDoc.copy()

NOTE: This method won't copy all information over to the new document (acroforms, outlines, etc...).

Returns Promise<PDFDocument>

Resolves with a copy this document.

copyPages

copyPages(srcDoc: PDFDocument, indices: number[]): Promise<PDFPage[]>

Copy pages from a source document into this document. Allows pages to be copied between different [[PDFDocument]] instances. For example:

const pdfDoc = await PDFDocument.create()
const srcDoc = await PDFDocument.load(...)

const copiedPages = await pdfDoc.copyPages(srcDoc, [0, 3, 89])
const [firstPage, fourthPage, ninetiethPage] = copiedPages;

pdfDoc.addPage(fourthPage)
pdfDoc.insertPage(0, ninetiethPage)
pdfDoc.addPage(firstPage)

Parameters

  • srcDoc: PDFDocument The document from which pages should be copied.
  • indices: number[] The indices of the pages that should be copied.

Returns Promise<PDFPage[]>

Resolves with an array of pages copied into this document.

embedFont

embedFont(font: string | ArrayBuffer | Uint8Array<ArrayBufferLike>, options?: EmbedFontOptions): Promise<PDFFont>

Embed a font into this document. The input data can be provided in multiple formats:

TypeContents
StandardFontsOne of the standard 14 fonts
stringA base64 encoded string (or data URI) containing a font
Uint8ArrayThe raw bytes of a font
ArrayBufferThe raw bytes of a font

For example:

// font=StandardFonts
import { StandardFonts } from 'pdf-lib'
const font1 = await pdfDoc.embedFont(StandardFonts.Helvetica)

// font=string
const font2 = await pdfDoc.embedFont('AAEAAAAVAQAABABQRFNJRx/upe...')
const font3 = await pdfDoc.embedFont('data:font/opentype;base64,AAEAAA...')

// font=Uint8Array
import fs from 'fs'
const font4 = await pdfDoc.embedFont(fs.readFileSync('Ubuntu-R.ttf'))

// font=ArrayBuffer
const url = 'https://pdf-lib.js.org/assets/ubuntu/Ubuntu-R.ttf'
const ubuntuBytes = await fetch(url).then(res => res.arrayBuffer())
const font5 = await pdfDoc.embedFont(ubuntuBytes)

See also: [[registerFontkit]]

Parameters

  • font: string | ArrayBuffer | Uint8Array<ArrayBufferLike> The input data for a font.
  • options?: EmbedFontOptions The options to be used when embedding the font.

Returns Promise<PDFFont>

Resolves with the embedded font.

embedJpg

embedJpg(jpg: string | ArrayBuffer | Uint8Array<ArrayBufferLike>): Promise<PDFImage>

Embed a JPEG image into this document. The input data can be provided in multiple formats:

TypeContents
stringA base64 encoded string (or data URI) containing a JPEG image
Uint8ArrayThe raw bytes of a JPEG image
ArrayBufferThe raw bytes of a JPEG image

For example:

// jpg=string
const image1 = await pdfDoc.embedJpg('/9j/4AAQSkZJRgABAQAAAQABAAD/2wBD...')
const image2 = await pdfDoc.embedJpg('data:image/jpeg;base64,/9j/4AAQ...')

// jpg=Uint8Array
import fs from 'fs'
const uint8Array = fs.readFileSync('cat_riding_unicorn.jpg')
const image3 = await pdfDoc.embedJpg(uint8Array)

// jpg=ArrayBuffer
const url = 'https://pdf-lib.js.org/assets/cat_riding_unicorn.jpg'
const arrayBuffer = await fetch(url).then(res => res.arrayBuffer())
const image4 = await pdfDoc.embedJpg(arrayBuffer)

Parameters

  • jpg: string | ArrayBuffer | Uint8Array<ArrayBufferLike> The input data for a JPEG image.

Returns Promise<PDFImage>

Resolves with the embedded image.

embedPage

embedPage(page: PDFPage, boundingBox?: PageBoundingBox, transformationMatrix?: TransformationMatrix): Promise<PDFEmbeddedPage>

Embed a single PDF page into this document.

For example:

const pdfDoc = await PDFDocument.create()

const sourcePdfUrl = 'https://pdf-lib.js.org/assets/with_large_page_count.pdf'
const sourceBuffer = await fetch(sourcePdfUrl).then((res) => res.arrayBuffer())
const sourcePdfDoc = await PDFDocument.load(sourceBuffer)
const sourcePdfPage = sourcePdfDoc.getPages()[73]

const embeddedPage = await pdfDoc.embedPage(
  sourcePdfPage,

  // Clip a section of the source page so that we only embed part of it
  { left: 100, right: 450, bottom: 330, top: 570 },

  // Translate all drawings of the embedded page by (10, 200) units
  [1, 0, 0, 1, 10, 200],
)

Parameters

  • page: PDFPage The page to be embedded.
  • boundingBox?: PageBoundingBox Optionally, an area of the source page that should be embedded (defaults to entire page).
  • transformationMatrix?: TransformationMatrix Optionally, a transformation matrix that is always applied to the embedded page anywhere it is drawn.

Returns Promise<PDFEmbeddedPage>

Resolves with the embedded pdf page.

embedPages

embedPages(pages: PDFPage[], boundingBoxes?: (PageBoundingBox | undefined)[], transformationMatrices?: (TransformationMatrix | undefined)[]): Promise<PDFEmbeddedPage[]>

Embed one or more PDF pages into this document.

For example:

const pdfDoc = await PDFDocument.create()

const sourcePdfUrl = 'https://pdf-lib.js.org/assets/with_large_page_count.pdf'
const sourceBuffer = await fetch(sourcePdfUrl).then((res) => res.arrayBuffer())
const sourcePdfDoc = await PDFDocument.load(sourceBuffer)

const page1 = sourcePdfDoc.getPages()[0]
const page2 = sourcePdfDoc.getPages()[52]
const page3 = sourcePdfDoc.getPages()[73]

const embeddedPages = await pdfDoc.embedPages([page1, page2, page3])

Parameters

  • pages: PDFPage[]
  • boundingBoxes?: (PageBoundingBox | undefined)[] Optionally, an array of clipping boundaries - one for each page (defaults to entirety of each page).
  • transformationMatrices?: (TransformationMatrix | undefined)[] Optionally, an array of transformation matrices - one for each page (each page's transformation will apply anywhere it is drawn).

Returns Promise<PDFEmbeddedPage[]>

Resolves with an array of the embedded pdf pages.

embedPdf

embedPdf(pdf: string | PDFDocument | ArrayBuffer | Uint8Array<ArrayBufferLike>, indices?: number[]): Promise<PDFEmbeddedPage[]>

Embed one or more PDF pages into this document.

For example:

const pdfDoc = await PDFDocument.create()

const sourcePdfUrl = 'https://pdf-lib.js.org/assets/with_large_page_count.pdf'
const sourcePdf = await fetch(sourcePdfUrl).then((res) => res.arrayBuffer())

// Embed page 74 of `sourcePdf` into `pdfDoc`
const [embeddedPage] = await pdfDoc.embedPdf(sourcePdf, [73])

See [[PDFDocument.load]] for examples of the allowed input data formats.

Parameters

  • pdf: string | PDFDocument | ArrayBuffer | Uint8Array<ArrayBufferLike> The input data containing a PDF document.
  • indices?: number[] The indices of the pages that should be embedded.

Returns Promise<PDFEmbeddedPage[]>

Resolves with an array of the embedded pages.

embedPng

embedPng(png: string | ArrayBuffer | Uint8Array<ArrayBufferLike>): Promise<PDFImage>

Embed a PNG image into this document. The input data can be provided in multiple formats:

TypeContents
stringA base64 encoded string (or data URI) containing a PNG image
Uint8ArrayThe raw bytes of a PNG image
ArrayBufferThe raw bytes of a PNG image

For example:

// png=string
const image1 = await pdfDoc.embedPng('iVBORw0KGgoAAAANSUhEUgAAAlgAAAF3...')
const image2 = await pdfDoc.embedPng('data:image/png;base64,iVBORw0KGg...')

// png=Uint8Array
import fs from 'fs'
const uint8Array = fs.readFileSync('small_mario.png')
const image3 = await pdfDoc.embedPng(uint8Array)

// png=ArrayBuffer
const url = 'https://pdf-lib.js.org/assets/small_mario.png'
const arrayBuffer = await fetch(url).then(res => res.arrayBuffer())
const image4 = await pdfDoc.embedPng(arrayBuffer)

Parameters

  • png: string | ArrayBuffer | Uint8Array<ArrayBufferLike> The input data for a PNG image.

Returns Promise<PDFImage>

Resolves with the embedded image.

embedStandardFont

embedStandardFont(font: StandardFonts, customName?: string): PDFFont

Embed a standard font into this document. For example:

import { StandardFonts } from 'pdf-lib'
const helveticaFont = pdfDoc.embedFont(StandardFonts.Helvetica)

Parameters

  • font: StandardFonts The standard font to be embedded.
  • customName?: string The name to be used when embedding the font.

Returns PDFFont

The embedded font.

findPageForAnnotationRef

findPageForAnnotationRef(ref: PDFRef): PDFPage | undefined

Parameters

  • ref: PDFRef

Returns PDFPage | undefined

flush

flush(): Promise<void>

NOTE: You shouldn't need to call this method directly. The [[save]] and [[saveAsBase64]] methods will automatically ensure that all embedded assets are flushed before serializing the document.

Flush all embedded fonts, PDF pages, and images to this document's [[context]].

Returns Promise<void>

Resolves when the flush is complete.

getAuthor

getAuthor(): string | undefined

Get this document's author metadata. The author appears in the "Document Properties" section of most PDF readers. For example:

const author = pdfDoc.getAuthor()

Returns string | undefined

A string containing the author of this document, if it has one.

getCreationDate

getCreationDate(): Date | undefined

Get this document's creation date metadata. The creation date appears in the "Document Properties" section of most PDF readers. For example:

const creationDate = pdfDoc.getCreationDate()

Returns Date | undefined

A Date containing the creation date of this document, if it has one.

getCreator

getCreator(): string | undefined

Get this document's creator metadata. The creator appears in the "Document Properties" section of most PDF readers. For example:

const creator = pdfDoc.getCreator()

Returns string | undefined

A string containing the creator of this document, if it has one.

getForm

getForm(): PDFForm

Get the [[PDFForm]] containing all interactive fields for this document. For example:

const form = pdfDoc.getForm()
const fields = form.getFields()
fields.forEach(field => {
  const type = field.constructor.name
  const name = field.getName()
  console.log(`${type}: ${name}`)
})

Returns PDFForm

The form for this document.

getKeywords

getKeywords(): string | undefined

Get this document's keywords metadata. The keywords appear in the "Document Properties" section of most PDF readers. For example:

const keywords = pdfDoc.getKeywords()

Returns string | undefined

A string containing the keywords of this document, if it has any.

getModificationDate

getModificationDate(): Date | undefined

Get this document's modification date metadata. The modification date appears in the "Document Properties" section of most PDF readers. For example:

const modification = pdfDoc.getModificationDate()

Returns Date | undefined

A Date containing the modification date of this document, if it has one.

getPage

getPage(index: number): PDFPage

Get the page rendered at a particular index of the document. For example:

pdfDoc.getPage(0)   // The first page of the document
pdfDoc.getPage(2)   // The third page of the document
pdfDoc.getPage(197) // The 198th page of the document

Parameters

  • index: number

Returns PDFPage

The [[PDFPage]] rendered at the given index of the document.

getPageCount

getPageCount(): number

Get the number of pages contained in this document. For example:

const totalPages = pdfDoc.getPageCount()

Returns number

The number of pages in this document.

getPageIndices

getPageIndices(): number[]

Get an array of indices for all the pages contained in this document. The array will contain a range of integers from 0..pdfDoc.getPageCount() - 1. For example:

const pdfDoc = await PDFDocument.create()
pdfDoc.addPage()
pdfDoc.addPage()
pdfDoc.addPage()

const indices = pdfDoc.getPageIndices()
indices // => [0, 1, 2]

Returns number[]

An array of indices for all pages contained in this document.

getPages

getPages(): PDFPage[]

Get an array of all the pages contained in this document. The pages are stored in the array in the same order that they are rendered in the document. For example:

const pages = pdfDoc.getPages()
pages[0]   // The first page of the document
pages[2]   // The third page of the document
pages[197] // The 198th page of the document

Returns PDFPage[]

An array of all the pages contained in this document.

getProducer

getProducer(): string | undefined

Get this document's producer metadata. The producer appears in the "Document Properties" section of most PDF readers. For example:

const producer = pdfDoc.getProducer()

Returns string | undefined

A string containing the producer of this document, if it has one.

getSubject

getSubject(): string | undefined

Get this document's subject metadata. The subject appears in the "Document Properties" section of most PDF readers. For example:

const subject = pdfDoc.getSubject()

Returns string | undefined

A string containing the subject of this document, if it has one.

getTitle

getTitle(): string | undefined

Get this document's title metadata. The title appears in the "Document Properties" section of most PDF readers. For example:

const title = pdfDoc.getTitle()

Returns string | undefined

A string containing the title of this document, if it has one.

insertPage

insertPage(index: number, page?: PDFPage | [number, number]): PDFPage

Insert a page at a given index within this document. This method accepts three different value types for the page parameter:

TypeBehavior
undefinedCreate a new page and insert it into this document
[number, number]Create a new page with the given dimensions and insert it into this document
PDFPageInsert the existing page into this document

For example:

// page=undefined
const newPage = pdfDoc.insertPage(2)

// page=[number, number]
import { PageSizes } from 'pdf-lib'
const newPage1 = pdfDoc.insertPage(2, PageSizes.A7)
const newPage2 = pdfDoc.insertPage(0, PageSizes.Letter)
const newPage3 = pdfDoc.insertPage(198, [500, 750])

// page=PDFPage
const pdfDoc1 = await PDFDocument.create()
const pdfDoc2 = await PDFDocument.load(...)
const [existingPage] = await pdfDoc1.copyPages(pdfDoc2, [0])
pdfDoc1.insertPage(0, existingPage)

Parameters

  • index: number The index at which the page should be inserted (zero-based).
  • page?: PDFPage | [number, number] Optionally, the desired dimensions or existing page.

Returns PDFPage

The newly created (or existing) page.

registerFontkit

registerFontkit(fontkit: Fontkit): void

Register a fontkit instance. This must be done before custom fonts can be embedded. See here for instructions on how to install and register a fontkit instance.

You do not need to call this method to embed standard fonts.

For example:

import { PDFDocument } from 'pdf-lib'
import fontkit from '@pdf-lib/fontkit'

const pdfDoc = await PDFDocument.create()
pdfDoc.registerFontkit(fontkit)

Parameters

  • fontkit: Fontkit The fontkit instance to be registered.

Returns void

removePage

removePage(index: number): void

Remove the page at a given index from this document. For example:

pdfDoc.removePage(0)   // Remove the first page of the document
pdfDoc.removePage(2)   // Remove the third page of the document
pdfDoc.removePage(197) // Remove the 198th page of the document

Once a page has been removed, it will no longer be rendered at that index in the document.

Parameters

  • index: number The index of the page to be removed.

Returns void

save

save(options?: SaveOptions): Promise<Uint8Array<ArrayBufferLike>>

Serialize this document to an array of bytes making up a PDF file. For example:

const pdfBytes = await pdfDoc.save()

There are a number of things you can do with the serialized document, depending on the JavaScript environment you're running in:

  • Write it to a file in Node or React Native
  • Download it as a Blob in the browser
  • Render it in an iframe

Parameters

  • options?: SaveOptions The options to be used when saving the document.

Returns Promise<Uint8Array<ArrayBufferLike>>

Resolves with the bytes of the serialized document.

saveAsBase64

saveAsBase64(options?: Base64SaveOptions): Promise<string>

Serialize this document to a base64 encoded string or data URI making up a PDF file. For example:

const base64String = await pdfDoc.saveAsBase64()
base64String // => 'JVBERi0xLjcKJYGBgYEKC...'

const base64DataUri = await pdfDoc.saveAsBase64({ dataUri: true })
base64DataUri // => 'data:application/pdf;base64,JVBERi0xLjcKJYGBgYEKC...'

Parameters

  • options?: Base64SaveOptions The options to be used when saving the document.

Returns Promise<string>

Resolves with a base64 encoded string or data URI of the serialized document.

setAuthor

setAuthor(author: string): void

Set this document's author metadata. The author will appear in the "Document Properties" section of most PDF readers. For example:

pdfDoc.setAuthor('Humpty Dumpty')

Parameters

  • author: string The author of this document.

Returns void

setCreationDate

setCreationDate(creationDate: Date): void

Set this document's creation date metadata. The creation date will appear in the "Document Properties" section of most PDF readers. For example:

pdfDoc.setCreationDate(new Date())

Parameters

  • creationDate: Date The date this document was created.

Returns void

setCreator

setCreator(creator: string): void

Set this document's creator metadata. The creator will appear in the "Document Properties" section of most PDF readers. For example:

pdfDoc.setCreator('PDF App 9000 🤖')

Parameters

  • creator: string The creator of this document.

Returns void

setKeywords

setKeywords(keywords: string[]): void

Set this document's keyword metadata. These keywords will appear in the "Document Properties" section of most PDF readers. For example:

pdfDoc.setKeywords(['eggs', 'wall', 'fall', 'king', 'horses', 'men'])

Parameters

  • keywords: string[] An array of keywords associated with this document.

Returns void

setLanguage

setLanguage(language: string): void

Set this document's language metadata. The language will appear in the "Document Properties" section of some PDF readers. For example:

pdfDoc.setLanguage('en-us')

Parameters

  • language: string An RFC 3066 Language-Tag denoting the language of this document, or an empty string if the language is unknown.

Returns void

setModificationDate

setModificationDate(modificationDate: Date): void

Set this document's modification date metadata. The modification date will appear in the "Document Properties" section of most PDF readers. For example:

pdfDoc.setModificationDate(new Date())

Parameters

  • modificationDate: Date The date this document was last modified.

Returns void

setProducer

setProducer(producer: string): void

Set this document's producer metadata. The producer will appear in the "Document Properties" section of most PDF readers. For example:

pdfDoc.setProducer('PDF App 9000 🤖')

Parameters

  • producer: string The producer of this document.

Returns void

setSubject

setSubject(subject: string): void

Set this document's subject metadata. The subject will appear in the "Document Properties" section of most PDF readers. For example:

pdfDoc.setSubject('📘 An Epic Tale of Woe 📖')

Parameters

  • subject: string The subject of this document.

Returns void

setTitle

setTitle(title: string, options?: SetTitleOptions): void

Set this document's title metadata. The title will appear in the "Document Properties" section of most PDF readers. For example:

pdfDoc.setTitle('🥚 The Life of an Egg 🍳')

To display the title in the window's title bar, set the showInWindowTitleBar option to true (works for most PDF readers). For example:

pdfDoc.setTitle('🥚 The Life of an Egg 🍳', { showInWindowTitleBar: true })

Parameters

  • title: string The title of this document.
  • options?: SetTitleOptions The options to be used when setting the title.

Returns void

create

create(options?: CreateOptions): Promise<PDFDocument>

Create a new [[PDFDocument]].

Parameters

  • options?: CreateOptions

Returns Promise<PDFDocument>

Resolves with the newly created document.

load

load(pdf: string | ArrayBuffer | Uint8Array<ArrayBufferLike>, options?: LoadOptions): Promise<PDFDocument>

Load an existing [[PDFDocument]]. The input data can be provided in multiple formats:

TypeContents
stringA base64 encoded string (or data URI) containing a PDF
Uint8ArrayThe raw bytes of a PDF
ArrayBufferThe raw bytes of a PDF

For example:

import { PDFDocument } from 'pdf-lib'

// pdf=string
const base64 =
 'JVBERi0xLjcKJYGBgYEKCjUgMCBvYmoKPDwKL0ZpbHRlciAvRmxhdGVEZWNvZGUKL0xlbm' +
 'd0aCAxMDQKPj4Kc3RyZWFtCniccwrhMlAAwaJ0Ln2P1Jyy1JLM5ERdc0MjCwUjE4WQNC4Q' +
 '6cNlCFZkqGCqYGSqEJLLZWNuYGZiZmbkYuZsZmlmZGRgZmluDCQNzc3NTM2NzdzMXMxMjQ' +
 'ztFEKyuEK0uFxDuAAOERdVCmVuZHN0cmVhbQplbmRvYmoKCjYgMCBvYmoKPDwKL0ZpbHRl' +
 'ciAvRmxhdGVEZWNvZGUKL1R5cGUgL09ialN0bQovTiA0Ci9GaXJzdCAyMAovTGVuZ3RoID' +
 'IxNQo+PgpzdHJlYW0KeJxVj9GqwjAMhu/zFHkBzTo3nCCCiiKIHPEICuJF3cKoSCu2E8/b' +
 '20wPIr1p8v9/8kVhgilmGfawX2CGaVrgcAi0/bsy0lrX7IGWpvJ4iJYEN3gEmrrGBlQwGs' +
 'HHO9VBX1wNrxAqMX87RBD5xpJuddqwd82tjAHxzV1U5LPgy52DKXWnr1Lheg+j/c/pzGVr' +
 'iqV0VlwZPXGPCJjElw/ybkwUmeoWgxesDXGhHJC/D/iikp1Av80ptKU0FdBEe25pPihAM1' +
 'u6ytgaaWfs2Hrz35CJT1+EWmAKZW5kc3RyZWFtCmVuZG9iagoKNyAwIG9iago8PAovU2l6' +
 'ZSA4Ci9Sb290IDIgMCBSCi9GaWx0ZXIgL0ZsYXRlRGVjb2RlCi9UeXBlIC9YUmVmCi9MZW' +
 '5ndGggMzgKL1cgWyAxIDIgMiBdCi9JbmRleCBbIDAgOCBdCj4+CnN0cmVhbQp4nBXEwREA' +
 'EBAEsCwz3vrvRmOOyyOoGhZdutHN2MT55fIAVocD+AplbmRzdHJlYW0KZW5kb2JqCgpzdG' +
 'FydHhyZWYKNTEwCiUlRU9G'

const dataUri = 'data:application/pdf;base64,' + base64

const pdfDoc1 = await PDFDocument.load(base64)
const pdfDoc2 = await PDFDocument.load(dataUri)

// pdf=Uint8Array
import fs from 'fs'
const uint8Array = fs.readFileSync('with_update_sections.pdf')
const pdfDoc3 = await PDFDocument.load(uint8Array)

// pdf=ArrayBuffer
const url = 'https://pdf-lib.js.org/assets/with_update_sections.pdf'
const arrayBuffer = await fetch(url).then(res => res.arrayBuffer())
const pdfDoc4 = await PDFDocument.load(arrayBuffer)

Parameters

  • pdf: string | ArrayBuffer | Uint8Array<ArrayBufferLike> The input data containing a PDF document.
  • options?: LoadOptions The options to be used when loading the document.

Returns Promise<PDFDocument>

Resolves with a document loaded from the input.


llms.txt
@node-zugferd/pdf-template

C
PdfEncryptionError

Edit on GitHubPrivacyImprint