github/puppeteer
0
0
Fork 0
mirror of https://github.com/puppeteer/puppeteer synced 2024-06-14 14:02:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

chore(docs): migrate page.pdf() docs (#6228)

Browse Source 
Also took the opportunity to pull out the PDF types into their own file
to clear up `Page.ts` slightly and give the PDF code a more natural
place to live.
This commit is contained in:
Jack Franklin 2020-07-17 13:58:56 +01:00 committed by GitHub
parent 2331584467
commit 9fdf2ba280
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
29 changed files with 587 additions and 47 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
new-docs/puppeteer.md
View File

@ -69,6 +69,8 @@
| [Metrics](./puppeteer.metrics.md) | |
| [MouseOptions](./puppeteer.mouseoptions.md) | |
| [MouseWheelOptions](./puppeteer.mousewheeloptions.md) | |
| [PDFMargin](./puppeteer.pdfmargin.md) | |
| [PDFOptions](./puppeteer.pdfoptions.md) | Valid options to configure PDF generation via [Page.pdf()](./puppeteer.page.pdf.md)<!-- -->. |
| [PressOptions](./puppeteer.pressoptions.md) | |
| [ProductLauncher](./puppeteer.productlauncher.md) | Describes a launcher - a class that is able to create and launch a browser instance. |
| [RemoteAddress](./puppeteer.remoteaddress.md) | |
@ -108,6 +110,7 @@
| [JSONArray](./puppeteer.jsonarray.md) | |
| [KeyInput](./puppeteer.keyinput.md) | All the valid keys that can be passed to functions that take user input, such as [keyboard.press](./puppeteer.keyboard.press.md) |
| [MouseButton](./puppeteer.mousebutton.md) | |
| [PaperFormat](./puppeteer.paperformat.md) | All the valid paper format types when printing a PDF. |
| [Platform](./puppeteer.platform.md) | Supported platforms. |
| [Product](./puppeteer.product.md) | Supported products. |
| [PuppeteerErrors](./puppeteer.puppeteererrors.md) | |

4
new-docs/puppeteer.page.md
View File

@ -107,8 +107,8 @@ page.off('request', logRequest);
| [isJavaScriptEnabled()](./puppeteer.page.isjavascriptenabled.md) | | |
| [mainFrame()](./puppeteer.page.mainframe.md) | | |
| [metrics()](./puppeteer.page.metrics.md) | | |
| [pdf(options)](./puppeteer.page.pdf.md) | | |
| [queryObjects(prototypeHandle)](./puppeteer.page.queryobjects.md) | | |
| [pdf(options)](./puppeteer.page.pdf.md) | | Generatees a PDF of the page with the <code>print</code> CSS media type. |
| [queryObjects(prototypeHandle)](./puppeteer.page.queryobjects.md) | | This method iterates the JavaScript heap and finds all objects with the given prototype. |
| [reload(options)](./puppeteer.page.reload.md) | | |
| [screenshot(options)](./puppeteer.page.screenshot.md) | | |
| [select(selector, values)](./puppeteer.page.select.md) | | |

12
new-docs/puppeteer.page.pdf.md
View File

@ -4,6 +4,8 @@
## Page.pdf() method
Generatees a PDF of the page with the `print` CSS media type.
<b>Signature:</b>
```typescript
@ -14,9 +16,17 @@ pdf(options?: PDFOptions): Promise<Buffer>;
| Parameter | Type | Description |
| --- | --- | --- |
| options | PDFOptions | |
| options | [PDFOptions](./puppeteer.pdfoptions.md) | options for generating the PDF. |
<b>Returns:</b>
Promise&lt;Buffer&gt;
## Remarks
IMPORTANT: PDF generation is only supported in Chrome headless mode.
To generate a PDF with the `screen` media type, call [\`page.emulateMediaType('screen')\`](./puppeteer.page.emulatemediatype.md) before calling `page.pdf()`<!-- -->.
By default, `page.pdf()` generates a pdf with modified colors for printing. Use the [\`-webkit-print-color-adjust\`](https://developer.mozilla.org/en-US/docs/Web/CSS/-webkit-print-color-adjust) property to force rendering of exact colors.

24
new-docs/puppeteer.page.queryobjects.md
View File

@ -4,6 +4,8 @@
## Page.queryObjects() method
This method iterates the JavaScript heap and finds all objects with the given prototype.
<b>Signature:</b>
```typescript
@ -14,9 +16,29 @@ queryObjects(prototypeHandle: JSHandle): Promise<JSHandle>;
| Parameter | Type | Description |
| --- | --- | --- |
| prototypeHandle | [JSHandle](./puppeteer.jshandle.md) | |
| prototypeHandle | [JSHandle](./puppeteer.jshandle.md) | a handle to the object prototype. |
<b>Returns:</b>
Promise&lt;[JSHandle](./puppeteer.jshandle.md)<!-- -->&gt;
## Remarks
## Example
```js
// Create a Map object
await page.evaluate(() => window.map = new Map());
// Get a handle to the Map object prototype
const mapPrototype = await page.evaluateHandle(() => Map.prototype);
// Query all map instances into an array
const mapInstances = await page.queryObjects(mapPrototype);
// Count amount of map objects in heap
const count = await page.evaluate(maps => maps.length, mapInstances);
await mapInstances.dispose();
await mapPrototype.dispose();
```

38
new-docs/puppeteer.paperformat.md Normal file
View File

@ -0,0 +1,38 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [PaperFormat](./puppeteer.paperformat.md)
## PaperFormat type
All the valid paper format types when printing a PDF.
<b>Signature:</b>
```typescript
export declare type PaperFormat = 'letter' | 'legal' | 'tabloid' | 'ledger' | 'a0' | 'a1' | 'a2' | 'a3' | 'a4' | 'a5' | 'a6';
```
## Remarks
The sizes of each format are as follows: - `Letter`<!-- -->: 8.5in x 11in
- `Legal`<!-- -->: 8.5in x 14in
- `Tabloid`<!-- -->: 11in x 17in
- `Ledger`<!-- -->: 17in x 11in
- `A0`<!-- -->: 33.1in x 46.8in
- `A1`<!-- -->: 23.4in x 33.1in
- `A2`<!-- -->: 16.54in x 23.4in
- `A3`<!-- -->: 11.7in x 16.54in
- `A4`<!-- -->: 8.27in x 11.7in
- `A5`<!-- -->: 5.83in x 8.27in
- `A6`<!-- -->: 4.13in x 5.83in

11
new-docs/puppeteer.pdfmargin.bottom.md Normal file
View File

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [PDFMargin](./puppeteer.pdfmargin.md) &gt; [bottom](./puppeteer.pdfmargin.bottom.md)
## PDFMargin.bottom property
<b>Signature:</b>
```typescript
bottom?: string | number;
```

11
new-docs/puppeteer.pdfmargin.left.md Normal file
View File

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [PDFMargin](./puppeteer.pdfmargin.md) &gt; [left](./puppeteer.pdfmargin.left.md)
## PDFMargin.left property
<b>Signature:</b>
```typescript
left?: string | number;
```

22
new-docs/puppeteer.pdfmargin.md Normal file
View File

@ -0,0 +1,22 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [PDFMargin](./puppeteer.pdfmargin.md)
## PDFMargin interface
<b>Signature:</b>
```typescript
export interface PDFMargin
```
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [bottom](./puppeteer.pdfmargin.bottom.md) | string \| number | |
| [left](./puppeteer.pdfmargin.left.md) | string \| number | |
| [right](./puppeteer.pdfmargin.right.md) | string \| number | |
| [top](./puppeteer.pdfmargin.top.md) | string \| number | |

11
new-docs/puppeteer.pdfmargin.right.md Normal file
View File

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [PDFMargin](./puppeteer.pdfmargin.md) &gt; [right](./puppeteer.pdfmargin.right.md)
## PDFMargin.right property
<b>Signature:</b>
```typescript
right?: string | number;
```

11
new-docs/puppeteer.pdfmargin.top.md Normal file
View File

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [PDFMargin](./puppeteer.pdfmargin.md) &gt; [top](./puppeteer.pdfmargin.top.md)
## PDFMargin.top property
<b>Signature:</b>
```typescript
top?: string | number;
```

13
new-docs/puppeteer.pdfoptions.displayheaderfooter.md Normal file
View File

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [PDFOptions](./puppeteer.pdfoptions.md) &gt; [displayHeaderFooter](./puppeteer.pdfoptions.displayheaderfooter.md)
## PDFOptions.displayHeaderFooter property
Whether to show the header and footer.
<b>Signature:</b>
```typescript
displayHeaderFooter?: boolean;
```

13
new-docs/puppeteer.pdfoptions.footertemplate.md Normal file
View File

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [PDFOptions](./puppeteer.pdfoptions.md) &gt; [footerTemplate](./puppeteer.pdfoptions.footertemplate.md)
## PDFOptions.footerTemplate property
HTML template for the print footer. Has the same constraints and support for special classes as [PDFOptions.headerTemplate](./puppeteer.pdfoptions.headertemplate.md)<!-- -->.
<b>Signature:</b>
```typescript
footerTemplate?: string;
```

16
new-docs/puppeteer.pdfoptions.format.md Normal file
View File

@ -0,0 +1,16 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [PDFOptions](./puppeteer.pdfoptions.md) &gt; [format](./puppeteer.pdfoptions.format.md)
## PDFOptions.format property
<b>Signature:</b>
```typescript
format?: PaperFormat;
```
## Remarks
If set, this takes priority over the `width` and `height` options.

21
new-docs/puppeteer.pdfoptions.headertemplate.md Normal file
View File

@ -0,0 +1,21 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [PDFOptions](./puppeteer.pdfoptions.md) &gt; [headerTemplate](./puppeteer.pdfoptions.headertemplate.md)
## PDFOptions.headerTemplate property
HTML template for the print header. Should be valid HTML with the following classes used to inject values into them: - `date` formatted print date
- `title` document title
- `url` document location
- `pageNumber` current page number
- `totalPages` total pages in the document
<b>Signature:</b>
```typescript
headerTemplate?: string;
```

13
new-docs/puppeteer.pdfoptions.height.md Normal file
View File

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [PDFOptions](./puppeteer.pdfoptions.md) &gt; [height](./puppeteer.pdfoptions.height.md)
## PDFOptions.height property
Sets the height of paper. You can pass in a number or a string with a unit.
<b>Signature:</b>
```typescript
height?: string | number;
```

13
new-docs/puppeteer.pdfoptions.landscape.md Normal file
View File

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [PDFOptions](./puppeteer.pdfoptions.md) &gt; [landscape](./puppeteer.pdfoptions.landscape.md)
## PDFOptions.landscape property
Whether to print in landscape orientation.
<b>Signature:</b>
```typescript
landscape?: boolean;
```

13
new-docs/puppeteer.pdfoptions.margin.md Normal file
View File

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [PDFOptions](./puppeteer.pdfoptions.md) &gt; [margin](./puppeteer.pdfoptions.margin.md)
## PDFOptions.margin property
Set the PDF margins.
<b>Signature:</b>
```typescript
margin?: PDFMargin;
```

32
new-docs/puppeteer.pdfoptions.md Normal file
View File

@ -0,0 +1,32 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [PDFOptions](./puppeteer.pdfoptions.md)
## PDFOptions interface
Valid options to configure PDF generation via [Page.pdf()](./puppeteer.page.pdf.md)<!-- -->.
<b>Signature:</b>
```typescript
export interface PDFOptions
```
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [displayHeaderFooter](./puppeteer.pdfoptions.displayheaderfooter.md) | boolean | Whether to show the header and footer. |
| [footerTemplate](./puppeteer.pdfoptions.footertemplate.md) | string | HTML template for the print footer. Has the same constraints and support for special classes as [PDFOptions.headerTemplate](./puppeteer.pdfoptions.headertemplate.md)<!-- -->. |
| [format](./puppeteer.pdfoptions.format.md) | [PaperFormat](./puppeteer.paperformat.md) | |
| [headerTemplate](./puppeteer.pdfoptions.headertemplate.md) | string | HTML template for the print header. Should be valid HTML with the following classes used to inject values into them: - <code>date</code> formatted print date<!-- -->- <code>title</code> document title<!-- -->- <code>url</code> document location<!-- -->- <code>pageNumber</code> current page number<!-- -->- <code>totalPages</code> total pages in the document |
| [height](./puppeteer.pdfoptions.height.md) | string \| number | Sets the height of paper. You can pass in a number or a string with a unit. |
| [landscape](./puppeteer.pdfoptions.landscape.md) | boolean | Whether to print in landscape orientation. |
| [margin](./puppeteer.pdfoptions.margin.md) | [PDFMargin](./puppeteer.pdfmargin.md) | Set the PDF margins. |
| [pageRanges](./puppeteer.pdfoptions.pageranges.md) | string | Paper ranges to print, e.g. <code>1-5, 8, 11-13</code>. |
| [path](./puppeteer.pdfoptions.path.md) | string | The path to save the file to. |
| [preferCSSPageSize](./puppeteer.pdfoptions.prefercsspagesize.md) | boolean | Give any CSS <code>@page</code> size declared in the page priority over what is declared in the <code>width</code> or <code>height</code> or <code>format</code> option. |
| [printBackground](./puppeteer.pdfoptions.printbackground.md) | boolean | Set to <code>true</code> to print background graphics. |
| [scale](./puppeteer.pdfoptions.scale.md) | number | Scales the rendering of the web page. Amount must be between <code>0.1</code> and <code>2</code>. |
| [width](./puppeteer.pdfoptions.width.md) | string \| number | Sets the width of paper. You can pass in a number or a string with a unit. |

13
new-docs/puppeteer.pdfoptions.pageranges.md Normal file
View File

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [PDFOptions](./puppeteer.pdfoptions.md) &gt; [pageRanges](./puppeteer.pdfoptions.pageranges.md)
## PDFOptions.pageRanges property
Paper ranges to print, e.g. `1-5, 8, 11-13`<!-- -->.
<b>Signature:</b>
```typescript
pageRanges?: string;
```

18
new-docs/puppeteer.pdfoptions.path.md Normal file
View File

@ -0,0 +1,18 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [PDFOptions](./puppeteer.pdfoptions.md) &gt; [path](./puppeteer.pdfoptions.path.md)
## PDFOptions.path property
The path to save the file to.
<b>Signature:</b>
```typescript
path?: string;
```
## Remarks
If the path is relative, it's resolved relative to the current working directory.

13
new-docs/puppeteer.pdfoptions.prefercsspagesize.md Normal file
View File

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [PDFOptions](./puppeteer.pdfoptions.md) &gt; [preferCSSPageSize](./puppeteer.pdfoptions.prefercsspagesize.md)
## PDFOptions.preferCSSPageSize property
Give any CSS `@page` size declared in the page priority over what is declared in the `width` or `height` or `format` option.
<b>Signature:</b>
```typescript
preferCSSPageSize?: boolean;
```

13
new-docs/puppeteer.pdfoptions.printbackground.md Normal file
View File

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [PDFOptions](./puppeteer.pdfoptions.md) &gt; [printBackground](./puppeteer.pdfoptions.printbackground.md)
## PDFOptions.printBackground property
Set to `true` to print background graphics.
<b>Signature:</b>
```typescript
printBackground?: boolean;
```

13
new-docs/puppeteer.pdfoptions.scale.md Normal file
View File

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [PDFOptions](./puppeteer.pdfoptions.md) &gt; [scale](./puppeteer.pdfoptions.scale.md)
## PDFOptions.scale property
Scales the rendering of the web page. Amount must be between `0.1` and `2`<!-- -->.
<b>Signature:</b>
```typescript
scale?: number;
```

13
new-docs/puppeteer.pdfoptions.width.md Normal file
View File

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [PDFOptions](./puppeteer.pdfoptions.md) &gt; [width](./puppeteer.pdfoptions.width.md)
## PDFOptions.width property
Sets the width of paper. You can pass in a number or a string with a unit.
<b>Signature:</b>
```typescript
width?: string | number;
```

1
new-docs/puppeteer.puppeteer.md
View File

@ -34,6 +34,7 @@ const puppeteer = require('puppeteer');
})();
```
Once you have created a `page` you have access to a large API to interact with the page, navigate, or find certain elements in that page. The [\`page\` documentation](./puppeteer.page.md) lists all the available methods.
## Properties

1
src/api-docs-entry.ts
View File

@ -54,6 +54,7 @@ export * from './common/NetworkManager.js';
export * from './common/WebWorker.js';
export * from './common/USKeyboardLayout.js';
export * from './common/EvalTypes.js';
export * from './common/PDFOptions.js';
export * from './common/TimeoutSettings.js';
export * from './common/LifecycleWatcher.js';
export * from 'devtools-protocol/types/protocol';

179
src/common/PDFOptions.ts Normal file
View File

@ -0,0 +1,179 @@
/**
* Copyright 2020 Google Inc. All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* @public
*/
export interface PDFMargin {
top?: string | number;
bottom?: string | number;
left?: string | number;
right?: string | number;
}
/**
* All the valid paper format types when printing a PDF.
*
* @remarks
*
* The sizes of each format are as follows:
* - `Letter`: 8.5in x 11in
*
* - `Legal`: 8.5in x 14in
*
* - `Tabloid`: 11in x 17in
*
* - `Ledger`: 17in x 11in
*
* - `A0`: 33.1in x 46.8in
*
* - `A1`: 23.4in x 33.1in
*
* - `A2`: 16.54in x 23.4in
*
* - `A3`: 11.7in x 16.54in
*
* - `A4`: 8.27in x 11.7in
*
* - `A5`: 5.83in x 8.27in
*
* - `A6`: 4.13in x 5.83in
*
* @public
*/
export type PaperFormat =
| 'letter'
| 'legal'
| 'tabloid'
| 'ledger'
| 'a0'
| 'a1'
| 'a2'
| 'a3'
| 'a4'
| 'a5'
| 'a6';
/**
* Valid options to configure PDF generation via {@link Page.pdf}.
* @public
*/
export interface PDFOptions {
/**
* Scales the rendering of the web page. Amount must be between `0.1` and `2`.
* @defaultValue 1
*/
scale?: number;
/**
* Whether to show the header and footer.
* @defaultValue false
*/
displayHeaderFooter?: boolean;
/**
* HTML template for the print header. Should be valid HTML with the following
* classes used to inject values into them:
* - `date` formatted print date
*
* - `title` document title
*
* - `url` document location
*
* - `pageNumber` current page number
*
* - `totalPages` total pages in the document
*/
headerTemplate?: string;
/**
* HTML template for the print footer. Has the same constraints and support
* for special classes as {@link PDFOptions.headerTemplate}.
*/
footerTemplate?: string;
/**
* Set to `true` to print background graphics.
* @defaultValue false
*/
printBackground?: boolean;
/**
* Whether to print in landscape orientation.
* @defaultValue = false
*/
landscape?: boolean;
/**
* Paper ranges to print, e.g. `1-5, 8, 11-13`.
* @defaultValue The empty string, which means all pages are printed.
*/
pageRanges?: string;
/**
* @remarks
* If set, this takes priority over the `width` and `height` options.
* @defaultValue `letter`.
*/
format?: PaperFormat;
/**
* Sets the width of paper. You can pass in a number or a string with a unit.
*/
width?: string | number;
/**
* Sets the height of paper. You can pass in a number or a string with a unit.
*/
height?: string | number;
/**
* Give any CSS `@page` size declared in the page priority over what is
* declared in the `width` or `height` or `format` option.
* @defaultValue `false`, which will scale the content to fit the paper size.
*/
preferCSSPageSize?: boolean;
/**
* Set the PDF margins.
* @defaultValue no margins are set.
*/
margin?: PDFMargin;
/**
* The path to save the file to.
*
* @remarks
*
* If the path is relative, it's resolved relative to the current working directory.
*
* @defaultValue the empty string, which means the PDF will not be written to disk.
*/
path?: string;
}
/**
* @internal
*/
export interface PaperFormatDimensions {
width: number;
height: number;
}
/**
* @internal
*/
export const paperFormats: Record<PaperFormat, PaperFormatDimensions> = {
letter: { width: 8.5, height: 11 },
legal: { width: 8.5, height: 14 },
tabloid: { width: 11, height: 17 },
ledger: { width: 17, height: 11 },
a0: { width: 33.1, height: 46.8 },
a1: { width: 23.4, height: 33.1 },
a2: { width: 16.54, height: 23.4 },
a3: { width: 11.7, height: 16.54 },
a4: { width: 8.27, height: 11.7 },
a5: { width: 5.83, height: 8.27 },
a6: { width: 4.13, height: 5.83 },
} as const;

83
src/common/Page.ts
View File

@ -57,6 +57,7 @@ import {
EvaluateFnReturnType,
UnwrapPromiseLike,
} from './EvalTypes.js';
import { PDFOptions, paperFormats } from './PDFOptions.js';
const writeFileAsync = promisify(fs.writeFile);
@ -151,48 +152,6 @@ interface ScreenshotOptions {
encoding?: string;
}
interface PDFMargin {
top?: string | number;
bottom?: string | number;
left?: string | number;
right?: string | number;
}
interface PDFOptions {
scale?: number;
displayHeaderFooter?: boolean;
headerTemplate?: string;
footerTemplate?: string;
printBackground?: boolean;
landscape?: boolean;
pageRanges?: string;
format?: string;
width?: string | number;
height?: string | number;
preferCSSPageSize?: boolean;
margin?: PDFMargin;
path?: string;
}
interface PaperFormat {
width: number;
height: number;
}
const paperFormats: Record<string, PaperFormat> = {
letter: { width: 8.5, height: 11 },
legal: { width: 8.5, height: 14 },
tabloid: { width: 11, height: 17 },
ledger: { width: 17, height: 11 },
a0: { width: 33.1, height: 46.8 },
a1: { width: 23.4, height: 33.1 },
a2: { width: 16.54, height: 23.4 },
a3: { width: 11.7, height: 16.54 },
a4: { width: 8.27, height: 11.7 },
a5: { width: 5.83, height: 8.27 },
a6: { width: 4.13, height: 5.83 },
} as const;
type VisionDeficiency =
| 'none'
| 'achromatopsia'
@ -832,6 +791,28 @@ export class Page extends EventEmitter {
return context.evaluateHandle<HandlerType>(pageFunction, ...args);
}
/**
* This method iterates the JavaScript heap and finds all objects with the
* given prototype.
*
* @remarks
*
* @example
*
* ```js
* // Create a Map object
* await page.evaluate(() => window.map = new Map());
* // Get a handle to the Map object prototype
* const mapPrototype = await page.evaluateHandle(() => Map.prototype);
* // Query all map instances into an array
* const mapInstances = await page.queryObjects(mapPrototype);
* // Count amount of map objects in heap
* const count = await page.evaluate(maps => maps.length, mapInstances);
* await mapInstances.dispose();
* await mapPrototype.dispose();
* ```
* @param prototypeHandle - a handle to the object prototype.
*/
async queryObjects(prototypeHandle: JSHandle): Promise<JSHandle> {
const context = await this.mainFrame().executionContext();
return context.queryObjects(prototypeHandle);
@ -1718,6 +1699,24 @@ export class Page extends EventEmitter {
}
}
/**
* Generatees a PDF of the page with the `print` CSS media type.
* @remarks
*
* IMPORTANT: PDF generation is only supported in Chrome headless mode.
*
* To generate a PDF with the `screen` media type, call
* {@link Page.emulateMediaType | `page.emulateMediaType('screen')`} before
* calling `page.pdf()`.
*
* By default, `page.pdf()` generates a pdf with modified colors for printing.
* Use the
* {@link https://developer.mozilla.org/en-US/docs/Web/CSS/-webkit-print-color-adjust | `-webkit-print-color-adjust`}
* property to force rendering of exact colors.
*
*
* @param options - options for generating the PDF.
*/
async pdf(options: PDFOptions = {}): Promise<Buffer> {
const {
scale = 1,

6
src/common/Puppeteer.ts
View File

@ -59,6 +59,11 @@ import { PUPPETEER_REVISIONS } from '../revisions.js';
* await browser.close();
* })();
* ```
*
* Once you have created a `page` you have access to a large API to interact
* with the page, navigate, or find certain elements in that page.
* The {@link Page | `page` documentation} lists all the available methods.
*
* @public
*/
export class Puppeteer {
@ -270,7 +275,6 @@ export class Puppeteer {
}
/**
*
* @param options - Set of configurable options to specify the settings
* of the BrowserFetcher.
* @returns A new BrowserFetcher instance.