RenderedPage

Defined in: packages/core/src/types.ts:247

Result of rendering a single PDF page to an image.

Contains the rendered image data and metadata about the page.

Example

for await (const page of pdf.renderPages()) {
  console.log(`Page ${page.pageNumber}/${page.totalPages}`)
  console.log(`Dimensions: ${page.width}x${page.height}`)
  await fs.writeFile(`page-${page.pageNumber}.jpg`, page.buffer)
}

Properties

buffer

buffer: Buffer

Defined in: packages/core/src/types.ts:268

Rendered image data as a Node.js Buffer.

Format depends on the format option used when rendering (JPEG or PNG).

---

height

height: number

Defined in: packages/core/src/types.ts:282

Height of the rendered image in pixels.

Affected by the scale option.

---

pageNumber

pageNumber: number

Defined in: packages/core/src/types.ts:253

Page number in the document (1-indexed).

The first page is 1, not 0.

---

totalPages

totalPages: number

Defined in: packages/core/src/types.ts:260

Total number of pages in the document.

Useful for progress reporting.

---

width

width: number

Defined in: packages/core/src/types.ts:275

Width of the rendered image in pixels.

Affected by the scale option.