thunderstrike/puppeteer
thunderstrike/puppeteer
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: use code block for single values (#9936)

Browse Source
This commit is contained in:
Nikolay Vitkov 2023-03-29 15:27:29 +02:00 committed by GitHub
parent 8d026042db
commit e0eef01f1c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
26 changed files with 99 additions and 99 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/api/puppeteer.browserconnectoptions.md
View File

@ -15,9 +15,9 @@ export interface BrowserConnectOptions
## Properties ## Properties
| Property | Modifiers | Type | Description | Default | | Property | Modifiers | Type | Description | Default |
| ----------------- | --------------------- | ----------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ------- | | ----------------- | --------------------- | ----------------------------------------------------------- | ----------------------------------------------------------------------------------------- | -------------------- |
| defaultViewport | <code>optional</code> | [Viewport](./puppeteer.viewport.md) \| null | Sets the viewport for each page. | | | defaultViewport | <code>optional</code> | [Viewport](./puppeteer.viewport.md) \| null | Sets the viewport for each page. | |
| ignoreHTTPSErrors | <code>optional</code> | boolean | Whether to ignore HTTPS errors during navigation. | false | | ignoreHTTPSErrors | <code>optional</code> | boolean | Whether to ignore HTTPS errors during navigation. | <code>false</code> |
| protocolTimeout | <code>optional</code> | number | Timeout setting for individual protocol (CDP) calls. | 180000 | | protocolTimeout | <code>optional</code> | number | Timeout setting for individual protocol (CDP) calls. | <code>180_000</code> |
| slowMo | <code>optional</code> | number | Slows down Puppeteer operations by the specified amount of milliseconds to aid debugging. | | | slowMo | <code>optional</code> | number | Slows down Puppeteer operations by the specified amount of milliseconds to aid debugging. | |
| targetFilter | <code>optional</code> | [TargetFilterCallback](./puppeteer.targetfiltercallback.md) | Callback to decide if Puppeteer should connect to a given target or not. | | | targetFilter | <code>optional</code> | [TargetFilterCallback](./puppeteer.targetfiltercallback.md) | Callback to decide if Puppeteer should connect to a given target or not. | |

4
docs/api/puppeteer.browserfetcheroptions.md
View File

@ -16,6 +16,6 @@ export interface BrowserFetcherOptions
| ----------------- | --------------------- | ----------------------------------- | ------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------- | | ----------------- | --------------------- | ----------------------------------- | ------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------- |
| host | <code>optional</code> | string | Determines the host that will be used for downloading. | <p>Either</p><p>- https://storage.googleapis.com or - https://archive.mozilla.org/pub/firefox/nightly/latest-mozilla-central</p> | | host | <code>optional</code> | string | Determines the host that will be used for downloading. | <p>Either</p><p>- https://storage.googleapis.com or - https://archive.mozilla.org/pub/firefox/nightly/latest-mozilla-central</p> |
| path | | string | Determines the path to download browsers to. | | | path | | string | Determines the path to download browsers to. | |
| platform | <code>optional</code> | [Platform](./puppeteer.platform.md) | Determines which platform the browser will be suited for. | Auto-detected. | | platform | <code>optional</code> | [Platform](./puppeteer.platform.md) | Determines which platform the browser will be suited for. | **Auto-detected.** |
| product | <code>optional</code> | 'chrome' \| 'firefox' | Determines which product the [BrowserFetcher](./puppeteer.browserfetcher.md) is for. | <code>&quot;chrome&quot;</code>. | | product | <code>optional</code> | 'chrome' \| 'firefox' | Determines which product the [BrowserFetcher](./puppeteer.browserfetcher.md) is for. | <code>chrome</code> |
| useMacOSARMBinary | <code>optional</code> | boolean | Enables the use of the Chromium binary for macOS ARM. | | | useMacOSARMBinary | <code>optional</code> | boolean | Enables the use of the Chromium binary for macOS ARM. | |

2
docs/api/puppeteer.browserlaunchargumentoptions.md
View File

@ -19,5 +19,5 @@ export interface BrowserLaunchArgumentOptions
| args | <code>optional</code> | string\[\] | Additional command line arguments to pass to the browser instance. | | | args | <code>optional</code> | string\[\] | Additional command line arguments to pass to the browser instance. | |
| debuggingPort | <code>optional</code> | number | | | | debuggingPort | <code>optional</code> | number | | |
| devtools | <code>optional</code> | boolean | Whether to auto-open a DevTools panel for each tab. If this is set to <code>true</code>, then <code>headless</code> will be forced to <code>false</code>. | <code>false</code> | | devtools | <code>optional</code> | boolean | Whether to auto-open a DevTools panel for each tab. If this is set to <code>true</code>, then <code>headless</code> will be forced to <code>false</code>. | <code>false</code> |
| headless | <code>optional</code> | boolean \| 'new' | Whether to run the browser in headless mode. | true | | headless | <code>optional</code> | boolean \| 'new' | Whether to run the browser in headless mode. | <code>true</code> |
| userDataDir | <code>optional</code> | string | Path to a user data directory. [see the Chromium docs](https://chromium.googlesource.com/chromium/src/+/refs/heads/main/docs/user_data_dir.md) for more info. | | | userDataDir | <code>optional</code> | string | Path to a user data directory. [see the Chromium docs](https://chromium.googlesource.com/chromium/src/+/refs/heads/main/docs/user_data_dir.md) for more info. | |

6
docs/api/puppeteer.clickoptions.md
View File

@ -13,8 +13,8 @@ export interface ClickOptions
## Properties ## Properties
| Property | Modifiers | Type | Description | Default | | Property | Modifiers | Type | Description | Default |
| ---------- | --------------------- | ----------------------------------------- | ------------------------------------------------------------------------------------- | ------- | | ---------- | --------------------- | ----------------------------------------- | ------------------------------------------------------------------------------------- | -------------- |
| button | <code>optional</code> | [MouseButton](./puppeteer.mousebutton.md) | | 'left' | | button | <code>optional</code> | [MouseButton](./puppeteer.mousebutton.md) | | 'left' |
| clickCount | <code>optional</code> | number | | 1 | | clickCount | <code>optional</code> | number | | <code>1</code> |
| delay | <code>optional</code> | number | Time to wait between <code>mousedown</code> and <code>mouseup</code> in milliseconds. | 0 | | delay | <code>optional</code> | number | Time to wait between <code>mousedown</code> and <code>mouseup</code> in milliseconds. | <code>0</code> |
| offset | <code>optional</code> | [Offset](./puppeteer.offset.md) | Offset for the clickable point relative to the top-left corner of the border box. | | | offset | <code>optional</code> | [Offset](./puppeteer.offset.md) | Offset for the clickable point relative to the top-left corner of the border box. | |

4
docs/api/puppeteer.configuration.md
View File

@ -20,10 +20,10 @@ export interface Configuration
| ------------------ | --------------------- | ------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ------------------ | --------------------- | ------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| browserRevision | <code>optional</code> | string | <p>Specifies a certain version of the browser you'd like Puppeteer to use.</p><p>Can be overridden by <code>PUPPETEER_BROWSER_REVISION</code>.</p><p>See [puppeteer.launch](./puppeteer.puppeteernode.launch.md) on how executable path is inferred.</p> | A compatible-revision of the browser. | | browserRevision | <code>optional</code> | string | <p>Specifies a certain version of the browser you'd like Puppeteer to use.</p><p>Can be overridden by <code>PUPPETEER_BROWSER_REVISION</code>.</p><p>See [puppeteer.launch](./puppeteer.puppeteernode.launch.md) on how executable path is inferred.</p> | A compatible-revision of the browser. |
| cacheDirectory | <code>optional</code> | string | <p>Defines the directory to be used by Puppeteer for caching.</p><p>Can be overridden by <code>PUPPETEER_CACHE_DIR</code>.</p> | <code>path.join(os.homedir(), '.cache', 'puppeteer')</code> | | cacheDirectory | <code>optional</code> | string | <p>Defines the directory to be used by Puppeteer for caching.</p><p>Can be overridden by <code>PUPPETEER_CACHE_DIR</code>.</p> | <code>path.join(os.homedir(), '.cache', 'puppeteer')</code> |
| defaultProduct | <code>optional</code> | [Product](./puppeteer.product.md) | <p>Specifies which browser you'd like Puppeteer to use.</p><p>Can be overridden by <code>PUPPETEER_PRODUCT</code>.</p> | <code>'chrome'</code> | | defaultProduct | <code>optional</code> | [Product](./puppeteer.product.md) | <p>Specifies which browser you'd like Puppeteer to use.</p><p>Can be overridden by <code>PUPPETEER_PRODUCT</code>.</p> | <code>chrome</code> |
| downloadHost | <code>optional</code> | string | <p>Specifies the URL prefix that is used to download Chromium.</p><p>Can be overridden by <code>PUPPETEER_DOWNLOAD_HOST</code>.</p> | Either https://storage.googleapis.com or https://archive.mozilla.org/pub/firefox/nightly/latest-mozilla-central, depending on the product. | | downloadHost | <code>optional</code> | string | <p>Specifies the URL prefix that is used to download Chromium.</p><p>Can be overridden by <code>PUPPETEER_DOWNLOAD_HOST</code>.</p> | Either https://storage.googleapis.com or https://archive.mozilla.org/pub/firefox/nightly/latest-mozilla-central, depending on the product. |
| downloadPath | <code>optional</code> | string | <p>Specifies the path for the downloads folder.</p><p>Can be overridden by <code>PUPPETEER_DOWNLOAD_PATH</code>.</p> | <code>&lt;cache&gt;/&lt;product&gt;</code> where <code>&lt;cache&gt;</code> is Puppeteer's cache directory and <code>&lt;product&gt;</code> is the name of the browser. | | downloadPath | <code>optional</code> | string | <p>Specifies the path for the downloads folder.</p><p>Can be overridden by <code>PUPPETEER_DOWNLOAD_PATH</code>.</p> | <code>&lt;cache&gt;/&lt;product&gt;</code> where <code>&lt;cache&gt;</code> is Puppeteer's cache directory and <code>&lt;product&gt;</code> is the name of the browser. |
| executablePath | <code>optional</code> | string | <p>Specifies an executable path to be used in [puppeteer.launch](./puppeteer.puppeteernode.launch.md).</p><p>Can be overridden by <code>PUPPETEER_EXECUTABLE_PATH</code>.</p> | Auto-computed. | | executablePath | <code>optional</code> | string | <p>Specifies an executable path to be used in [puppeteer.launch](./puppeteer.puppeteernode.launch.md).</p><p>Can be overridden by <code>PUPPETEER_EXECUTABLE_PATH</code>.</p> | **Auto-computed.** |
| experiments | <code>optional</code> | [ExperimentsConfiguration](./puppeteer.experimentsconfiguration.md) | Defines experimental options for Puppeteer. | | | experiments | <code>optional</code> | [ExperimentsConfiguration](./puppeteer.experimentsconfiguration.md) | Defines experimental options for Puppeteer. | |
| logLevel | <code>optional</code> | 'silent' \| 'error' \| 'warn' | <p>Tells Puppeteer to log at the given level.</p><p>At the moment, any option silences logging.</p> | <code>undefined</code> | | logLevel | <code>optional</code> | 'silent' \| 'error' \| 'warn' | <p>Tells Puppeteer to log at the given level.</p><p>At the moment, any option silences logging.</p> | <code>undefined</code> |
| skipDownload | <code>optional</code> | boolean | <p>Tells Puppeteer to not download during installation.</p><p>Can be overridden by <code>PUPPETEER_SKIP_DOWNLOAD</code>.</p> | | | skipDownload | <code>optional</code> | boolean | <p>Tells Puppeteer to not download during installation.</p><p>Can be overridden by <code>PUPPETEER_SKIP_DOWNLOAD</code>.</p> | |

10
docs/api/puppeteer.launchoptions.md
View File

@ -17,15 +17,15 @@ export interface LaunchOptions
| Property | Modifiers | Type | Description | Default | | Property | Modifiers | Type | Description | Default |
| ------------------ | --------------------- | ----------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------- | | ------------------ | --------------------- | ----------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------- |
| channel | <code>optional</code> | [ChromeReleaseChannel](./puppeteer.chromereleasechannel.md) | Chrome Release Channel | | | channel | <code>optional</code> | [ChromeReleaseChannel](./puppeteer.chromereleasechannel.md) | Chrome Release Channel | |
| dumpio | <code>optional</code> | boolean | If true, pipes the browser process stdout and stderr to <code>process.stdout</code> and <code>process.stderr</code>. | false | | dumpio | <code>optional</code> | boolean | If true, pipes the browser process stdout and stderr to <code>process.stdout</code> and <code>process.stderr</code>. | <code>false</code> |
| env | <code>optional</code> | Record&lt;string, string \| undefined&gt; | Specify environment variables that will be visible to the browser. | The contents of <code>process.env</code>. | | env | <code>optional</code> | Record&lt;string, string \| undefined&gt; | Specify environment variables that will be visible to the browser. | The contents of <code>process.env</code>. |
| executablePath | <code>optional</code> | string | Path to a browser executable to use instead of the bundled Chromium. Note that Puppeteer is only guaranteed to work with the bundled Chromium, so use this setting at your own risk. | | | executablePath | <code>optional</code> | string | Path to a browser executable to use instead of the bundled Chromium. Note that Puppeteer is only guaranteed to work with the bundled Chromium, so use this setting at your own risk. | |
| extraPrefsFirefox | <code>optional</code> | Record&lt;string, unknown&gt; | [Additional preferences](https://searchfox.org/mozilla-release/source/modules/libpref/init/all.js) that can be passed when launching with Firefox. | | | extraPrefsFirefox | <code>optional</code> | Record&lt;string, unknown&gt; | [Additional preferences](https://searchfox.org/mozilla-release/source/modules/libpref/init/all.js) that can be passed when launching with Firefox. | |
| handleSIGHUP | <code>optional</code> | boolean | Close the browser process on <code>SIGHUP</code>. | <code>true</code> | | handleSIGHUP | <code>optional</code> | boolean | Close the browser process on <code>SIGHUP</code>. | <code>true</code> |
| handleSIGINT | <code>optional</code> | boolean | Close the browser process on <code>Ctrl+C</code>. | <code>true</code> | | handleSIGINT | <code>optional</code> | boolean | Close the browser process on <code>Ctrl+C</code>. | <code>true</code> |
| handleSIGTERM | <code>optional</code> | boolean | Close the browser process on <code>SIGTERM</code>. | <code>true</code> | | handleSIGTERM | <code>optional</code> | boolean | Close the browser process on <code>SIGTERM</code>. | <code>true</code> |
| ignoreDefaultArgs | <code>optional</code> | boolean \| string\[\] | If <code>true</code>, do not use <code>puppeteer.defaultArgs()</code> when creating a browser. If an array is provided, these args will be filtered out. Use this with care - you probably want the default arguments Puppeteer uses. | false | | ignoreDefaultArgs | <code>optional</code> | boolean \| string\[\] | If <code>true</code>, do not use <code>puppeteer.defaultArgs()</code> when creating a browser. If an array is provided, these args will be filtered out. Use this with care - you probably want the default arguments Puppeteer uses. | <code>false</code> |
| pipe | <code>optional</code> | boolean | Connect to a browser over a pipe instead of a WebSocket. | false | | pipe | <code>optional</code> | boolean | Connect to a browser over a pipe instead of a WebSocket. | <code>false</code> |
| product | <code>optional</code> | [Product](./puppeteer.product.md) | Which browser to launch. | <code>chrome</code> | | product | <code>optional</code> | [Product](./puppeteer.product.md) | Which browser to launch. | <code>chrome</code> |
| timeout | <code>optional</code> | number | Maximum time in milliseconds to wait for the browser to start. Pass <code>0</code> to disable the timeout. | 30000 (30 seconds). | | timeout | <code>optional</code> | number | Maximum time in milliseconds to wait for the browser to start. Pass <code>0</code> to disable the timeout. | <code>30_000</code> (30 seconds). |
| waitForInitialPage | <code>optional</code> | boolean | Whether to wait for the initial page to be ready. Useful when a user explicitly disables that (e.g. <code>--no-startup-window</code> for Chrome). | true | | waitForInitialPage | <code>optional</code> | boolean | Whether to wait for the initial page to be ready. Useful when a user explicitly disables that (e.g. <code>--no-startup-window</code> for Chrome). | <code>true</code> |

2
docs/api/puppeteer.page.setcacheenabled.md
View File

@ -26,4 +26,4 @@ Promise&lt;void&gt;
#### Default value: #### Default value:
true `true`

18
docs/api/puppeteer.pdfoptions.md
View File

@ -15,19 +15,19 @@ export interface PDFOptions
## Properties ## Properties
| Property | Modifiers | Type | Description | Default | | Property | Modifiers | Type | Description | Default |
| ------------------- | --------------------- | ----------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- | | ------------------- | --------------------- | ----------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------ |
| displayHeaderFooter | <code>optional</code> | boolean | Whether to show the header and footer. | false | | displayHeaderFooter | <code>optional</code> | boolean | Whether to show the header and footer. | <code>false</code> |
| footerTemplate | <code>optional</code> | string | HTML template for the print footer. Has the same constraints and support for special classes as [PDFOptions.headerTemplate](./puppeteer.pdfoptions.md). | | | footerTemplate | <code>optional</code> | string | HTML template for the print footer. Has the same constraints and support for special classes as [PDFOptions.headerTemplate](./puppeteer.pdfoptions.md). | |
| format | <code>optional</code> | [PaperFormat](./puppeteer.paperformat.md) | | <code>letter</code>. | | format | <code>optional</code> | [PaperFormat](./puppeteer.paperformat.md) | | <code>letter</code>. |
| headerTemplate | <code>optional</code> | string | <p>HTML template for the print header. Should be valid HTML with the following classes used to inject values into them:</p><p>- <code>date</code> formatted print date</p><p>- <code>title</code> document title</p><p>- <code>url</code> document location</p><p>- <code>pageNumber</code> current page number</p><p>- <code>totalPages</code> total pages in the document</p> | | | headerTemplate | <code>optional</code> | string | <p>HTML template for the print header. Should be valid HTML with the following classes used to inject values into them:</p><p>- <code>date</code> formatted print date</p><p>- <code>title</code> document title</p><p>- <code>url</code> document location</p><p>- <code>pageNumber</code> current page number</p><p>- <code>totalPages</code> total pages in the document</p> | |
| height | <code>optional</code> | string \| number | Sets the height of paper. You can pass in a number or a string with a unit. | | | height | <code>optional</code> | string \| number | Sets the height of paper. You can pass in a number or a string with a unit. | |
| landscape | <code>optional</code> | boolean | Whether to print in landscape orientation. | = false | | landscape | <code>optional</code> | boolean | Whether to print in landscape orientation. | <code>false</code> |
| margin | <code>optional</code> | [PDFMargin](./puppeteer.pdfmargin.md) | Set the PDF margins. | no margins are set. | | margin | <code>optional</code> | [PDFMargin](./puppeteer.pdfmargin.md) | Set the PDF margins. | <code>undefined</code> no margins are set. |
| omitBackground | <code>optional</code> | boolean | Hides default white background and allows generating pdfs with transparency. | false | | omitBackground | <code>optional</code> | boolean | Hides default white background and allows generating pdfs with transparency. | <code>false</code> |
| pageRanges | <code>optional</code> | string | Paper ranges to print, e.g. <code>1-5, 8, 11-13</code>. | The empty string, which means all pages are printed. | | pageRanges | <code>optional</code> | string | Paper ranges to print, e.g. <code>1-5, 8, 11-13</code>. | The empty string, which means all pages are printed. |
| path | <code>optional</code> | string | The path to save the file to. | the empty string, which means the PDF will not be written to disk. | | path | <code>optional</code> | string | The path to save the file to. | <code>undefined</code>, which means the PDF will not be written to disk. |
| preferCSSPageSize | <code>optional</code> | 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. | <code>false</code>, which will scale the content to fit the paper size. | | preferCSSPageSize | <code>optional</code> | 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. | <code>false</code>, which will scale the content to fit the paper size. |
| printBackground | <code>optional</code> | boolean | Set to <code>true</code> to print background graphics. | false | | printBackground | <code>optional</code> | boolean | Set to <code>true</code> to print background graphics. | <code>false</code> |
| scale | <code>optional</code> | number | Scales the rendering of the web page. Amount must be between <code>0.1</code> and <code>2</code>. | 1 | | scale | <code>optional</code> | number | Scales the rendering of the web page. Amount must be between <code>0.1</code> and <code>2</code>. | <code>1</code> |
| timeout | <code>optional</code> | number | Timeout in milliseconds. Pass <code>0</code> to disable timeout. | 30000 | | timeout | <code>optional</code> | number | Timeout in milliseconds. Pass <code>0</code> to disable timeout. | <code>30_000</code> |
| width | <code>optional</code> | string \| number | Sets the width of paper. You can pass in a number or a string with a unit. | | | width | <code>optional</code> | string \| number | Sets the width of paper. You can pass in a number or a string with a unit. | |

4
docs/api/puppeteer.screenshotclip.md
View File

@ -13,9 +13,9 @@ export interface ScreenshotClip
## Properties ## Properties
| Property | Modifiers | Type | Description | Default | | Property | Modifiers | Type | Description | Default |
| -------- | --------------------- | ------ | ----------- | ------- | | -------- | --------------------- | ------ | ----------- | -------------- |
| height | | number | | | | height | | number | | |
| scale | <code>optional</code> | number | | 1 | | scale | <code>optional</code> | number | | <code>1</code> |
| width | | number | | | | width | | number | | |
| x | | number | | | | x | | number | | |
| y | | number | | | | y | | number | | |

2
docs/api/puppeteer.snapshotoptions.md
View File

@ -14,5 +14,5 @@ export interface SnapshotOptions
| Property | Modifiers | Type | Description | Default | | Property | Modifiers | Type | Description | Default |
| --------------- | --------------------- | --------------------------------------------------------- | ------------------------------------------- | --------------------------------- | | --------------- | --------------------- | --------------------------------------------------------- | ------------------------------------------- | --------------------------------- |
| interestingOnly | <code>optional</code> | boolean | Prune uninteresting nodes from the tree. | true | | interestingOnly | <code>optional</code> | boolean | Prune uninteresting nodes from the tree. | <code>true</code> |
| root | <code>optional</code> | [ElementHandle](./puppeteer.elementhandle.md)&lt;Node&gt; | Root node to get the accessibility tree for | The root node of the entire page. | | root | <code>optional</code> | [ElementHandle](./puppeteer.elementhandle.md)&lt;Node&gt; | Root node to get the accessibility tree for | The root node of the entire page. |

10
docs/api/puppeteer.viewport.md
View File

@ -15,10 +15,10 @@ export interface Viewport
## Properties ## Properties
| Property | Modifiers | Type | Description | Default | | Property | Modifiers | Type | Description | Default |
| ----------------- | --------------------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------- | ------- | | ----------------- | --------------------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ |
| deviceScaleFactor | <code>optional</code> | number | Specify device scale factor. See [devicePixelRatio](https://developer.mozilla.org/en-US/docs/Web/API/Window/devicePixelRatio) for more info. | 1 | | deviceScaleFactor | <code>optional</code> | number | Specify device scale factor. See [devicePixelRatio](https://developer.mozilla.org/en-US/docs/Web/API/Window/devicePixelRatio) for more info. | <code>1</code> |
| hasTouch | <code>optional</code> | boolean | Specify if the viewport supports touch events. | false | | hasTouch | <code>optional</code> | boolean | Specify if the viewport supports touch events. | <code>false</code> |
| height | | number | The page height in pixels. | | | height | | number | The page height in pixels. | |
| isLandscape | <code>optional</code> | boolean | Specifies if the viewport is in landscape mode. | false | | isLandscape | <code>optional</code> | boolean | Specifies if the viewport is in landscape mode. | <code>false</code> |
| isMobile | <code>optional</code> | boolean | Whether the <code>meta viewport</code> tag is taken into account. | false | | isMobile | <code>optional</code> | boolean | Whether the <code>meta viewport</code> tag is taken into account. | <code>false</code> |
| width | | number | The page width in pixels. | | | width | | number | The page width in pixels. | |

4
docs/api/puppeteer.waitforselectoroptions.md
View File

@ -13,7 +13,7 @@ export interface WaitForSelectorOptions
## Properties ## Properties
| Property | Modifiers | Type | Description | Default | | Property | Modifiers | Type | Description | Default |
| -------- | --------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------- | | -------- | --------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------- |
| hidden | <code>optional</code> | boolean | Wait for the selected element to not be found in the DOM or to be hidden, i.e. have <code>display: none</code> or <code>visibility: hidden</code> CSS properties. | <code>false</code> | | hidden | <code>optional</code> | boolean | Wait for the selected element to not be found in the DOM or to be hidden, i.e. have <code>display: none</code> or <code>visibility: hidden</code> CSS properties. | <code>false</code> |
| timeout | <code>optional</code> | number | <p>Maximum time to wait in milliseconds. Pass <code>0</code> to disable timeout.</p><p>The default value can be changed by using [Page.setDefaultTimeout()](./puppeteer.page.setdefaulttimeout.md)</p> | <code>30000</code> (30 seconds) | | timeout | <code>optional</code> | number | <p>Maximum time to wait in milliseconds. Pass <code>0</code> to disable timeout.</p><p>The default value can be changed by using [Page.setDefaultTimeout()](./puppeteer.page.setdefaulttimeout.md)</p> | <code>30_000</code> (30 seconds) |
| visible | <code>optional</code> | boolean | Wait for the selected element to be present in DOM and to be visible, i.e. to not have <code>display: none</code> or <code>visibility: hidden</code> CSS properties. | <code>false</code> | | visible | <code>optional</code> | boolean | Wait for the selected element to be present in DOM and to be visible, i.e. to not have <code>display: none</code> or <code>visibility: hidden</code> CSS properties. | <code>false</code> |

4
docs/api/puppeteer.waitfortargetoptions.md
View File

@ -13,5 +13,5 @@ export interface WaitForTargetOptions
## Properties ## Properties
| Property | Modifiers | Type | Description | Default | | Property | Modifiers | Type | Description | Default |
| -------- | --------------------- | ------ | ------------------------------------------------------------------------------ | ----------- | | -------- | --------------------- | ------ | ------------------------------------------------------------------------------ | ------------------- |
| timeout | <code>optional</code> | number | Maximum wait time in milliseconds. Pass <code>0</code> to disable the timeout. | 30 seconds. | | timeout | <code>optional</code> | number | Maximum wait time in milliseconds. Pass <code>0</code> to disable the timeout. | <code>30_000</code> |

2
packages/browsers/src/fetch.ts
View File

@ -44,7 +44,7 @@ export interface Options {
/** /**
* Determines which platform the browser will be suited for. * Determines which platform the browser will be suited for.
* *
* @defaultValue Auto-detected. * @defaultValue **Auto-detected.**
*/ */
platform?: BrowserPlatform; platform?: BrowserPlatform;
/** /**

4
packages/browsers/src/launcher.ts
View File

@ -44,7 +44,7 @@ export interface Options {
/** /**
* Determines which platform the browser will be suited for. * Determines which platform the browser will be suited for.
* *
* @defaultValue Auto-detected. * @defaultValue **Auto-detected.**
*/ */
platform?: BrowserPlatform; platform?: BrowserPlatform;
/** /**
@ -83,7 +83,7 @@ export interface SystemOptions {
/** /**
* Determines which platform the browser will be suited for. * Determines which platform the browser will be suited for.
* *
* @defaultValue Auto-detected. * @defaultValue **Auto-detected.**
*/ */
platform?: BrowserPlatform; platform?: BrowserPlatform;
/** /**

2
packages/puppeteer-core/src/api/Browser.ts
View File

@ -119,7 +119,7 @@ export type Permission =
export interface WaitForTargetOptions { export interface WaitForTargetOptions {
/** /**
* Maximum wait time in milliseconds. Pass `0` to disable the timeout. * Maximum wait time in milliseconds. Pass `0` to disable the timeout.
* @defaultValue 30 seconds. * @defaultValue `30_000`
*/ */
timeout?: number; timeout?: number;
} }

4
packages/puppeteer-core/src/api/ElementHandle.ts
View File

@ -80,7 +80,7 @@ export interface ClickOptions {
/** /**
* Time to wait between `mousedown` and `mouseup` in milliseconds. * Time to wait between `mousedown` and `mouseup` in milliseconds.
* *
* @defaultValue 0 * @defaultValue `0`
*/ */
delay?: number; delay?: number;
/** /**
@ -88,7 +88,7 @@ export interface ClickOptions {
*/ */
button?: MouseButton; button?: MouseButton;
/** /**
* @defaultValue 1 * @defaultValue `1`
*/ */
clickCount?: number; clickCount?: number;
/** /**

4
packages/puppeteer-core/src/api/Page.ts
View File

@ -153,7 +153,7 @@ export interface ScreenshotClip {
width: number; width: number;
height: number; height: number;
/** /**
* @defaultValue 1 * @defaultValue `1`
*/ */
scale?: number; scale?: number;
} }
@ -2090,7 +2090,7 @@ export class Page extends EventEmitter {
* Toggles ignoring cache for each request based on the enabled state. By * Toggles ignoring cache for each request based on the enabled state. By
* default, caching is enabled. * default, caching is enabled.
* @param enabled - sets the `enabled` state of cache * @param enabled - sets the `enabled` state of cache
* @defaultValue true * @defaultValue `true`
*/ */
async setCacheEnabled(enabled?: boolean): Promise<void>; async setCacheEnabled(enabled?: boolean): Promise<void>;
async setCacheEnabled(): Promise<void> { async setCacheEnabled(): Promise<void> {

2
packages/puppeteer-core/src/common/Accessibility.ts
View File

@ -99,7 +99,7 @@ export interface SerializedAXNode {
export interface SnapshotOptions { export interface SnapshotOptions {
/** /**
* Prune uninteresting nodes from the tree. * Prune uninteresting nodes from the tree.
* @defaultValue true * @defaultValue `true`
*/ */
interestingOnly?: boolean; interestingOnly?: boolean;
/** /**

4
packages/puppeteer-core/src/common/BrowserConnector.ts
View File

@ -34,7 +34,7 @@ import {debugError} from './util.js';
export interface BrowserConnectOptions { export interface BrowserConnectOptions {
/** /**
* Whether to ignore HTTPS errors during navigation. * Whether to ignore HTTPS errors during navigation.
* @defaultValue false * @defaultValue `false`
*/ */
ignoreHTTPSErrors?: boolean; ignoreHTTPSErrors?: boolean;
/** /**
@ -62,7 +62,7 @@ export interface BrowserConnectOptions {
/** /**
* Timeout setting for individual protocol (CDP) calls. * Timeout setting for individual protocol (CDP) calls.
* *
* @defaultValue 180000 * @defaultValue `180_000`
*/ */
protocolTimeout?: number; protocolTimeout?: number;
} }

4
packages/puppeteer-core/src/common/Configuration.ts
View File

@ -95,7 +95,7 @@ export interface Configuration {
* *
* Can be overridden by `PUPPETEER_EXECUTABLE_PATH`. * Can be overridden by `PUPPETEER_EXECUTABLE_PATH`.
* *
* @defaultValue Auto-computed. * @defaultValue **Auto-computed.**
*/ */
executablePath?: string; executablePath?: string;
/** /**
@ -103,7 +103,7 @@ export interface Configuration {
* *
* Can be overridden by `PUPPETEER_PRODUCT`. * Can be overridden by `PUPPETEER_PRODUCT`.
* *
* @defaultValue `'chrome'` * @defaultValue `chrome`
*/ */
defaultProduct?: Product; defaultProduct?: Product;
/** /**

2
packages/puppeteer-core/src/common/IsolatedWorld.ts
View File

@ -69,7 +69,7 @@ export interface WaitForSelectorOptions {
* *
* The default value can be changed by using {@link Page.setDefaultTimeout} * The default value can be changed by using {@link Page.setDefaultTimeout}
* *
* @defaultValue `30000` (30 seconds) * @defaultValue `30_000` (30 seconds)
*/ */
timeout?: number; timeout?: number;
} }

16
packages/puppeteer-core/src/common/PDFOptions.ts
View File

@ -83,12 +83,12 @@ export type PaperFormat =
export interface PDFOptions { export interface PDFOptions {
/** /**
* Scales the rendering of the web page. Amount must be between `0.1` and `2`. * Scales the rendering of the web page. Amount must be between `0.1` and `2`.
* @defaultValue 1 * @defaultValue `1`
*/ */
scale?: number; scale?: number;
/** /**
* Whether to show the header and footer. * Whether to show the header and footer.
* @defaultValue false * @defaultValue `false`
*/ */
displayHeaderFooter?: boolean; displayHeaderFooter?: boolean;
/** /**
@ -113,12 +113,12 @@ export interface PDFOptions {
footerTemplate?: string; footerTemplate?: string;
/** /**
* Set to `true` to print background graphics. * Set to `true` to print background graphics.
* @defaultValue false * @defaultValue `false`
*/ */
printBackground?: boolean; printBackground?: boolean;
/** /**
* Whether to print in landscape orientation. * Whether to print in landscape orientation.
* @defaultValue = false * @defaultValue `false`
*/ */
landscape?: boolean; landscape?: boolean;
/** /**
@ -148,7 +148,7 @@ export interface PDFOptions {
preferCSSPageSize?: boolean; preferCSSPageSize?: boolean;
/** /**
* Set the PDF margins. * Set the PDF margins.
* @defaultValue no margins are set. * @defaultValue `undefined` no margins are set.
*/ */
margin?: PDFMargin; margin?: PDFMargin;
/** /**
@ -158,17 +158,17 @@ export interface PDFOptions {
* *
* If the path is relative, it's resolved relative to the current working directory. * 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. * @defaultValue `undefined`, which means the PDF will not be written to disk.
*/ */
path?: string; path?: string;
/** /**
* Hides default white background and allows generating pdfs with transparency. * Hides default white background and allows generating pdfs with transparency.
* @defaultValue false * @defaultValue `false`
*/ */
omitBackground?: boolean; omitBackground?: boolean;
/** /**
* Timeout in milliseconds. Pass `0` to disable timeout. * Timeout in milliseconds. Pass `0` to disable timeout.
* @defaultValue 30000 * @defaultValue `30_000`
*/ */
timeout?: number; timeout?: number;
} }

8
packages/puppeteer-core/src/common/PuppeteerViewport.ts
View File

@ -34,22 +34,22 @@ export interface Viewport {
* @remarks * @remarks
* Setting this value to `0` will set the deviceScaleFactor to the system default. * Setting this value to `0` will set the deviceScaleFactor to the system default.
* *
* @defaultValue 1 * @defaultValue `1`
*/ */
deviceScaleFactor?: number; deviceScaleFactor?: number;
/** /**
* Whether the `meta viewport` tag is taken into account. * Whether the `meta viewport` tag is taken into account.
* @defaultValue false * @defaultValue `false`
*/ */
isMobile?: boolean; isMobile?: boolean;
/** /**
* Specifies if the viewport is in landscape mode. * Specifies if the viewport is in landscape mode.
* @defaultValue false * @defaultValue `false`
*/ */
isLandscape?: boolean; isLandscape?: boolean;
/** /**
* Specify if the viewport supports touch events. * Specify if the viewport supports touch events.
* @defaultValue false * @defaultValue `false`
*/ */
hasTouch?: boolean; hasTouch?: boolean;
} }

4
packages/puppeteer-core/src/node/BrowserFetcher.ts
View File

@ -143,13 +143,13 @@ export interface BrowserFetcherOptions {
/** /**
* Determines which platform the browser will be suited for. * Determines which platform the browser will be suited for.
* *
* @defaultValue Auto-detected. * @defaultValue **Auto-detected.**
*/ */
platform?: Platform; platform?: Platform;
/** /**
* Determines which product the {@link BrowserFetcher} is for. * Determines which product the {@link BrowserFetcher} is for.
* *
* @defaultValue `"chrome"`. * @defaultValue `chrome`
*/ */
product?: 'chrome' | 'firefox'; product?: 'chrome' | 'firefox';
/** /**

12
packages/puppeteer-core/src/node/LaunchOptions.ts
View File

@ -25,7 +25,7 @@ import {Product} from '../common/Product.js';
export interface BrowserLaunchArgumentOptions { export interface BrowserLaunchArgumentOptions {
/** /**
* Whether to run the browser in headless mode. * Whether to run the browser in headless mode.
* @defaultValue true * @defaultValue `true`
*/ */
headless?: boolean | 'new'; headless?: boolean | 'new';
/** /**
@ -77,7 +77,7 @@ export interface LaunchOptions {
* If `true`, do not use `puppeteer.defaultArgs()` when creating a browser. If * If `true`, do not use `puppeteer.defaultArgs()` when creating a browser. If
* an array is provided, these args will be filtered out. Use this with care - * an array is provided, these args will be filtered out. Use this with care -
* you probably want the default arguments Puppeteer uses. * you probably want the default arguments Puppeteer uses.
* @defaultValue false * @defaultValue `false`
*/ */
ignoreDefaultArgs?: boolean | string[]; ignoreDefaultArgs?: boolean | string[];
/** /**
@ -98,13 +98,13 @@ export interface LaunchOptions {
/** /**
* Maximum time in milliseconds to wait for the browser to start. * Maximum time in milliseconds to wait for the browser to start.
* Pass `0` to disable the timeout. * Pass `0` to disable the timeout.
* @defaultValue 30000 (30 seconds). * @defaultValue `30_000` (30 seconds).
*/ */
timeout?: number; timeout?: number;
/** /**
* If true, pipes the browser process stdout and stderr to `process.stdout` * If true, pipes the browser process stdout and stderr to `process.stdout`
* and `process.stderr`. * and `process.stderr`.
* @defaultValue false * @defaultValue `false`
*/ */
dumpio?: boolean; dumpio?: boolean;
/** /**
@ -114,7 +114,7 @@ export interface LaunchOptions {
env?: Record<string, string | undefined>; env?: Record<string, string | undefined>;
/** /**
* Connect to a browser over a pipe instead of a WebSocket. * Connect to a browser over a pipe instead of a WebSocket.
* @defaultValue false * @defaultValue `false`
*/ */
pipe?: boolean; pipe?: boolean;
/** /**
@ -129,7 +129,7 @@ export interface LaunchOptions {
/** /**
* Whether to wait for the initial page to be ready. * Whether to wait for the initial page to be ready.
* Useful when a user explicitly disables that (e.g. `--no-startup-window` for Chrome). * Useful when a user explicitly disables that (e.g. `--no-startup-window` for Chrome).
* @defaultValue true * @defaultValue `true`
*/ */
waitForInitialPage?: boolean; waitForInitialPage?: boolean;
} }