PageRange

このコンテンツはまだ日本語訳がありません。

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

Specifies a range of pages to render.

Both start and end are 1-indexed and inclusive. If omitted, start defaults to 1 and end defaults to the last page.

Example

// Render pages 1-5
for await (const page of pdf.renderPages({ pages: { start: 1, end: 5 } })) {
  // ...
}

// Render from page 3 to the end
for await (const page of pdf.renderPages({ pages: { start: 3 } })) {
  // ...
}

// Render first 10 pages
for await (const page of pdf.renderPages({ pages: { end: 10 } })) {
  // ...
}

Properties

end?

optional end: number

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

End page number (1-indexed, inclusive).

Default Value

Last page of the document

start?

optional start: number

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

Start page number (1-indexed, inclusive).