PDF-Lib

https://pdf-lib.js.org/
Admin
PDF-Lib is a pure JavaScript library for creating, modifying, and manipulating PDF documents in any...
Tokens:141,553
Snippets:883
Trust Score:8.1
Update:2 months ago
Show doc for...
Tokens:
Raw
### Browser Quick Start

Source: https://pdf-lib.js.org/

A complete HTML example that loads the library via CDN and renders a PDF in an iframe.

```html
<html>
  <head>
    <meta charset="utf-8" />
    <script src="https://unpkg.com/pdf-lib"></script>
  </head>

  <body>
    <iframe id="pdf" style="width: 100%; height: 100%;"></iframe>
  </body>

  <script>
    createPdf();
    async function createPdf() {
      const pdfDoc = await PDFLib.PDFDocument.create();
      const page = pdfDoc.addPage([350, 400]);
      page.moveTo(110, 200);
      page.drawText('Hello World!');
      const pdfDataUri = await pdfDoc.saveAsBase64({ dataUri: true });
      document.getElementById('pdf').src = pdfDataUri;
    }
  </script>
</html>
```

--------------------------------

### Deno Quick Start

Source: https://pdf-lib.js.org/

Command to execute a quick start script directly in the Deno runtime.

```bash
$ deno run --allow-write https://pdf-lib.js.org/deno/quick_start.ts
```

--------------------------------

### Begin Text Object

Source: https://pdf-lib.js.org/docs/api/index

Starts a text object in the PDF content stream. Returns a PDFOperator.

```typescript
beginText(): PDFOperator<any>
```

--------------------------------

### Install pdf-lib via Package Manager

Source: https://pdf-lib.js.org/

Commands to add the library to your project using npm or yarn.

```bash
npm install --save pdf-lib
```

```bash
yarn add pdf-lib
```

--------------------------------

### Get PDF Form and Fields

Source: https://pdf-lib.js.org/docs/api/classes/pdfdocument

Access the PDFForm to interact with all interactive fields within a document. This example shows how to get all fields and log their type and name.

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

```

--------------------------------

### Begin Marked Content

Source: https://pdf-lib.js.org/docs/api

Starts a marked content sequence with a specified tag. Used for adding structure or metadata to PDF content.

```typescript
beginMarkedContent(`tag`: string | PDFName): PDFOperator<any>
```

--------------------------------

### Get available options for a dropdown

Source: https://pdf-lib.js.org/docs/api/classes/pdfdropdown

Retrieves the list of all available options that can be selected from a dropdown. These are the choices presented to users in a PDF reader.

```javascript
const dropdown = form.getDropdown('some.dropdown.field')
const options = dropdown.getOptions()
console.log('Dropdown options:', options)
```

--------------------------------

### Get Option List Options

Source: https://pdf-lib.js.org/docs/api/classes/pdfoptionlist

Retrieve all available options from a PDF option list field. These are the choices presented to users in a PDF reader.

```javascript
const optionList = form.getOptionList('some.optionList.field')
const options = optionList.getOptions()
console.log('Option List options:', options)
```

--------------------------------

### Get Fit Window Preference

Source: https://pdf-lib.js.org/docs/api/classes/viewerpreferences

Checks if PDF readers should resize the document window to fit the first displayed page. This ensures the initial view is appropriately scaled.

```typescript
getFitWindow(): boolean
```

--------------------------------

### Get Radio Group Options - pdf-lib.js

Source: https://pdf-lib.js.org/docs/api/classes/pdfradiogroup

Retrieve all available options for a PDF radio group. Each option corresponds to a radio button within the group.

```javascript
const radioGroup = form.getRadioGroup('some.radioGroup.field')
const options = radioGroup.getOptions()
console.log('Radio Group options:', options)
```

--------------------------------

### Get Display Document Title Preference

Source: https://pdf-lib.js.org/docs/api/classes/viewerpreferences

Determines if the window's title bar should display the document's title from metadata or the filename. Useful for branding or identification.

```typescript
getDisplayDocTitle(): boolean
```

--------------------------------

### Get Specific PDF Page by Index

Source: https://pdf-lib.js.org/docs/api/classes/pdfdocument

Retrieve a specific PDF page from the document using its zero-based index. For example, index 0 is the first page.

```javascript
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

```

--------------------------------

### Get Print Page Range

Source: https://pdf-lib.js.org/docs/api/classes/viewerpreferences

Returns an array of page number ranges used to initialize the print dialog. Each range specifies the start and end pages for printing. Page indices are 0-based.

```typescript
getPrintPageRange(): PageRange[]
```

```typescript
const viewerPrefs = pdfDoc.catalog.getOrCreateViewerPreferences()
const includesPage3 = viewerPrefs
  .getPrintRanges()
  .some(pr => pr.start <= 2 && pr.end >= 2)
if (includesPage3) console.log('printRange includes page 3')
```

--------------------------------

### Create and Modify PDF Documents

Source: https://pdf-lib.js.org/

Demonstrates the basic workflow for creating a new PDF document and loading an existing one for modification.

```javascript
import { PDFDocument } from 'pdf-lib'

// PDF Creation
const pdfDoc = await PDFDocument.create()
const page = pdfDoc.addPage()
page.drawText('You can create PDFs!')
const pdfBytes = await pdfDoc.save()

// PDF Modification
const pdfDoc = await PDFDocument.load(...)
const pages = pdfDoc.getPages()
pages[0].drawText('You can modify PDFs too!')
const pdfBytes = await pdfDoc.save()
```

--------------------------------

### Begin Marked Content

Source: https://pdf-lib.js.org/docs/api/index

Initiates a marked content sequence with a specified tag. Returns a PDFOperator.

```typescript
beginMarkedContent(tag: string | PDFName): PDFOperator<any>
```

--------------------------------

### Get Selected Radio Button Option - pdf-lib.js

Source: https://pdf-lib.js.org/docs/api/classes/pdfradiogroup

Get the value of the currently selected radio button in a group. Returns undefined if no button is selected.

```javascript
const radioGroup = form.getRadioGroup('some.radioGroup.field')
const selected = radioGroup.getSelected()
console.log('Selected radio button:', selected)
```

--------------------------------

### Get Pick Tray by PDF Size Preference

Source: https://pdf-lib.js.org/docs/api/classes/viewerpreferences

Checks if the PDF page size should be used to automatically select the input paper tray for printing. This can optimize printing on multi-tray devices.

```typescript
getPickTrayByPDFSize(): boolean | undefined
```

--------------------------------

### Get Page Y Coordinate

Source: https://pdf-lib.js.org/docs/api/classes/pdfpage

Retrieves the default y coordinate of the page.

```javascript
const y = page.getY()
```

--------------------------------

### CreateOptions

Source: https://pdf-lib.js.org/docs/api/interfaces/createoptions

Options for creating a new PDF document.

```APIDOC
## CreateOptions

### Description
Options that can be passed when creating a new PDF document.

### Properties
#### Optional `updateMetadata`
- **updateMetadata** (boolean) - Optional - If set to `true`, the PDF metadata will be updated. If set to `false` or omitted, it will not be updated.
```

--------------------------------

### Get PDFImage dimensions

Source: https://pdf-lib.js.org/docs/api/classes/pdfimage

Retrieve the current width and height of the image.

```javascript
const { width, height } = image.size()
```

--------------------------------

### Enable File Selection

Source: https://pdf-lib.js.org/docs/api/classes/pdftextfield

Configures a text field to store a file path, with the file's content being submitted as the field's value.

```javascript
const textField = form.getTextField('some.text.field')
textField.enableFileSelection()
```

--------------------------------

### Get Page X Coordinate

Source: https://pdf-lib.js.org/docs/api/classes/pdfpage

Retrieves the default x coordinate of the page.

```javascript
const x = page.getX()
```

--------------------------------

### PDFOptionList.of

Source: https://pdf-lib.js.org/docs/api/classes/pdfoptionlist

Creates an instance of PDFOptionList from an existing acroListBox and ref. It is recommended to use PDFForm.getOptionList instead.

```APIDOC
## POST /pdf-lib/api/form/PDFOptionList/of

### Description
Creates an instance of PDFOptionList from an existing acroListBox and ref. Note: You probably don't want to call this method directly. Instead, consider using the PDFForm.getOptionList method, which will create an instance of PDFOptionList for you.

### Method
POST

### Endpoint
/pdf-lib/api/form/PDFOptionList/of

### Parameters
#### Path Parameters
- None

#### Query Parameters
- None

#### Request Body
- **acroListBox** (PDFAcroListBox) - Required - The acroListBox associated with this option list.
- **ref** (PDFRef) - Required - The unique reference for this option list.
- **doc** (PDFDocument) - Required - The document to which this option list will belong.

### Request Example
```json
{
  "acroListBox": "PDFAcroListBox",
  "ref": "PDFRef",
  "doc": "PDFDocument"
}
```

### Response
#### Success Response (200)
- **PDFOptionList‹›** - An instance of PDFOptionList.

#### Response Example
```json
{
  "instance": "PDFOptionList‹›"
}
```
```

--------------------------------

### Get All Fields

Source: https://pdf-lib.js.org/docs/api/classes/pdfform

Retrieves an array of all PDF fields contained within the form.

```APIDOC
## GET /pdfDoc.getForm().getFields()

### Description
Get all fields contained in this PDFForm.

### Method
GET

### Endpoint
`/pdfDoc.getForm().getFields()`

### Response
#### Success Response (200)
- **PDFField[]** - An array of all fields in this form.

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

--------------------------------

### Create PDFImage instance (advanced)

Source: https://pdf-lib.js.org/docs/api/classes/pdfimage

Create an instance of PDFImage from an existing ref and embedder. Note: PDFDocument.embedPng and PDFDocument.embedJpg are the recommended methods for creating PDFImage instances.

```javascript
PDFImage.of(ref, doc, embedder)
```

--------------------------------

### Get Form API

Source: https://pdf-lib.js.org/docs/api/classes/pdfdocument

Access the PDF form object to interact with form fields.

```APIDOC
## GET /document/form

### Description
Retrieves the PDFForm object, which contains all interactive fields for the document.

### Method
GET

### Endpoint
`/document/form`

### Parameters
None

### Response
#### Success Response (200)
- **PDFForm** - The form object for the document, allowing access to its fields.

#### Response Example
```javascript
// Assuming pdfDoc is an instance of PDFDocument
const form = pdfDoc.getForm()
const fields = form.getFields()
fields.forEach(field => {
  const type = field.constructor.name
  const name = field.getName()
  console.log(`${type}: ${name}`)
})
```
```

--------------------------------

### PDFOptionList Methods

Source: https://pdf-lib.js.org/docs/api/classes/pdfoptionlist

Documentation for the methods available on the PDFOptionList class, such as addOptions, addToPage, clear, and more.

```APIDOC
## Methods

### addOptions
▸ **addOptions**(`options`: string | string[]): _void_
_Defined in api/form/PDFOptionList.ts:176_
Add to the list of options that are available for this option list. Users will be able to select these values in a PDF reader. In addition to the values passed as `options`, any preexisting options for this option list will still be available for users to select. For example:
```javascript
const optionList = form.getOptionList('rockets.optionList')
optionList.addOptions(['Saturn IV', 'Falcon Heavy'])
```

This method will mark this option list as dirty. See PDFOptionList.setOptions for more details about what this means.

**Parameters:**
Name| Type| Description  
---|---|---  
`options`| string | string[]| New options that should be available in this option list.

**Returns:** _void_

* * *

### addToPage
▸ **addToPage**(`page`: PDFPage, `options?`: FieldAppearanceOptions): _void_
_Defined in api/form/PDFOptionList.ts:448_
Show this option list on the specified page. For example:
```javascript
const ubuntuFont = await pdfDoc.embedFont(ubuntuFontBytes)
const page = pdfDoc.addPage()

const form = pdfDoc.getForm()
const optionList = form.createOptionList('best.gundams')
optionList.setOptions(['Exia', 'Dynames', 'Kyrios', 'Virtue'])
optionList.select(['Exia', 'Virtue'])

optionList.addToPage(page, {
  x: 50,
  y: 75,
  width: 200,
  height: 100,
  textColor: rgb(1, 0, 0),
  backgroundColor: rgb(0, 1, 0),
  borderColor: rgb(0, 0, 1),
  borderWidth: 2,
  rotate: degrees(90),
  font: ubuntuFont,
})
```

This will create a new widget for this option list field.

**Parameters:**
Name| Type| Description  
---|---|---  
`page`| PDFPage| The page to which this option list widget should be added.  
`options?`| FieldAppearanceOptions| The options to be used when adding this option list widget.  

**Returns:** _void_

* * *

### clear
▸ **clear**(): _void_
_Defined in api/form/PDFOptionList.ts:254_
Clear all selected values for this option list. This operation is equivalent to selecting an empty list. This method will update the underlying state of the option list to indicate that no values have been selected. For example:
```javascript
const optionList = form.getOptionList('some.optionList.field')
optionList.clear()
```

This method will mark this option list as dirty. See PDFOptionList.setOptions for more details about what this means.

**Returns:** _void_

* * *

### defaultUpdateAppearances
▸ **defaultUpdateAppearances**(`font`: PDFFont): _void_
_Overrides void_
_Defined in api/form/PDFOptionList.ts:519_
Update the appearance streams for each of this option list's widgets using the default appearance provider for option lists. For example:
```javascript
const helvetica = await pdfDoc.embedFont(StandardFonts.Helvetica)
const optionList = form.getOptionList('some.optionList.field')
optionList.defaultUpdateAppearances(helvetica)
```

**Parameters:**
Name| Type| Description  
---|---|---  
`font`| PDFFont| The font to be used for creating the appearance streams.  

**Returns:** _void_
```

--------------------------------

### Get Document Metadata

Source: https://pdf-lib.js.org/docs/api/classes/pdfdocument

Retrieve various metadata fields associated with the PDF document.

```APIDOC
## GET /document/metadata

### Description
Retrieves metadata properties of the PDF document.

### Method
GET

### Endpoint
`/document/metadata`

### Parameters
None

### Response
#### Success Response (200)
- **author** (string | undefined) - The author of the document.
- **creationDate** (Date | undefined) - The creation date of the document.
- **creator** (string | undefined) - The creator of the document.
- **keywords** (string | undefined) - The keywords associated with the document.
- **modificationDate** (Date | undefined) - The last modification date of the document.
- **producer** (string | undefined) - The producer of the document.
- **subject** (string | undefined) - The subject of the document.

#### Response Example
```json
{
  "author": "John Doe",
  "creationDate": "2023-10-27T10:00:00.000Z",
  "creator": "pdf-lib.js",
  "keywords": "example, pdf, metadata",
  "modificationDate": "2023-10-27T11:00:00.000Z",
  "producer": "pdf-lib.js",
  "subject": "Document Subject"
}
```
```

--------------------------------

### Create a PDF Form

Source: https://pdf-lib.js.org/

Demonstrates how to create various form fields including text fields, radio groups, checkboxes, dropdowns, and option lists.

```javascript
import { PDFDocument } from 'pdf-lib'

async function createForm() {
  const pdfDoc = await PDFDocument.create()

  const page = pdfDoc.addPage([550, 750])

  const form = pdfDoc.getForm()

  page.drawText('Enter your favorite superhero:', { x: 50, y: 700, size: 20 })

  const superheroField = form.createTextField('favorite.superhero')
  superheroField.setText('One Punch Man')
  superheroField.addToPage(page, { x: 55, y: 640 })

  page.drawText('Select your favorite rocket:', { x: 50, y: 600, size: 20 })

  page.drawText('Falcon Heavy', { x: 120, y: 560, size: 18 })
  page.drawText('Saturn IV', { x: 120, y: 500, size: 18 })
  page.drawText('Delta IV Heavy', { x: 340, y: 560, size: 18 })
  page.drawText('Space Launch System', { x: 340, y: 500, size: 18 })

  const rocketField = form.createRadioGroup('favorite.rocket')
  rocketField.addOptionToPage('Falcon Heavy', page, { x: 55, y: 540 })
  rocketField.addOptionToPage('Saturn IV', page, { x: 55, y: 480 })
  rocketField.addOptionToPage('Delta IV Heavy', page, { x: 275, y: 540 })
  rocketField.addOptionToPage('Space Launch System', page, { x: 275, y: 480 })
  rocketField.select('Saturn IV')

  page.drawText('Select your favorite gundams:', { x: 50, y: 440, size: 20 })

  page.drawText('Exia', { x: 120, y: 400, size: 18 })
  page.drawText('Kyrios', { x: 120, y: 340, size: 18 })
  page.drawText('Virtue', { x: 340, y: 400, size: 18 })
  page.drawText('Dynames', { x: 340, y: 340, size: 18 })

  const exiaField = form.createCheckBox('gundam.exia')
  const kyriosField = form.createCheckBox('gundam.kyrios')
  const virtueField = form.createCheckBox('gundam.virtue')
  const dynamesField = form.createCheckBox('gundam.dynames')

  exiaField.addToPage(page, { x: 55, y: 380 })
  kyriosField.addToPage(page, { x: 55, y: 320 })
  virtueField.addToPage(page, { x: 275, y: 380 })
  dynamesField.addToPage(page, { x: 275, y: 320 })

  exiaField.check()
  dynamesField.check()

  page.drawText('Select your favorite planet*:', { x: 50, y: 280, size: 20 })

  const planetsField = form.createDropdown('favorite.planet')
  planetsField.addOptions(['Venus', 'Earth', 'Mars', 'Pluto'])
  planetsField.select('Pluto')
  planetsField.addToPage(page, { x: 55, y: 220 })

  page.drawText('Select your favorite person:', { x: 50, y: 180, size: 18 })

  const personField = form.createOptionList('favorite.person')
  personField.addOptions([
    'Julius Caesar',
    'Ada Lovelace',
    'Cleopatra',
    'Aaron Burr',
    'Mark Antony',
  ])
  personField.select('Ada Lovelace')
  personField.addToPage(page, { x: 55, y: 70 })

  page.drawText(`* Pluto should be a planet too!`, { x: 15, y: 15, size: 15 })

  const pdfBytes = await pdfDoc.save()
}
```

--------------------------------

### Get Reading Direction

Source: https://pdf-lib.js.org/docs/api/classes/viewerpreferences

Retrieves the predominant reading order for text within the document.

```typescript
getReadingDirection()
```

--------------------------------

### Create PDFOptionList Instance with pdf-lib

Source: https://pdf-lib.js.org/docs/api/classes/pdfoptionlist

Creates a PDFOptionList instance from an existing acroListBox and PDFRef. It is recommended to use PDFForm.getOptionList instead of calling this static method directly.

```javascript
PDFOptionList.of(acroListBox, ref, doc)
```

--------------------------------

### beginText

Source: https://pdf-lib.js.org/docs/api

Begins a text object, setting the text matrix and text line matrix to the identity matrix.

```APIDOC
## beginText

### Description
Begins a text object, setting the text matrix and text line matrix to the identity matrix.

### Method
`beginText`

### Returns
- **PDFOperator‹›** - The PDF operator for beginning a text object.
```

--------------------------------

### PDF Field - Get Name

Source: https://pdf-lib.js.org/docs/api/classes/pdfcheckbox

Retrieves the fully qualified name of a PDF field.

```APIDOC
## PDFField.getName()

### Description
Get the fully qualified name of this field. PDF fields are structured as a tree, and this method returns the complete name from the root.

### Method
`getName()`

### Endpoint
N/A (Method on PDFField object)

### Parameters
None

### Request Body
None

### Response
#### Success Response (200)
- **string** - The fully qualified name of this field.

### Response Example
```javascript
const fields = form.getFields()
fields.forEach(field => {
  const name = field.getName()
  console.log('Field name:', name)
})
```
```

--------------------------------

### LayoutCombedTextOptions

Source: https://pdf-lib.js.org/docs/api/interfaces/layoutcombedtextoptions

Defines the options for laying out text in a combed manner.

```APIDOC
## LayoutCombedTextOptions

### Description
Options for configuring the layout of text in a combed fashion.

### Properties
#### bounds (LayoutBounds)
- Required - Defines the bounding box for the text layout.

#### cellCount (number)
- Required - The number of cells to use for the combed text layout.

#### font (PDFFont)
- Required - The font to be used for the text.

#### fontSize (number)
- Optional - The size of the font. If not provided, a default size will be used.
```

--------------------------------

### Get All PDF Pages

Source: https://pdf-lib.js.org/docs/api/classes/pdfdocument

Retrieve an array containing all PDF pages in the document, ordered as they are rendered.

```javascript
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

```

--------------------------------

### Create PDFPage Instance (Static)

Source: https://pdf-lib.js.org/docs/api/classes/pdfpage

The static create method is used to instantiate a PDFPage. However, it's recommended to use PDFDocument.addPage or PDFDocument.insertPage for creating pages.

```javascript
PDFPage.create(doc)
```

--------------------------------

### Create a New PDF Document

Source: https://pdf-lib.js.org/

Initializes a new PDF document, embeds a standard font, and draws text onto a new page.

```javascript
import { PDFDocument, StandardFonts, rgb } from 'pdf-lib'

async function createPdf() {
  const pdfDoc = await PDFDocument.create()
  const timesRomanFont = await pdfDoc.embedFont(StandardFonts.TimesRoman)

  const page = pdfDoc.addPage()
  const { width, height } = page.getSize()
  const fontSize = 30
  page.drawText('Creating PDFs in JavaScript is awesome!', {
    x: 50,
    y: height - 4 * fontSize,
    size: fontSize,
    font: timesRomanFont,
    color: rgb(0, 0.53, 0.71),
  })

  const pdfBytes = await pdfDoc.save()
}
```

--------------------------------

### Get Page Position

Source: https://pdf-lib.js.org/docs/api/classes/pdfpage

Retrieves the default x and y coordinates representing the page's position.

```javascript
const { x, y } = page.getPosition()
```

--------------------------------

### LoadOptions

Source: https://pdf-lib.js.org/docs/api/interfaces/loadoptions

Configuration options for loading and parsing PDF documents.

```APIDOC
## LoadOptions

### Description
Options that can be passed to the `PDFDocument.load()` method to control how a PDF document is loaded and parsed.

### Properties

#### `Optional` capNumbers
- **capNumbers** (boolean) - If true, numbers will be "capped" at their maximum value. Defaults to false.

#### `Optional` ignoreEncryption
- **ignoreEncryption** (boolean) - If true, encryption will be ignored. Defaults to false.

#### `Optional` parseSpeed
- **parseSpeed** (ParseSpeeds | number) - Controls the speed at which the PDF is parsed. Can be a predefined speed or a number.

#### `Optional` throwOnInvalidObject
- **throwOnInvalidObject** (boolean) - If true, an error will be thrown if an invalid object is encountered. Defaults to false.

#### `Optional` updateMetadata
- **updateMetadata** (boolean) - If true, metadata will be updated. Defaults to false.

### Request Example
```json
{
  "capNumbers": true,
  "ignoreEncryption": false,
  "parseSpeed": "fast",
  "throwOnInvalidObject": true,
  "updateMetadata": false
}
```

### Response
This section describes the properties of the LoadOptions object itself, not a response from an API endpoint.
```

--------------------------------

### Get Page Information

Source: https://pdf-lib.js.org/docs/api/classes/pdfdocument

Retrieve specific pages, the total page count, or arrays of all pages and their indices.

```APIDOC
## GET /document/pages

### Description
Provides access to pages within the PDF document.

### Method
GET

### Endpoint
`/document/pages`

### Parameters
#### Query Parameters
- **index** (number) - Required - The zero-based index of the page to retrieve.

### Response
#### Success Response (200)
- **PDFPage** - The PDF page object at the specified index.
- **pageCount** (number) - The total number of pages in the document.
- **pageIndices** (number[]) - An array of indices for all pages.
- **pages** (PDFPage[]) - An array of all PDF page objects in the document.

#### Response Example (getPage)
```javascript
// Get the first page (index 0)
const firstPage = pdfDoc.getPage(0)
```

#### Response Example (getPageCount)
```javascript
const totalPages = pdfDoc.getPageCount()
console.log(`Total pages: ${totalPages}`)
```

#### Response Example (getPageIndices)
```javascript
const indices = pdfDoc.getPageIndices()
console.log(indices) // => [0, 1, 2]
```

#### Response Example (getPages)
```javascript
const pages = pdfDoc.getPages()
pages.forEach((page, index) => {
  console.log(`Page ${index}: ${page.toString()}`)
})
```
```

--------------------------------

### Fill PDF Form Fields and Embed Images

Source: https://pdf-lib.js.org/

Demonstrates how to load a PDF form, populate text fields, and embed images into button fields using pdf-lib.

```javascript
import { PDFDocument } from 'pdf-lib'

async function fillForm() {
  const formUrl = 'https://pdf-lib.js.org/assets/dod_character.pdf'
  const formPdfBytes = await fetch(formUrl).then(res => res.arrayBuffer())

  const marioUrl = 'https://pdf-lib.js.org/assets/small_mario.png'
  const marioImageBytes = await fetch(marioUrl).then(res => res.arrayBuffer())

  const emblemUrl = 'https://pdf-lib.js.org/assets/mario_emblem.png'
  const emblemImageBytes = await fetch(emblemUrl).then(res => res.arrayBuffer())

  const pdfDoc = await PDFDocument.load(formPdfBytes)

  const marioImage = await pdfDoc.embedPng(marioImageBytes)
  const emblemImage = await pdfDoc.embedPng(emblemImageBytes)

  const form = pdfDoc.getForm()

  const nameField = form.getTextField('CharacterName 2')
  const ageField = form.getTextField('Age')
  const heightField = form.getTextField('Height')
  const weightField = form.getTextField('Weight')
  const eyesField = form.getTextField('Eyes')
  const skinField = form.getTextField('Skin')
  const hairField = form.getTextField('Hair')

  const alliesField = form.getTextField('Allies')
  const factionField = form.getTextField('FactionName')
  const backstoryField = form.getTextField('Backstory')
  const traitsField = form.getTextField('Feat+Traits')
  const treasureField = form.getTextField('Treasure')

  const characterImageField = form.getButton('CHARACTER IMAGE')
  const factionImageField = form.getButton('Faction Symbol Image')

  nameField.setText('Mario')
  ageField.setText('24 years')
  heightField.setText(`5' 1"`)
  weightField.setText('196 lbs')
  eyesField.setText('blue')
  skinField.setText('white')
  hairField.setText('brown')

  characterImageField.setImage(marioImage)

  alliesField.setText(
    [
      `Allies:`,
      `  • Princess Daisy`,
      `  • Princess Peach`,
      `  • Rosalina`,
      `  • Geno`,
      `  • Luigi`,
      `  • Donkey Kong`,
      `  • Yoshi`,
      `  • Diddy Kong`,
      ``,
      `Organizations:`,
      `  • Italian Plumbers Association`,
    ].join('\n'),
  )

  factionField.setText(`Mario's Emblem`)

  factionImageField.setImage(emblemImage)

  backstoryField.setText(
    [
      `Mario is a fictional character in the Mario video game franchise, `,
      `owned by Nintendo and created by Japanese video game designer Shigeru `,
      `Miyamoto. Serving as the company's mascot and the eponymous `,
      `protagonist of the series, Mario has appeared in over 200 video games `,
      `since his creation. Depicted as a short, pudgy, Italian plumber who `,
      `resides in the Mushroom Kingdom, his adventures generally center `,
      `upon rescuing Princess Peach from the Koopa villain Bowser. His `,
      `younger brother and sidekick is Luigi.`,
    ].join('\n'),
  )

  traitsField.setText(
    [
      `Mario can use three basic three power-ups:`,
      `  • the Super Mushroom, which causes Mario to grow larger`,
      `  • the Fire Flower, which allows Mario to throw fireballs`,
      `  • the Starman, which gives Mario temporary invincibility`,
    ].join('\n'),
  )

  treasureField.setText(['• Gold coins', '• Treasure chests'].join('\n'))

  const pdfBytes = await pdfDoc.save()
}
```

--------------------------------

### Get Total PDF Page Count

Source: https://pdf-lib.js.org/docs/api/classes/pdfdocument

Retrieve the total number of pages contained within the PDF document.

```javascript
const totalPages = pdfDoc.getPageCount()

```

--------------------------------

### Static of

Source: https://pdf-lib.js.org/docs/api/classes/pdfpage

Creates an instance of PDFPage from an existing leaf node. It is recommended to use `PDFDocument.addPage` or `PDFDocument.insertPage` instead.

```APIDOC
## Static of

### Description
Create an instance of PDFPage from an existing leaf node. Note: It is recommended to use `PDFDocument.addPage` or `PDFDocument.insertPage` instead of calling this method directly.

### Method
POST

### Endpoint
/websites/pdf-lib_js/api/PDFPage.ts

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **leafNode** (PDFPageLeaf) - Required - The leaf node to be wrapped.
- **ref** (PDFRef) - Required - The unique reference for the page.
- **doc** (PDFDocument) - Required - The document to which the page will belong.

### Request Example
```json
{
  "leafNode": "PDFPageLeaf_instance",
  "ref": "PDFRef_instance",
  "doc": "PDFDocument_instance"
}
```

### Response
#### Success Response (200)
- **PDFPage** (PDFPage) - An instance of PDFPage.

#### Response Example
```json
{
  "instance": "PDFPage_instance"
}
```
```

--------------------------------

### beginMarkedContent Function

Source: https://pdf-lib.js.org/docs/api/index

Begins a marked content sequence.

```APIDOC
## POST /api/operators/beginMarkedContent

### Description
Begins a marked content sequence.

### Method
POST

### Endpoint
/api/operators/beginMarkedContent

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **tag** (string | PDFName) - Required - The tag for the marked content.

### Request Example
```json
{
  "tag": "MyTag"
}
```

### Response
#### Success Response (200)
- **Type**: PDFOperator

#### Response Example
```json
{
  "type": "PDFOperator",
  "operator": "Begin Marked Content"
}
```
```

--------------------------------

### Get All PDF Fields

Source: https://pdf-lib.js.org/docs/api/classes/pdfform

Retrieves an array of all form fields within the PDF. Useful for iterating and inspecting all fields.

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

--------------------------------

### Get PDFEmbeddedPage Size

Source: https://pdf-lib.js.org/docs/api/classes/pdfembeddedpage

Retrieve the current width and height of a PDFEmbeddedPage. This is often used to calculate drawing dimensions.

```javascript
const { width, height } = embeddedPage.size()
```

--------------------------------

### beginMarkedContent

Source: https://pdf-lib.js.org/docs/api

Begins a marked content sequence with a specified tag.

```APIDOC
## beginMarkedContent

### Description
Begins a marked content sequence with a specified tag.

### Method
`beginMarkedContent`

### Parameters
#### Path Parameters
- **tag** (string | PDFName) - Required - The tag for the marked content sequence.

### Returns
- **PDFOperator‹›** - The PDF operator for beginning marked content.
```

--------------------------------

### Static of

Source: https://pdf-lib.js.org/docs/api/classes/pdfform

Creates an instance of PDFForm from an existing acroForm and embedder.

```APIDOC
## Static of

### Description
Create an instance of PDFForm from an existing acroForm and embedder. It is recommended to use `PDFDocument.getForm()` instead of calling this directly.

### Method
`PDFForm.of`

### Parameters
#### Path Parameters
- **acroForm** (PDFAcroForm) - Required - The underlying `PDFAcroForm` for this form.
- **doc** (PDFDocument) - Required - The document to which the form will belong.

### Response
#### Success Response (200)
- **PDFForm** - An instance of PDFForm.
```

--------------------------------

### GET /getTitle

Source: https://pdf-lib.js.org/docs/api/classes/pdfdocument

Retrieves the title metadata of the PDF document. This title is displayed in the 'Document Properties' section of PDF viewers.

```APIDOC
## GET /getTitle

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

### Method
GET

### Endpoint
/getTitle

### Response
#### Success Response (200)
- **title** (string | undefined) - A string containing the title of this document, if it has one.

### Response Example
{
  "title": "My Document Title"
}
```

--------------------------------

### Static Method: PDFDropdown.of

Source: https://pdf-lib.js.org/docs/api/classes/pdfdropdown

Creates an instance of PDFDropdown from an existing acroComboBox and ref. It is recommended to use PDFForm.getDropdown instead.

```APIDOC
## Static Method: PDFDropdown.of

### Description
Create an instance of PDFDropdown from an existing acroComboBox and ref. You probably don't want to call this method directly. Instead, consider using the PDFForm.getDropdown method, which will create an instance of PDFDropdown for you.

### Method
Static

### Endpoint
N/A (Static method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (Instance of PDFDropdown)
- **Type**: PDFDropdown
- **Description**: An instance of the PDFDropdown class.

#### Response Example
```json
{
  "message": "Instance of PDFDropdown created"
}
```
```

--------------------------------

### Get Page Width

Source: https://pdf-lib.js.org/docs/api/classes/pdfpage

Retrieves the width of the PDF page. This method relies on PDFPage.getSize to determine the page's dimensions.

```javascript
const width = page.getWidth()
```

--------------------------------

### LayoutSinglelineTextOptions

Source: https://pdf-lib.js.org/docs/api/interfaces/layoutsinglelinetextoptions

Options for configuring single-line text layout.

```APIDOC
## LayoutSinglelineTextOptions

### Description
Options for configuring single-line text layout.

### Properties
#### alignment
- **alignment** (TextAlignment) - Required - The text alignment.

#### bounds
- **bounds** (LayoutBounds) - Required - The bounding box for the text.

#### font
- **font** (PDFFont) - Required - The font to use for the text.

#### fontSize
- **fontSize** (undefined | number) - Optional - The size of the font.
```

--------------------------------

### Get Field by Name (Optional)

Source: https://pdf-lib.js.org/docs/api/classes/pdfform

Retrieves a PDF field by its fully qualified name. Returns undefined if the field does not exist.

```APIDOC
## GET /pdfDoc.getForm().getFieldMaybe(name: string)

### Description
Get the field in this PDFForm with the given name. Returns `undefined` if no field exists with the provided name.

### Method
GET

### Endpoint
`/pdfDoc.getForm().getFieldMaybe(name)`

### Parameters
#### Path Parameters
- **name** (string) - Required - A fully qualified field name.

### Response
#### Success Response (200)
- **PDFField | undefined** - The field with the specified name, if one exists.

### Request Example
```javascript
const form = pdfDoc.getForm()
const field = form.getFieldMaybe('Page1.Foo.Bar[0]')
if (field) console.log('Field exists!')
```
```

--------------------------------

### Get Page Height

Source: https://pdf-lib.js.org/docs/api/classes/pdfpage

Retrieves the height of the PDF page. This method relies on PDFPage.getSize to determine the page's dimensions.

```javascript
const height = page.getHeight()
```

--------------------------------

### Static create

Source: https://pdf-lib.js.org/docs/api/classes/pdfpage

Creates an instance of PDFPage. It is recommended to use `PDFDocument.addPage` or `PDFDocument.insertPage` instead.

```APIDOC
## Static create

### Description
Create an instance of PDFPage. Note: It is recommended to use `PDFDocument.addPage` or `PDFDocument.insertPage` instead of calling this method directly.

### Method
POST

### Endpoint
/websites/pdf-lib_js/api/PDFPage.ts

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **doc** (PDFDocument) - Required - The document to which the page will belong.

### Request Example
```json
{
  "doc": "PDFDocument_instance"
}
```

### Response
#### Success Response (200)
- **PDFPage** (PDFPage) - A new instance of PDFPage.

#### Response Example
```json
{
  "instance": "PDFPage_instance"
}
```
```

--------------------------------

### Get PDF Signature Field

Source: https://pdf-lib.js.org/docs/api/classes/pdfform

Retrieves a signature field by name. Throws an error if the field doesn't exist or is not a signature.

```javascript
const form = pdfDoc.getForm()
const signature = form.getSignature('Page1.Foo.Signature[0]')
```

--------------------------------

### PDFDocument.create

Source: https://pdf-lib.js.org/docs/api/classes/pdfdocument

Creates a new PDFDocument instance. This is the entry point for creating or manipulating PDF documents.

```APIDOC
## Static create

### Description
Create a new PDFDocument.

### Method
Static

### Endpoint
N/A (Static method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```javascript
const pdfDoc = await PDFDocument.create();
```

### Response
#### Success Response (200)
- **PDFDocument** (Promise<PDFDocument>) - Resolves with the newly created document.

#### Response Example
```json
// A PDFDocument instance
```
```

--------------------------------

### Create PDFPage Instance from Leaf Node (Static)

Source: https://pdf-lib.js.org/docs/api/classes/pdfpage

The static of method creates a PDFPage instance from an existing leaf node. Similar to create, using PDFDocument methods is generally preferred.

```javascript
PDFPage.of(leafNode, ref, doc)
```

--------------------------------

### Get Text Field Alignment

Source: https://pdf-lib.js.org/docs/api/classes/pdftextfield

Retrieves the text alignment for a text field. Possible values are Left, Center, and Right.

```javascript
const textField = form.getTextField('some.text.field')
const alignment = textField.getAlignment()
if (alignment === TextAlignment.Left) console.log('Text is left justified')
if (alignment === TextAlignment.Center) console.log('Text is centered')
if (alignment === TextAlignment.Right) console.log('Text is right justified')
```

--------------------------------

### PDFFont Class Overview

Source: https://pdf-lib.js.org/docs/api/classes/pdffont

Provides an overview of the PDFFont class, its hierarchy, implemented interfaces, and a summary of its properties and methods.

```APIDOC
## PDFFont Class

Represents a font that has been embedded in a PDFDocument.

### Hierarchy
* **PDFFont**

### Implements
* Embeddable

### Index
#### Properties
* doc
* name
* ref

#### Methods
* embed
* encodeText
* getCharacterSet
* heightAtSize
* sizeAtHeight
* widthOfTextAtSize
* of
```

--------------------------------

### Get PDF Document Title

Source: https://pdf-lib.js.org/docs/api/classes/pdfdocument

Retrieves the title metadata of the PDF document. This title is displayed in the 'Document Properties' of PDF readers.

```javascript
const title = pdfDoc.getTitle()
```

--------------------------------

### beginText Function

Source: https://pdf-lib.js.org/docs/api/index

Begins a text object.

```APIDOC
## POST /api/operators/beginText

### Description
Begins a text object.

### Method
POST

### Endpoint
/api/operators/beginText

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **Type**: PDFOperator

#### Response Example
```json
{
  "type": "PDFOperator",
  "operator": "Begin Text"
}
```
```

--------------------------------

### Get PDF Document Subject

Source: https://pdf-lib.js.org/docs/api/classes/pdfdocument

Retrieve the subject metadata of a PDF document. This information is visible in the 'Document Properties' of most PDF readers.

```javascript
const subject = pdfDoc.getSubject()

```

--------------------------------

### Get PDF Document Producer

Source: https://pdf-lib.js.org/docs/api/classes/pdfdocument

Retrieve the producer metadata of a PDF document. This information is visible in the 'Document Properties' of most PDF readers.

```javascript
const producer = pdfDoc.getProducer()

```

--------------------------------

### Get PDF Document Keywords

Source: https://pdf-lib.js.org/docs/api/classes/pdfdocument

Retrieve the keywords metadata of a PDF document. This information is visible in the 'Document Properties' of most PDF readers.

```javascript
const keywords = pdfDoc.getKeywords()

```

--------------------------------

### Set Fit Window Preference

Source: https://pdf-lib.js.org/docs/api/classes/viewerpreferences

Configures whether the PDF reader should resize the document window to fit the first page.

```typescript
viewerPrefs.setFitWindow(true)
```

--------------------------------

### Static load

Source: https://pdf-lib.js.org/docs/api/classes/pdfdocument

Loads an existing PDFDocument from various input formats.

```APIDOC
## Static load

### Description
Load an existing PDFDocument. The input data can be provided in multiple formats:

| Type         | Contents                                   |
|--------------|--------------------------------------------|
| `string`     | A base64 encoded string (or data URI) containing a PDF |
| `Uint8Array` | The raw bytes of a PDF                     |
| `ArrayBuffer`| The raw bytes of a PDF                     |

### Method
`static load`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```javascript
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+EWmAKZW5kc3RyZWFtCmVuZG9iagoKNyAwIG9iago8PAovU2' +
 'l6ZSA4Ci9Sb290IDIgMCBSCi9GaWx0ZXIgL0ZsYXRlRGVjb2RlCi9UeXBlIC9YUmVmCi9M' +
 'ZW5ndGggMzgKL1cgWyAxIDIgMiBdCi9JbmRleCBbIDAgOCBdCj4+CnN0cmVhbQp4nBXEwR' +
 'EAQBAEsCwz3vrvRmOOyyOoGhZdutHN2MT55fIAVocD+AplbmRzdHJlYW0KZW5kb2JqCgpz' +
 'dGFydHhyZWYKNTEwCiUlRU9G'

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
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Response
#### Success Response (200)
- **PDFDocument** (PDFDocument) - Resolves with a document loaded from the input.

#### Response Example
```json
{
  "example": "PDFDocument object"
}
```
```

--------------------------------

### Get PDF Document Creator

Source: https://pdf-lib.js.org/docs/api/classes/pdfdocument

Retrieve the creator metadata of a PDF document. This information is visible in the 'Document Properties' of most PDF readers.

```javascript
const creator = pdfDoc.getCreator()

```
Tokens:
Raw