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: Bump website dependencies (#9739)

Browse Source
This commit is contained in:
Nikolay Vitkov 2023-02-23 13:31:23 +01:00 committed by GitHub
parent e7138cf99d
commit 37eb0f2a19
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
127 changed files with 1288 additions and 1359 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/api/puppeteer.accessibility.snapshot.md
View File

@ -16,9 +16,9 @@ class Accessibility {
## Parameters
| Parameter | Type | Description |
| --------- | ------------------------------------------------- | ----------------- |
| options | [SnapshotOptions](./puppeteer.snapshotoptions.md) | <i>(Optional)</i> |
| Parameter | Type | Description |
| --------- | ------------------------------------------------- | ------------ |
| options | [SnapshotOptions](./puppeteer.snapshotoptions.md) | _(Optional)_ |
**Returns:**

6
docs/api/puppeteer.browser.createincognitobrowsercontext.md
View File

@ -18,9 +18,9 @@ class Browser {
## Parameters
| Parameter | Type | Description |
| --------- | ------------------------------------------------------------- | ----------------- |
| options | [BrowserContextOptions](./puppeteer.browsercontextoptions.md) | <i>(Optional)</i> |
| Parameter | Type | Description |
| --------- | ------------------------------------------------------------- | ------------ |
| options | [BrowserContextOptions](./puppeteer.browsercontextoptions.md) | _(Optional)_ |
**Returns:**

2
docs/api/puppeteer.browser.waitfortarget.md
View File

@ -22,7 +22,7 @@ class Browser {
| Parameter | Type | Description |
| --------- | ---------------------------------------------------------------------------- | -------------------------------------- |
| predicate | (x: [Target](./puppeteer.target.md)) =&gt; boolean \| Promise&lt;boolean&gt; | A function to be run for every target. |
| options | [WaitForTargetOptions](./puppeteer.waitfortargetoptions.md) | <i>(Optional)</i> |
| options | [WaitForTargetOptions](./puppeteer.waitfortargetoptions.md) | _(Optional)_ |
**Returns:**

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

@ -14,9 +14,9 @@ export interface BrowserConnectOptions
## Properties
| Property | Modifiers | Type | Description | Default |
| ---------------------------------------------------------------------------- | --------- | ----------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ------- |
| [defaultViewport?](./puppeteer.browserconnectoptions.defaultviewport.md) | | [Viewport](./puppeteer.viewport.md) \| null | <i>(Optional)</i> Sets the viewport for each page. | |
| [ignoreHTTPSErrors?](./puppeteer.browserconnectoptions.ignorehttpserrors.md) | | boolean | <i>(Optional)</i> Whether to ignore HTTPS errors during navigation. | false |
| [slowMo?](./puppeteer.browserconnectoptions.slowmo.md) | | number | <i>(Optional)</i> Slows down Puppeteer operations by the specified amount of milliseconds to aid debugging. | |
| [targetFilter?](./puppeteer.browserconnectoptions.targetfilter.md) | | [TargetFilterCallback](./puppeteer.targetfiltercallback.md) | <i>(Optional)</i> Callback to decide if Puppeteer should connect to a given target or not. | |
| Property | Modifiers | Type | Description | Default |
| ---------------------------------------------------------------------------- | --------- | ----------------------------------------------------------- | ------------------------------------------------------------------------------------------------------ | ------- |
| [defaultViewport?](./puppeteer.browserconnectoptions.defaultviewport.md) | | [Viewport](./puppeteer.viewport.md) \| null | _(Optional)_ Sets the viewport for each page. | |
| [ignoreHTTPSErrors?](./puppeteer.browserconnectoptions.ignorehttpserrors.md) | | boolean | _(Optional)_ Whether to ignore HTTPS errors during navigation. | false |
| [slowMo?](./puppeteer.browserconnectoptions.slowmo.md) | | number | _(Optional)_ Slows down Puppeteer operations by the specified amount of milliseconds to aid debugging. | |
| [targetFilter?](./puppeteer.browserconnectoptions.targetfilter.md) | | [TargetFilterCallback](./puppeteer.targetfiltercallback.md) | _(Optional)_ Callback to decide if Puppeteer should connect to a given target or not. | |

8
docs/api/puppeteer.browsercontext.waitfortarget.md
View File

@ -21,10 +21,10 @@ class BrowserContext {
## Parameters
| Parameter | Type | Description |
| --------- | ---------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| predicate | (x: [Target](./puppeteer.target.md)) =&gt; boolean \| Promise&lt;boolean&gt; | A function to be run for every target |
| options | { timeout?: number; } | <i>(Optional)</i> An object of options. Accepts a timeout, which is the maximum wait time in milliseconds. Pass <code>0</code> to disable the timeout. Defaults to 30 seconds. |
| Parameter | Type | Description |
| --------- | ---------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| predicate | (x: [Target](./puppeteer.target.md)) =&gt; boolean \| Promise&lt;boolean&gt; | A function to be run for every target |
| options | { timeout?: number; } | _(Optional)_ An object of options. Accepts a timeout, which is the maximum wait time in milliseconds. Pass <code>0</code> to disable the timeout. Defaults to 30 seconds. |
**Returns:**

8
docs/api/puppeteer.browsercontextoptions.md
View File

@ -14,7 +14,7 @@ export interface BrowserContextOptions
## Properties
| Property | Modifiers | Type | Description | Default |
| ------------------------------------------------------------------------ | --------- | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ------- |
| [proxyBypassList?](./puppeteer.browsercontextoptions.proxybypasslist.md) | | string\[\] | <i>(Optional)</i> Bypass the proxy for the given list of hosts. | |
| [proxyServer?](./puppeteer.browsercontextoptions.proxyserver.md) | | string | <i>(Optional)</i> Proxy server with optional port to use for all requests. Username and password can be set in <code>Page.authenticate</code>. | |
| Property | Modifiers | Type | Description | Default |
| ------------------------------------------------------------------------ | --------- | ---------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ------- |
| [proxyBypassList?](./puppeteer.browsercontextoptions.proxybypasslist.md) | | string\[\] | _(Optional)_ Bypass the proxy for the given list of hosts. | |
| [proxyServer?](./puppeteer.browsercontextoptions.proxyserver.md) | | string | _(Optional)_ Proxy server with optional port to use for all requests. Username and password can be set in <code>Page.authenticate</code>. | |

8
docs/api/puppeteer.browserfetcher.download.md
View File

@ -19,10 +19,10 @@ class BrowserFetcher {
## Parameters
| Parameter | Type | Description |
| ---------------- | --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
| revision | string | The revision to download. |
| progressCallback | (x: number, y: number) =&gt; void | <i>(Optional)</i> A function that will be called with two arguments: How many bytes have been downloaded and the total number of bytes of the download. |
| Parameter | Type | Description |
| ---------------- | --------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |
| revision | string | The revision to download. |
| progressCallback | (x: number, y: number) =&gt; void | _(Optional)_ A function that will be called with two arguments: How many bytes have been downloaded and the total number of bytes of the download. |
**Returns:**

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

@ -12,10 +12,10 @@ export interface BrowserFetcherOptions
## Properties
| Property | Modifiers | Type | Description | Default |
| ---------------------------------------------------------------------------- | --------- | ----------------------------------- | ------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------- |
| [host?](./puppeteer.browserfetcheroptions.host.md) | | string | <i>(Optional)</i> 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](./puppeteer.browserfetcheroptions.path.md) | | string | Determines the path to download browsers to. | |
| [platform?](./puppeteer.browserfetcheroptions.platform.md) | | [Platform](./puppeteer.platform.md) | <i>(Optional)</i> Determines which platform the browser will be suited for. | Auto-detected. |
| [product?](./puppeteer.browserfetcheroptions.product.md) | | 'chrome' \| 'firefox' | <i>(Optional)</i> Determines which product the [BrowserFetcher](./puppeteer.browserfetcher.md) is for. | <code>&quot;chrome&quot;</code>. |
| [useMacOSARMBinary?](./puppeteer.browserfetcheroptions.usemacosarmbinary.md) | | boolean | <i>(Optional)</i> Enables the use of the Chromium binary for macOS ARM. | |
| Property | Modifiers | Type | Description | Default |
| ---------------------------------------------------------------------------- | --------- | ----------------------------------- | ------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- |
| [host?](./puppeteer.browserfetcheroptions.host.md) | | string | _(Optional)_ 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](./puppeteer.browserfetcheroptions.path.md) | | string | Determines the path to download browsers to. | |
| [platform?](./puppeteer.browserfetcheroptions.platform.md) | | [Platform](./puppeteer.platform.md) | _(Optional)_ Determines which platform the browser will be suited for. | Auto-detected. |
| [product?](./puppeteer.browserfetcheroptions.product.md) | | 'chrome' \| 'firefox' | _(Optional)_ Determines which product the [BrowserFetcher](./puppeteer.browserfetcher.md) is for. | <code>&quot;chrome&quot;</code>. |
| [useMacOSARMBinary?](./puppeteer.browserfetcheroptions.usemacosarmbinary.md) | | boolean | _(Optional)_ Enables the use of the Chromium binary for macOS ARM. | |

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

@ -14,10 +14,10 @@ export interface BrowserLaunchArgumentOptions
## Properties
| Property | Modifiers | Type | Description | Default |
| --------------------------------------------------------------------------- | --------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ |
| [args?](./puppeteer.browserlaunchargumentoptions.args.md) | | string\[\] | <i>(Optional)</i> Additional command line arguments to pass to the browser instance. | |
| [debuggingPort?](./puppeteer.browserlaunchargumentoptions.debuggingport.md) | | number | <i>(Optional)</i> | |
| [devtools?](./puppeteer.browserlaunchargumentoptions.devtools.md) | | boolean | <i>(Optional)</i> 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?](./puppeteer.browserlaunchargumentoptions.headless.md) | | boolean \| 'new' | <i>(Optional)</i> Whether to run the browser in headless mode. | true |
| [userDataDir?](./puppeteer.browserlaunchargumentoptions.userdatadir.md) | | string | <i>(Optional)</i> 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. | |
| Property | Modifiers | Type | Description | Default |
| --------------------------------------------------------------------------- | --------- | ---------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ |
| [args?](./puppeteer.browserlaunchargumentoptions.args.md) | | string\[\] | _(Optional)_ Additional command line arguments to pass to the browser instance. | |
| [debuggingPort?](./puppeteer.browserlaunchargumentoptions.debuggingport.md) | | number | _(Optional)_ | |
| [devtools?](./puppeteer.browserlaunchargumentoptions.devtools.md) | | boolean | _(Optional)_ 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?](./puppeteer.browserlaunchargumentoptions.headless.md) | | boolean \| 'new' | _(Optional)_ Whether to run the browser in headless mode. | true |
| [userDataDir?](./puppeteer.browserlaunchargumentoptions.userdatadir.md) | | string | _(Optional)_ 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. | |

14
docs/api/puppeteer.cdpsessiononmessageobject.md
View File

@ -12,10 +12,10 @@ export interface CDPSessionOnMessageObject
## Properties
| Property | Modifiers | Type | Description | Default |
| ---------------------------------------------------------- | --------- | --------------------------------------------- | ----------------- | ------- |
| [error](./puppeteer.cdpsessiononmessageobject.error.md) | | { message: string; data: any; code: number; } | | |
| [id?](./puppeteer.cdpsessiononmessageobject.id.md) | | number | <i>(Optional)</i> | |
| [method](./puppeteer.cdpsessiononmessageobject.method.md) | | string | | |
| [params](./puppeteer.cdpsessiononmessageobject.params.md) | | Record&lt;string, unknown&gt; | | |
| [result?](./puppeteer.cdpsessiononmessageobject.result.md) | | any | <i>(Optional)</i> | |
| Property | Modifiers | Type | Description | Default |
| ---------------------------------------------------------- | --------- | --------------------------------------------- | ------------ | ------- |
| [error](./puppeteer.cdpsessiononmessageobject.error.md) | | { message: string; data: any; code: number; } | | |
| [id?](./puppeteer.cdpsessiononmessageobject.id.md) | | number | _(Optional)_ | |
| [method](./puppeteer.cdpsessiononmessageobject.method.md) | | string | | |
| [params](./puppeteer.cdpsessiononmessageobject.params.md) | | Record&lt;string, unknown&gt; | | |
| [result?](./puppeteer.cdpsessiononmessageobject.result.md) | | any | _(Optional)_ | |

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

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

8
docs/api/puppeteer.commoneventemitter.emit.md
View File

@ -14,10 +14,10 @@ interface CommonEventEmitter {
## Parameters
| Parameter | Type | Description |
| --------- | ------------------------------------- | ----------------- |
| event | [EventType](./puppeteer.eventtype.md) | |
| eventData | unknown | <i>(Optional)</i> |
| Parameter | Type | Description |
| --------- | ------------------------------------- | ------------ |
| event | [EventType](./puppeteer.eventtype.md) | |
| eventData | unknown | _(Optional)_ |
**Returns:**

6
docs/api/puppeteer.commoneventemitter.removealllisteners.md
View File

@ -14,9 +14,9 @@ interface CommonEventEmitter {
## Parameters
| Parameter | Type | Description |
| --------- | ------------------------------------- | ----------------- |
| event | [EventType](./puppeteer.eventtype.md) | <i>(Optional)</i> |
| Parameter | Type | Description |
| --------- | ------------------------------------- | ------------ |
| event | [EventType](./puppeteer.eventtype.md) | _(Optional)_ |
**Returns:**

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

@ -16,15 +16,15 @@ export interface Configuration
## Properties
| Property | Modifiers | Type | Description | Default |
| ---------------------------------------------------------------------- | --------- | ------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [browserRevision?](./puppeteer.configuration.browserrevision.md) | | string | <p><i>(Optional)</i> 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?](./puppeteer.configuration.cachedirectory.md) | | string | <p><i>(Optional)</i> 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?](./puppeteer.configuration.defaultproduct.md) | | [Product](./puppeteer.product.md) | <p><i>(Optional)</i> Specifies which browser you'd like Puppeteer to use.</p><p>Can be overridden by <code>PUPPETEER_PRODUCT</code>.</p> | <code>'chrome'</code> |
| [downloadHost?](./puppeteer.configuration.downloadhost.md) | | string | <p><i>(Optional)</i> 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?](./puppeteer.configuration.downloadpath.md) | | string | <p><i>(Optional)</i> 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?](./puppeteer.configuration.executablepath.md) | | string | <p><i>(Optional)</i> 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?](./puppeteer.configuration.experiments.md) | | [ExperimentsConfiguration](./puppeteer.experimentsconfiguration.md) | <i>(Optional)</i> Defines experimental options for Puppeteer. | |
| [logLevel?](./puppeteer.configuration.loglevel.md) | | 'silent' \| 'error' \| 'warn' | <p><i>(Optional)</i> Tells Puppeteer to log at the given level.</p><p>At the moment, any option silences logging.</p> | <code>undefined</code> |
| [skipDownload?](./puppeteer.configuration.skipdownload.md) | | boolean | <p><i>(Optional)</i> Tells Puppeteer to not download during installation.</p><p>Can be overridden by <code>PUPPETEER_SKIP_DOWNLOAD</code>.</p> | |
| [temporaryDirectory?](./puppeteer.configuration.temporarydirectory.md) | | string | <p><i>(Optional)</i> Defines the directory to be used by Puppeteer for creating temporary files.</p><p>Can be overridden by <code>PUPPETEER_TMP_DIR</code>.</p> | <code>os.tmpdir()</code> |
| Property | Modifiers | Type | Description | Default |
| ---------------------------------------------------------------------- | --------- | ------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [browserRevision?](./puppeteer.configuration.browserrevision.md) | | string | <p>_(Optional)_ 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?](./puppeteer.configuration.cachedirectory.md) | | string | <p>_(Optional)_ 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?](./puppeteer.configuration.defaultproduct.md) | | [Product](./puppeteer.product.md) | <p>_(Optional)_ Specifies which browser you'd like Puppeteer to use.</p><p>Can be overridden by <code>PUPPETEER_PRODUCT</code>.</p> | <code>'chrome'</code> |
| [downloadHost?](./puppeteer.configuration.downloadhost.md) | | string | <p>_(Optional)_ 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?](./puppeteer.configuration.downloadpath.md) | | string | <p>_(Optional)_ 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?](./puppeteer.configuration.executablepath.md) | | string | <p>_(Optional)_ 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?](./puppeteer.configuration.experiments.md) | | [ExperimentsConfiguration](./puppeteer.experimentsconfiguration.md) | _(Optional)_ Defines experimental options for Puppeteer. | |
| [logLevel?](./puppeteer.configuration.loglevel.md) | | 'silent' \| 'error' \| 'warn' | <p>_(Optional)_ Tells Puppeteer to log at the given level.</p><p>At the moment, any option silences logging.</p> | <code>undefined</code> |
| [skipDownload?](./puppeteer.configuration.skipdownload.md) | | boolean | <p>_(Optional)_ Tells Puppeteer to not download during installation.</p><p>Can be overridden by <code>PUPPETEER_SKIP_DOWNLOAD</code>.</p> | |
| [temporaryDirectory?](./puppeteer.configuration.temporarydirectory.md) | | string | <p>_(Optional)_ Defines the directory to be used by Puppeteer for creating temporary files.</p><p>Can be overridden by <code>PUPPETEER_TMP_DIR</code>.</p> | <code>os.tmpdir()</code> |

10
docs/api/puppeteer.connection._constructor_.md
View File

@ -16,8 +16,8 @@ class Connection {
## Parameters
| Parameter | Type | Description |
| --------- | --------------------------------------------------------- | ----------------- |
| url | string | |
| transport | [ConnectionTransport](./puppeteer.connectiontransport.md) | |
| delay | number | <i>(Optional)</i> |
| Parameter | Type | Description |
| --------- | --------------------------------------------------------- | ------------ |
| url | string | |
| transport | [ConnectionTransport](./puppeteer.connectiontransport.md) | |
| delay | number | _(Optional)_ |

8
docs/api/puppeteer.connectiontransport.md
View File

@ -12,10 +12,10 @@ export interface ConnectionTransport
## Properties
| Property | Modifiers | Type | Description | Default |
| ---------------------------------------------------------- | --------- | ---------------------------- | ----------------- | ------- |
| [onclose?](./puppeteer.connectiontransport.onclose.md) | | () =&gt; void | <i>(Optional)</i> | |
| [onmessage?](./puppeteer.connectiontransport.onmessage.md) | | (message: string) =&gt; void | <i>(Optional)</i> | |
| Property | Modifiers | Type | Description | Default |
| ---------------------------------------------------------- | --------- | ---------------------------- | ------------ | ------- |
| [onclose?](./puppeteer.connectiontransport.onclose.md) | | () =&gt; void | _(Optional)_ | |
| [onmessage?](./puppeteer.connectiontransport.onmessage.md) | | (message: string) =&gt; void | _(Optional)_ | |
## Methods

12
docs/api/puppeteer.connectoptions.md
View File

@ -14,9 +14,9 @@ export interface ConnectOptions extends BrowserConnectOptions
## Properties
| Property | Modifiers | Type | Description | Default |
| --------------------------------------------------------------------- | --------- | --------------------------------------------------------- | --------------------------------------------------------------- | ------- |
| [browserURL?](./puppeteer.connectoptions.browserurl.md) | | string | <i>(Optional)</i> | |
| [browserWSEndpoint?](./puppeteer.connectoptions.browserwsendpoint.md) | | string | <i>(Optional)</i> | |
| [headers?](./puppeteer.connectoptions.headers.md) | | Record&lt;string, string&gt; | <i>(Optional)</i> Headers to use for the web socket connection. | |
| [transport?](./puppeteer.connectoptions.transport.md) | | [ConnectionTransport](./puppeteer.connectiontransport.md) | <i>(Optional)</i> | |
| Property | Modifiers | Type | Description | Default |
| --------------------------------------------------------------------- | --------- | --------------------------------------------------------- | ---------------------------------------------------------- | ------- |
| [browserURL?](./puppeteer.connectoptions.browserurl.md) | | string | _(Optional)_ | |
| [browserWSEndpoint?](./puppeteer.connectoptions.browserwsendpoint.md) | | string | _(Optional)_ | |
| [headers?](./puppeteer.connectoptions.headers.md) | | Record&lt;string, string&gt; | _(Optional)_ Headers to use for the web socket connection. | |
| [transport?](./puppeteer.connectoptions.transport.md) | | [ConnectionTransport](./puppeteer.connectiontransport.md) | _(Optional)_ | |

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

@ -12,8 +12,8 @@ export interface ConsoleMessageLocation
## Properties
| Property | Modifiers | Type | Description | Default |
| ------------------------------------------------------------------- | --------- | ------ | ----------------------------------------------------------------------------------------------------- | ------- |
| [columnNumber?](./puppeteer.consolemessagelocation.columnnumber.md) | | number | <i>(Optional)</i> 0-based column number in the resource if known or <code>undefined</code> otherwise. | |
| [lineNumber?](./puppeteer.consolemessagelocation.linenumber.md) | | number | <i>(Optional)</i> 0-based line number in the resource if known or <code>undefined</code> otherwise. | |
| [url?](./puppeteer.consolemessagelocation.url.md) | | string | <i>(Optional)</i> URL of the resource if known or <code>undefined</code> otherwise. | |
| Property | Modifiers | Type | Description | Default |
| ------------------------------------------------------------------- | --------- | ------ | ------------------------------------------------------------------------------------------------ | ------- |
| [columnNumber?](./puppeteer.consolemessagelocation.columnnumber.md) | | number | _(Optional)_ 0-based column number in the resource if known or <code>undefined</code> otherwise. | |
| [lineNumber?](./puppeteer.consolemessagelocation.linenumber.md) | | number | _(Optional)_ 0-based line number in the resource if known or <code>undefined</code> otherwise. | |
| [url?](./puppeteer.consolemessagelocation.url.md) | | string | _(Optional)_ URL of the resource if known or <code>undefined</code> otherwise. | |

12
docs/api/puppeteer.continuerequestoverrides.md
View File

@ -12,9 +12,9 @@ export interface ContinueRequestOverrides
## Properties
| Property | Modifiers | Type | Description | Default |
| ------------------------------------------------------------- | --------- | ---------------------------- | ------------------------------------------------------------------------------ | ------- |
| [headers?](./puppeteer.continuerequestoverrides.headers.md) | | Record&lt;string, string&gt; | <i>(Optional)</i> | |
| [method?](./puppeteer.continuerequestoverrides.method.md) | | string | <i>(Optional)</i> | |
| [postData?](./puppeteer.continuerequestoverrides.postdata.md) | | string | <i>(Optional)</i> | |
| [url?](./puppeteer.continuerequestoverrides.url.md) | | string | <i>(Optional)</i> If set, the request URL will change. This is not a redirect. | |
| Property | Modifiers | Type | Description | Default |
| ------------------------------------------------------------- | --------- | ---------------------------- | ------------------------------------------------------------------------- | ------- |
| [headers?](./puppeteer.continuerequestoverrides.headers.md) | | Record&lt;string, string&gt; | _(Optional)_ | |
| [method?](./puppeteer.continuerequestoverrides.method.md) | | string | _(Optional)_ | |
| [postData?](./puppeteer.continuerequestoverrides.postdata.md) | | string | _(Optional)_ | |
| [url?](./puppeteer.continuerequestoverrides.url.md) | | string | _(Optional)_ If set, the request URL will change. This is not a redirect. | |

6
docs/api/puppeteer.coverage.startcsscoverage.md
View File

@ -14,9 +14,9 @@ class Coverage {
## Parameters
| Parameter | Type | Description |
| --------- | ------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |
| options | [CSSCoverageOptions](./puppeteer.csscoverageoptions.md) | <i>(Optional)</i> Set of configurable options for coverage, defaults to <code>resetOnNavigation : true</code> |
| Parameter | Type | Description |
| --------- | ------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
| options | [CSSCoverageOptions](./puppeteer.csscoverageoptions.md) | _(Optional)_ Set of configurable options for coverage, defaults to <code>resetOnNavigation : true</code> |
**Returns:**

6
docs/api/puppeteer.coverage.startjscoverage.md
View File

@ -14,9 +14,9 @@ class Coverage {
## Parameters
| Parameter | Type | Description |
| --------- | ----------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| options | [JSCoverageOptions](./puppeteer.jscoverageoptions.md) | <i>(Optional)</i> Set of configurable options for coverage defaults to <code>resetOnNavigation : true, reportAnonymousScripts : false,</code> <code>includeRawScriptCoverage : false, useBlockCoverage : true</code> |
| Parameter | Type | Description |
| --------- | ----------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| options | [JSCoverageOptions](./puppeteer.jscoverageoptions.md) | _(Optional)_ Set of configurable options for coverage defaults to <code>resetOnNavigation : true, reportAnonymousScripts : false,</code> <code>includeRawScriptCoverage : false, useBlockCoverage : true</code> |
**Returns:**

6
docs/api/puppeteer.csscoverage.start.md
View File

@ -14,9 +14,9 @@ class CSSCoverage {
## Parameters
| Parameter | Type | Description |
| --------- | -------------------------------- | ----------------- |
| options | { resetOnNavigation?: boolean; } | <i>(Optional)</i> |
| Parameter | Type | Description |
| --------- | -------------------------------- | ------------ |
| options | { resetOnNavigation?: boolean; } | _(Optional)_ |
**Returns:**

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

@ -14,6 +14,6 @@ export interface CSSCoverageOptions
## Properties
| Property | Modifiers | Type | Description | Default |
| ------------------------------------------------------------------------- | --------- | ------- | ---------------------------------------------------------------- | ------- |
| [resetOnNavigation?](./puppeteer.csscoverageoptions.resetonnavigation.md) | | boolean | <i>(Optional)</i> Whether to reset coverage on every navigation. | |
| Property | Modifiers | Type | Description | Default |
| ------------------------------------------------------------------------- | --------- | ------- | ----------------------------------------------------------- | ------- |
| [resetOnNavigation?](./puppeteer.csscoverageoptions.resetonnavigation.md) | | boolean | _(Optional)_ Whether to reset coverage on every navigation. | |

8
docs/api/puppeteer.customqueryhandler.md
View File

@ -12,7 +12,7 @@ export interface CustomQueryHandler
## Properties
| Property | Modifiers | Type | Description | Default |
| ------------------------------------------------------- | --------- | --------------------------------------------------------- | ----------------- | ------- |
| [queryAll?](./puppeteer.customqueryhandler.queryall.md) | | (node: Node, selector: string) =&gt; Iterable&lt;Node&gt; | <i>(Optional)</i> | |
| [queryOne?](./puppeteer.customqueryhandler.queryone.md) | | (node: Node, selector: string) =&gt; Node \| null | <i>(Optional)</i> | |
| Property | Modifiers | Type | Description | Default |
| ------------------------------------------------------- | --------- | --------------------------------------------------------- | ------------ | ------- |
| [queryAll?](./puppeteer.customqueryhandler.queryall.md) | | (node: Node, selector: string) =&gt; Iterable&lt;Node&gt; | _(Optional)_ | |
| [queryOne?](./puppeteer.customqueryhandler.queryone.md) | | (node: Node, selector: string) =&gt; Node \| null | _(Optional)_ | |

6
docs/api/puppeteer.dialog.accept.md
View File

@ -14,9 +14,9 @@ class Dialog {
## Parameters
| Parameter | Type | Description |
| ---------- | ------ | ----------------------------------------------------------------------------------------------------------------------------------------- |
| promptText | string | <i>(Optional)</i> optional text that will be entered in the dialog prompt. Has no effect if the dialog's type is not <code>prompt</code>. |
| Parameter | Type | Description |
| ---------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------ |
| promptText | string | _(Optional)_ optional text that will be entered in the dialog prompt. Has no effect if the dialog's type is not <code>prompt</code>. |
**Returns:**

8
docs/api/puppeteer.elementhandle.click.md
View File

@ -16,10 +16,10 @@ class ElementHandle {
## Parameters
| Parameter | Type | Description |
| --------- | ------------------------------------------------------------ | ----------------- |
| this | [ElementHandle](./puppeteer.elementhandle.md)&lt;Element&gt; | |
| options | [ClickOptions](./puppeteer.clickoptions.md) | <i>(Optional)</i> |
| Parameter | Type | Description |
| --------- | ------------------------------------------------------------ | ------------ |
| this | [ElementHandle](./puppeteer.elementhandle.md)&lt;Element&gt; | |
| options | [ClickOptions](./puppeteer.clickoptions.md) | _(Optional)_ |
**Returns:**

6
docs/api/puppeteer.elementhandle.clickablepoint.md
View File

@ -16,9 +16,9 @@ class ElementHandle {
## Parameters
| Parameter | Type | Description |
| --------- | ------------------------------- | ----------------- |
| offset | [Offset](./puppeteer.offset.md) | <i>(Optional)</i> |
| Parameter | Type | Description |
| --------- | ------------------------------- | ------------ |
| offset | [Offset](./puppeteer.offset.md) | _(Optional)_ |
**Returns:**

10
docs/api/puppeteer.elementhandle.draganddrop.md
View File

@ -22,11 +22,11 @@ class ElementHandle {
## Parameters
| Parameter | Type | Description |
| --------- | ------------------------------------------------------------ | ----------------- |
| this | [ElementHandle](./puppeteer.elementhandle.md)&lt;Element&gt; | |
| target | [ElementHandle](./puppeteer.elementhandle.md)&lt;Node&gt; | |
| options | { delay: number; } | <i>(Optional)</i> |
| Parameter | Type | Description |
| --------- | ------------------------------------------------------------ | ------------ |
| this | [ElementHandle](./puppeteer.elementhandle.md)&lt;Element&gt; | |
| target | [ElementHandle](./puppeteer.elementhandle.md)&lt;Node&gt; | |
| options | { delay: number; } | _(Optional)_ |
**Returns:**

8
docs/api/puppeteer.elementhandle.dragenter.md
View File

@ -19,10 +19,10 @@ class ElementHandle {
## Parameters
| Parameter | Type | Description |
| --------- | ------------------------------------------------------------ | ----------------- |
| this | [ElementHandle](./puppeteer.elementhandle.md)&lt;Element&gt; | |
| data | Protocol.Input.DragData | <i>(Optional)</i> |
| Parameter | Type | Description |
| --------- | ------------------------------------------------------------ | ------------ |
| this | [ElementHandle](./puppeteer.elementhandle.md)&lt;Element&gt; | |
| data | Protocol.Input.DragData | _(Optional)_ |
**Returns:**

8
docs/api/puppeteer.elementhandle.dragover.md
View File

@ -19,10 +19,10 @@ class ElementHandle {
## Parameters
| Parameter | Type | Description |
| --------- | ------------------------------------------------------------ | ----------------- |
| this | [ElementHandle](./puppeteer.elementhandle.md)&lt;Element&gt; | |
| data | Protocol.Input.DragData | <i>(Optional)</i> |
| Parameter | Type | Description |
| --------- | ------------------------------------------------------------ | ------------ |
| this | [ElementHandle](./puppeteer.elementhandle.md)&lt;Element&gt; | |
| data | Protocol.Input.DragData | _(Optional)_ |
**Returns:**

8
docs/api/puppeteer.elementhandle.drop.md
View File

@ -19,10 +19,10 @@ class ElementHandle {
## Parameters
| Parameter | Type | Description |
| --------- | ------------------------------------------------------------ | ----------------- |
| this | [ElementHandle](./puppeteer.elementhandle.md)&lt;Element&gt; | |
| data | Protocol.Input.DragData | <i>(Optional)</i> |
| Parameter | Type | Description |
| --------- | ------------------------------------------------------------ | ------------ |
| this | [ElementHandle](./puppeteer.elementhandle.md)&lt;Element&gt; | |
| data | Protocol.Input.DragData | _(Optional)_ |
**Returns:**

8
docs/api/puppeteer.elementhandle.isintersectingviewport.md
View File

@ -21,10 +21,10 @@ class ElementHandle {
## Parameters
| Parameter | Type | Description |
| --------- | ------------------------------------------------------------ | ----------------- |
| this | [ElementHandle](./puppeteer.elementhandle.md)&lt;Element&gt; | |
| options | { threshold?: number; } | <i>(Optional)</i> |
| Parameter | Type | Description |
| --------- | ------------------------------------------------------------ | ------------ |
| this | [ElementHandle](./puppeteer.elementhandle.md)&lt;Element&gt; | |
| options | { threshold?: number; } | _(Optional)_ |
**Returns:**

2
docs/api/puppeteer.elementhandle.press.md
View File

@ -19,7 +19,7 @@ class ElementHandle {
| Parameter | Type | Description |
| --------- | ------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
| key | [KeyInput](./puppeteer.keyinput.md) | Name of key to press, such as <code>ArrowLeft</code>. See [KeyInput](./puppeteer.keyinput.md) for a list of all key names. |
| options | [PressOptions](./puppeteer.pressoptions.md) | <i>(Optional)</i> |
| options | [PressOptions](./puppeteer.pressoptions.md) | _(Optional)_ |
**Returns:**

8
docs/api/puppeteer.elementhandle.screenshot.md
View File

@ -19,10 +19,10 @@ class ElementHandle {
## Parameters
| Parameter | Type | Description |
| --------- | ------------------------------------------------------------ | ----------------- |
| this | [ElementHandle](./puppeteer.elementhandle.md)&lt;Element&gt; | |
| options | [ScreenshotOptions](./puppeteer.screenshotoptions.md) | <i>(Optional)</i> |
| Parameter | Type | Description |
| --------- | ------------------------------------------------------------ | ------------ |
| this | [ElementHandle](./puppeteer.elementhandle.md)&lt;Element&gt; | |
| options | [ScreenshotOptions](./puppeteer.screenshotoptions.md) | _(Optional)_ |
**Returns:**

8
docs/api/puppeteer.elementhandle.type.md
View File

@ -23,10 +23,10 @@ class ElementHandle {
## Parameters
| Parameter | Type | Description |
| --------- | ------------------ | ----------------- |
| text | string | |
| options | { delay: number; } | <i>(Optional)</i> |
| Parameter | Type | Description |
| --------- | ------------------ | ------------ |
| text | string | |
| options | { delay: number; } | _(Optional)_ |
**Returns:**

8
docs/api/puppeteer.elementhandle.waitforselector.md
View File

@ -21,10 +21,10 @@ class ElementHandle {
## Parameters
| Parameter | Type | Description |
| --------- | --------------------------------------------------------------- | ----------------------------------------------------------- |
| selector | Selector | The selector to query and wait for. |
| options | [WaitForSelectorOptions](./puppeteer.waitforselectoroptions.md) | <i>(Optional)</i> Options for customizing waiting behavior. |
| Parameter | Type | Description |
| --------- | --------------------------------------------------------------- | ------------------------------------------------------ |
| selector | Selector | The selector to query and wait for. |
| options | [WaitForSelectorOptions](./puppeteer.waitforselectoroptions.md) | _(Optional)_ Options for customizing waiting behavior. |
**Returns:**

2
docs/api/puppeteer.elementhandle.waitforxpath.md
View File

@ -58,7 +58,7 @@ class ElementHandle {
| Parameter | Type | Description |
| --------- | ---------------------------------------------------------- | --------------------------------------------------------------------------------------- |
| xpath | string | A [xpath](https://developer.mozilla.org/en-US/docs/Web/XPath) of an element to wait for |
| options | { visible?: boolean; hidden?: boolean; timeout?: number; } | <i>(Optional)</i> Optional waiting parameters |
| options | { visible?: boolean; hidden?: boolean; timeout?: number; } | _(Optional)_ Optional waiting parameters |
**Returns:**

8
docs/api/puppeteer.eventemitter.emit.md
View File

@ -16,10 +16,10 @@ class EventEmitter {
## Parameters
| Parameter | Type | Description |
| --------- | ------------------------------------- | ------------------------------------------------------------ |
| event | [EventType](./puppeteer.eventtype.md) | the event you'd like to emit |
| eventData | unknown | <i>(Optional)</i> any data you'd like to emit with the event |
| Parameter | Type | Description |
| --------- | ------------------------------------- | ------------------------------------------------------- |
| event | [EventType](./puppeteer.eventtype.md) | the event you'd like to emit |
| eventData | unknown | _(Optional)_ any data you'd like to emit with the event |
**Returns:**

6
docs/api/puppeteer.eventemitter.removealllisteners.md
View File

@ -16,9 +16,9 @@ class EventEmitter {
## Parameters
| Parameter | Type | Description |
| --------- | ------------------------------------- | ---------------------------------------------------- |
| event | [EventType](./puppeteer.eventtype.md) | <i>(Optional)</i> the event to remove listeners for. |
| Parameter | Type | Description |
| --------- | ------------------------------------- | ----------------------------------------------- |
| event | [EventType](./puppeteer.eventtype.md) | _(Optional)_ the event to remove listeners for. |
**Returns:**

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

@ -16,6 +16,6 @@ export interface ExperimentsConfiguration
## Properties
| Property | Modifiers | Type | Description | Default |
| --------------------------------------------------------------------------------------- | --------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ |
| [macArmChromiumEnabled?](./puppeteer.experimentsconfiguration.macarmchromiumenabled.md) | | boolean | <p><i>(Optional)</i> Require Puppeteer to download Chromium for Apple M1.</p><p>On Apple M1 devices Puppeteer by default downloads the version for Intel's processor which runs via Rosetta. It works without any problems, however, with this option, you should get more efficient resource usage (CPU and RAM) that could lead to a faster execution time.</p><p>Can be overridden by <code>PUPPETEER_EXPERIMENTAL_CHROMIUM_MAC_ARM</code>.</p> | <code>false</code> |
| Property | Modifiers | Type | Description | Default |
| --------------------------------------------------------------------------------------- | --------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ |
| [macArmChromiumEnabled?](./puppeteer.experimentsconfiguration.macarmchromiumenabled.md) | | boolean | <p>_(Optional)_ Require Puppeteer to download Chromium for Apple M1.</p><p>On Apple M1 devices Puppeteer by default downloads the version for Intel's processor which runs via Rosetta. It works without any problems, however, with this option, you should get more efficient resource usage (CPU and RAM) that could lead to a faster execution time.</p><p>Can be overridden by <code>PUPPETEER_EXPERIMENTAL_CHROMIUM_MAC_ARM</code>.</p> | <code>false</code> |

2
docs/api/puppeteer.frame.click.md
View File

@ -26,7 +26,7 @@ class Frame {
| Parameter | Type | Description |
| --------- | -------------------------------------------------------------------------------------------- | -------------------------- |
| selector | string | The selector to query for. |
| options | { delay?: number; button?: [MouseButton](./puppeteer.mousebutton.md); clickCount?: number; } | <i>(Optional)</i> |
| options | { delay?: number; button?: [MouseButton](./puppeteer.mousebutton.md); clickCount?: number; } | _(Optional)_ |
**Returns:**

8
docs/api/puppeteer.frame.goto.md
View File

@ -24,10 +24,10 @@ class Frame {
## Parameters
| Parameter | Type | Description |
| --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| url | string | the URL to navigate the frame to. This should include the scheme, e.g. <code>https://</code>. |
| options | { referer?: string; referrerPolicy?: string; timeout?: number; waitUntil?: [PuppeteerLifeCycleEvent](./puppeteer.puppeteerlifecycleevent.md) \| [PuppeteerLifeCycleEvent](./puppeteer.puppeteerlifecycleevent.md)\[\]; } | <i>(Optional)</i> navigation options. <code>waitUntil</code> is useful to define when the navigation should be considered successful - see the docs for [PuppeteerLifeCycleEvent](./puppeteer.puppeteerlifecycleevent.md) for more details. |
| Parameter | Type | Description |
| --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| url | string | the URL to navigate the frame to. This should include the scheme, e.g. <code>https://</code>. |
| options | { referer?: string; referrerPolicy?: string; timeout?: number; waitUntil?: [PuppeteerLifeCycleEvent](./puppeteer.puppeteerlifecycleevent.md) \| [PuppeteerLifeCycleEvent](./puppeteer.puppeteerlifecycleevent.md)\[\]; } | _(Optional)_ navigation options. <code>waitUntil</code> is useful to define when the navigation should be considered successful - see the docs for [PuppeteerLifeCycleEvent](./puppeteer.puppeteerlifecycleevent.md) for more details. |
**Returns:**

8
docs/api/puppeteer.frame.setcontent.md
View File

@ -22,10 +22,10 @@ class Frame {
## Parameters
| Parameter | Type | Description |
| --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
| html | string | HTML markup to assign to the page. |
| options | { timeout?: number; waitUntil?: [PuppeteerLifeCycleEvent](./puppeteer.puppeteerlifecycleevent.md) \| [PuppeteerLifeCycleEvent](./puppeteer.puppeteerlifecycleevent.md)\[\]; } | <i>(Optional)</i> Options to configure how long before timing out and at what point to consider the content setting successful. |
| Parameter | Type | Description |
| --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
| html | string | HTML markup to assign to the page. |
| options | { timeout?: number; waitUntil?: [PuppeteerLifeCycleEvent](./puppeteer.puppeteerlifecycleevent.md) \| [PuppeteerLifeCycleEvent](./puppeteer.puppeteerlifecycleevent.md)\[\]; } | _(Optional)_ Options to configure how long before timing out and at what point to consider the content setting successful. |
**Returns:**

10
docs/api/puppeteer.frame.type.md
View File

@ -22,11 +22,11 @@ class Frame {
## Parameters
| Parameter | Type | Description |
| --------- | ------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
| selector | string | the selector for the element to type into. If there are multiple the first will be used. |
| text | string | text to type into the element |
| options | { delay: number; } | <i>(Optional)</i> takes one option, <code>delay</code>, which sets the time to wait between key presses in milliseconds. Defaults to <code>0</code>. |
| Parameter | Type | Description |
| --------- | ------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------- |
| selector | string | the selector for the element to type into. If there are multiple the first will be used. |
| text | string | text to type into the element |
| options | { delay: number; } | _(Optional)_ takes one option, <code>delay</code>, which sets the time to wait between key presses in milliseconds. Defaults to <code>0</code>. |
**Returns:**

10
docs/api/puppeteer.frame.waitforfunction.md
View File

@ -21,11 +21,11 @@ class Frame {
## Parameters
| Parameter | Type | Description |
| ------------ | ------------------------------------------------------------------------- | ---------------------------------------------------------------------- |
| pageFunction | Func \| string | the function to evaluate in the frame context. |
| options | [FrameWaitForFunctionOptions](./puppeteer.framewaitforfunctionoptions.md) | <i>(Optional)</i> options to configure the polling method and timeout. |
| args | Params | arguments to pass to the <code>pageFunction</code>. |
| Parameter | Type | Description |
| ------------ | ------------------------------------------------------------------------- | ----------------------------------------------------------------- |
| pageFunction | Func \| string | the function to evaluate in the frame context. |
| options | [FrameWaitForFunctionOptions](./puppeteer.framewaitforfunctionoptions.md) | _(Optional)_ options to configure the polling method and timeout. |
| args | Params | arguments to pass to the <code>pageFunction</code>. |
**Returns:**

6
docs/api/puppeteer.frame.waitfornavigation.md
View File

@ -21,9 +21,9 @@ class Frame {
## Parameters
| Parameter | Type | Description |
| --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
| options | { timeout?: number; waitUntil?: [PuppeteerLifeCycleEvent](./puppeteer.puppeteerlifecycleevent.md) \| [PuppeteerLifeCycleEvent](./puppeteer.puppeteerlifecycleevent.md)\[\]; } | <i>(Optional)</i> options to configure when the navigation is consided finished. |
| Parameter | Type | Description |
| --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------- |
| options | { timeout?: number; waitUntil?: [PuppeteerLifeCycleEvent](./puppeteer.puppeteerlifecycleevent.md) \| [PuppeteerLifeCycleEvent](./puppeteer.puppeteerlifecycleevent.md)\[\]; } | _(Optional)_ options to configure when the navigation is consided finished. |
**Returns:**

8
docs/api/puppeteer.frame.waitforselector.md
View File

@ -21,10 +21,10 @@ class Frame {
## Parameters
| Parameter | Type | Description |
| --------- | --------------------------------------------------------------- | ----------------------------------------------------------- |
| selector | Selector | The selector to query and wait for. |
| options | [WaitForSelectorOptions](./puppeteer.waitforselectoroptions.md) | <i>(Optional)</i> Options for customizing waiting behavior. |
| Parameter | Type | Description |
| --------- | --------------------------------------------------------------- | ------------------------------------------------------ |
| selector | Selector | The selector to query and wait for. |
| options | [WaitForSelectorOptions](./puppeteer.waitforselectoroptions.md) | _(Optional)_ Options for customizing waiting behavior. |
**Returns:**

8
docs/api/puppeteer.frame.waitforxpath.md
View File

@ -29,10 +29,10 @@ class Frame {
## Parameters
| Parameter | Type | Description |
| --------- | --------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------ |
| xpath | string | the XPath expression to wait for. |
| options | [WaitForSelectorOptions](./puppeteer.waitforselectoroptions.md) | <i>(Optional)</i> options to configure the visibility of the element and how long to wait before timing out. |
| Parameter | Type | Description |
| --------- | --------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
| xpath | string | the XPath expression to wait for. |
| options | [WaitForSelectorOptions](./puppeteer.waitforselectoroptions.md) | _(Optional)_ options to configure the visibility of the element and how long to wait before timing out. |
**Returns:**

14
docs/api/puppeteer.frameaddscripttagoptions.md
View File

@ -12,10 +12,10 @@ export interface FrameAddScriptTagOptions
## Properties
| Property | Modifiers | Type | Description | Default |
| ----------------------------------------------------------- | --------- | ------ | ---------------------------------------------------------------------------------------------------------------------- | ------- |
| [content?](./puppeteer.frameaddscripttagoptions.content.md) | | string | <i>(Optional)</i> JavaScript to be injected into the frame. | |
| [id?](./puppeteer.frameaddscripttagoptions.id.md) | | string | <i>(Optional)</i> Sets the <code>id</code> of the script. | |
| [path?](./puppeteer.frameaddscripttagoptions.path.md) | | string | <i>(Optional)</i> Path to a JavaScript file to be injected into the frame. | |
| [type?](./puppeteer.frameaddscripttagoptions.type.md) | | string | <i>(Optional)</i> Sets the <code>type</code> of the script. Use <code>module</code> in order to load an ES2015 module. | |
| [url?](./puppeteer.frameaddscripttagoptions.url.md) | | string | <i>(Optional)</i> URL of the script to be added. | |
| Property | Modifiers | Type | Description | Default |
| ----------------------------------------------------------- | --------- | ------ | ----------------------------------------------------------------------------------------------------------------- | ------- |
| [content?](./puppeteer.frameaddscripttagoptions.content.md) | | string | _(Optional)_ JavaScript to be injected into the frame. | |
| [id?](./puppeteer.frameaddscripttagoptions.id.md) | | string | _(Optional)_ Sets the <code>id</code> of the script. | |
| [path?](./puppeteer.frameaddscripttagoptions.path.md) | | string | _(Optional)_ Path to a JavaScript file to be injected into the frame. | |
| [type?](./puppeteer.frameaddscripttagoptions.type.md) | | string | _(Optional)_ Sets the <code>type</code> of the script. Use <code>module</code> in order to load an ES2015 module. | |
| [url?](./puppeteer.frameaddscripttagoptions.url.md) | | string | _(Optional)_ URL of the script to be added. | |

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

@ -12,8 +12,8 @@ export interface FrameAddStyleTagOptions
## Properties
| Property | Modifiers | Type | Description | Default |
| ---------------------------------------------------------- | --------- | ------ | ----------------------------------------------------------------------- | ------- |
| [content?](./puppeteer.frameaddstyletagoptions.content.md) | | string | <i>(Optional)</i> Raw CSS content to be injected into the frame. | |
| [path?](./puppeteer.frameaddstyletagoptions.path.md) | | string | <i>(Optional)</i> The path to a CSS file to be injected into the frame. | |
| [url?](./puppeteer.frameaddstyletagoptions.url.md) | | string | <i>(Optional)</i> the URL of the CSS file to be added. | |
| Property | Modifiers | Type | Description | Default |
| ---------------------------------------------------------- | --------- | ------ | ------------------------------------------------------------------ | ------- |
| [content?](./puppeteer.frameaddstyletagoptions.content.md) | | string | _(Optional)_ Raw CSS content to be injected into the frame. | |
| [path?](./puppeteer.frameaddstyletagoptions.path.md) | | string | _(Optional)_ The path to a CSS file to be injected into the frame. | |
| [url?](./puppeteer.frameaddstyletagoptions.url.md) | | string | _(Optional)_ the URL of the CSS file to be added. | |

8
docs/api/puppeteer.framewaitforfunctionoptions.md
View File

@ -12,7 +12,7 @@ export interface FrameWaitForFunctionOptions
## Properties
| Property | Modifiers | Type | Description | Default |
| -------------------------------------------------------------- | --------- | ----------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- |
| [polling?](./puppeteer.framewaitforfunctionoptions.polling.md) | | 'raf' \| 'mutation' \| number | <p><i>(Optional)</i> An interval at which the <code>pageFunction</code> is executed, defaults to <code>raf</code>. If <code>polling</code> is a number, then it is treated as an interval in milliseconds at which the function would be executed. If <code>polling</code> is a string, then it can be one of the following values:</p><p>- <code>raf</code> - to constantly execute <code>pageFunction</code> in <code>requestAnimationFrame</code> callback. This is the tightest polling mode which is suitable to observe styling changes.</p><p>- <code>mutation</code> - to execute <code>pageFunction</code> on every DOM mutation.</p> | |
| [timeout?](./puppeteer.framewaitforfunctionoptions.timeout.md) | | number | <i>(Optional)</i> Maximum time to wait in milliseconds. Defaults to <code>30000</code> (30 seconds). Pass <code>0</code> to disable the timeout. Puppeteer's default timeout can be changed using [Page.setDefaultTimeout()](./puppeteer.page.setdefaulttimeout.md). | |
| Property | Modifiers | Type | Description | Default |
| -------------------------------------------------------------- | --------- | ----------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- |
| [polling?](./puppeteer.framewaitforfunctionoptions.polling.md) | | 'raf' \| 'mutation' \| number | <p>_(Optional)_ An interval at which the <code>pageFunction</code> is executed, defaults to <code>raf</code>. If <code>polling</code> is a number, then it is treated as an interval in milliseconds at which the function would be executed. If <code>polling</code> is a string, then it can be one of the following values:</p><p>- <code>raf</code> - to constantly execute <code>pageFunction</code> in <code>requestAnimationFrame</code> callback. This is the tightest polling mode which is suitable to observe styling changes.</p><p>- <code>mutation</code> - to execute <code>pageFunction</code> on every DOM mutation.</p> | |
| [timeout?](./puppeteer.framewaitforfunctionoptions.timeout.md) | | number | _(Optional)_ Maximum time to wait in milliseconds. Defaults to <code>30000</code> (30 seconds). Pass <code>0</code> to disable the timeout. Puppeteer's default timeout can be changed using [Page.setDefaultTimeout()](./puppeteer.page.setdefaulttimeout.md). | |

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

@ -14,6 +14,6 @@ export interface GeolocationOptions
| Property | Modifiers | Type | Description | Default |
| -------------------------------------------------------- | --------- | ------ | --------------------------------------------------------- | ------- |
| [accuracy?](./puppeteer.geolocationoptions.accuracy.md) | | number | <i>(Optional)</i> Optional non-negative accuracy value. | |
| [accuracy?](./puppeteer.geolocationoptions.accuracy.md) | | number | _(Optional)_ Optional non-negative accuracy value. | |
| [latitude](./puppeteer.geolocationoptions.latitude.md) | | number | Longitude between <code>-180</code> and <code>180</code>. | |
| [longitude](./puppeteer.geolocationoptions.longitude.md) | | number | Latitude between <code>-90</code> and <code>90</code>. | |

8
docs/api/puppeteer.httprequest.abort.md
View File

@ -16,10 +16,10 @@ class HTTPRequest {
## Parameters
| Parameter | Type | Description |
| --------- | ------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
| errorCode | [ErrorCode](./puppeteer.errorcode.md) | <i>(Optional)</i> optional error code to provide. |
| priority | number | <i>(Optional)</i> If provided, intercept is resolved using cooperative handling rules. Otherwise, intercept is resolved immediately. |
| Parameter | Type | Description |
| --------- | ------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
| errorCode | [ErrorCode](./puppeteer.errorcode.md) | _(Optional)_ optional error code to provide. |
| priority | number | _(Optional)_ If provided, intercept is resolved using cooperative handling rules. Otherwise, intercept is resolved immediately. |
**Returns:**

8
docs/api/puppeteer.httprequest.continue.md
View File

@ -19,10 +19,10 @@ class HTTPRequest {
## Parameters
| Parameter | Type | Description |
| --------- | ------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
| overrides | [ContinueRequestOverrides](./puppeteer.continuerequestoverrides.md) | <i>(Optional)</i> optional overrides to apply to the request. |
| priority | number | <i>(Optional)</i> If provided, intercept is resolved using cooperative handling rules. Otherwise, intercept is resolved immediately. |
| Parameter | Type | Description |
| --------- | ------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
| overrides | [ContinueRequestOverrides](./puppeteer.continuerequestoverrides.md) | _(Optional)_ optional overrides to apply to the request. |
| priority | number | _(Optional)_ If provided, intercept is resolved using cooperative handling rules. Otherwise, intercept is resolved immediately. |
**Returns:**

8
docs/api/puppeteer.httprequest.respond.md
View File

@ -19,10 +19,10 @@ class HTTPRequest {
## Parameters
| Parameter | Type | Description |
| --------- | ---------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
| response | Partial&lt;[ResponseForRequest](./puppeteer.responseforrequest.md)&gt; | the response to fulfill the request with. |
| priority | number | <i>(Optional)</i> If provided, intercept is resolved using cooperative handling rules. Otherwise, intercept is resolved immediately. |
| Parameter | Type | Description |
| --------- | ---------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
| response | Partial&lt;[ResponseForRequest](./puppeteer.responseforrequest.md)&gt; | the response to fulfill the request with. |
| priority | number | _(Optional)_ If provided, intercept is resolved using cooperative handling rules. Otherwise, intercept is resolved immediately. |
**Returns:**

8
docs/api/puppeteer.interceptresolutionstate.md
View File

@ -12,7 +12,7 @@ export interface InterceptResolutionState
## Properties
| Property | Modifiers | Type | Description | Default |
| ------------------------------------------------------------- | --------- | --------------------------------------------------------------------- | ----------------- | ------- |
| [action](./puppeteer.interceptresolutionstate.action.md) | | [InterceptResolutionAction](./puppeteer.interceptresolutionaction.md) | | |
| [priority?](./puppeteer.interceptresolutionstate.priority.md) | | number | <i>(Optional)</i> | |
| Property | Modifiers | Type | Description | Default |
| ------------------------------------------------------------- | --------- | --------------------------------------------------------------------- | ------------ | ------- |
| [action](./puppeteer.interceptresolutionstate.action.md) | | [InterceptResolutionAction](./puppeteer.interceptresolutionaction.md) | | |
| [priority?](./puppeteer.interceptresolutionstate.priority.md) | | number | _(Optional)_ | |

6
docs/api/puppeteer.jscoverage.start.md
View File

@ -19,9 +19,9 @@ class JSCoverage {
## Parameters
| Parameter | Type | Description |
| --------- | ---------------------------------------------------------------------------------------------------------------------------------- | ----------------- |
| options | { resetOnNavigation?: boolean; reportAnonymousScripts?: boolean; includeRawScriptCoverage?: boolean; useBlockCoverage?: boolean; } | <i>(Optional)</i> |
| Parameter | Type | Description |
| --------- | ---------------------------------------------------------------------------------------------------------------------------------- | ------------ |
| options | { resetOnNavigation?: boolean; reportAnonymousScripts?: boolean; includeRawScriptCoverage?: boolean; useBlockCoverage?: boolean; } | _(Optional)_ |
**Returns:**

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

@ -16,6 +16,6 @@ export interface JSCoverageEntry extends CoverageEntry
## Properties
| Property | Modifiers | Type | Description | Default |
| ---------------------------------------------------------------------- | --------- | -------------------------------- | ----------------------------------------------- | ------- |
| [rawScriptCoverage?](./puppeteer.jscoverageentry.rawscriptcoverage.md) | | Protocol.Profiler.ScriptCoverage | <i>(Optional)</i> Raw V8 script coverage entry. | |
| Property | Modifiers | Type | Description | Default |
| ---------------------------------------------------------------------- | --------- | -------------------------------- | ------------------------------------------ | ------- |
| [rawScriptCoverage?](./puppeteer.jscoverageentry.rawscriptcoverage.md) | | Protocol.Profiler.ScriptCoverage | _(Optional)_ Raw V8 script coverage entry. | |

12
docs/api/puppeteer.jscoverageoptions.md
View File

@ -14,9 +14,9 @@ export interface JSCoverageOptions
## Properties
| Property | Modifiers | Type | Description | Default |
| -------------------------------------------------------------------------------------- | --------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- |
| [includeRawScriptCoverage?](./puppeteer.jscoverageoptions.includerawscriptcoverage.md) | | boolean | <i>(Optional)</i> Whether the result includes raw V8 script coverage entries. | |
| [reportAnonymousScripts?](./puppeteer.jscoverageoptions.reportanonymousscripts.md) | | boolean | <i>(Optional)</i> Whether anonymous scripts generated by the page should be reported. | |
| [resetOnNavigation?](./puppeteer.jscoverageoptions.resetonnavigation.md) | | boolean | <i>(Optional)</i> Whether to reset coverage on every navigation. | |
| [useBlockCoverage?](./puppeteer.jscoverageoptions.useblockcoverage.md) | | boolean | <i>(Optional)</i> Whether to collect coverage information at the block level. If true, coverage will be collected at the block level (this is the default). If false, coverage will be collected at the function level. | |
| Property | Modifiers | Type | Description | Default |
| -------------------------------------------------------------------------------------- | --------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------- |
| [includeRawScriptCoverage?](./puppeteer.jscoverageoptions.includerawscriptcoverage.md) | | boolean | _(Optional)_ Whether the result includes raw V8 script coverage entries. | |
| [reportAnonymousScripts?](./puppeteer.jscoverageoptions.reportanonymousscripts.md) | | boolean | _(Optional)_ Whether anonymous scripts generated by the page should be reported. | |
| [resetOnNavigation?](./puppeteer.jscoverageoptions.resetonnavigation.md) | | boolean | _(Optional)_ Whether to reset coverage on every navigation. | |
| [useBlockCoverage?](./puppeteer.jscoverageoptions.useblockcoverage.md) | | boolean | _(Optional)_ Whether to collect coverage information at the block level. If true, coverage will be collected at the block level (this is the default). If false, coverage will be collected at the function level. | |

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

@ -28,9 +28,9 @@ const windowHandle = await page.evaluateHandle(() => window);
## Properties
| Property | Modifiers | Type | Description |
| --------------------------------------------------------------------- | --------- | ---- | -------------------------------------------------------------------------------- |
| [\[\_\_JSHandleSymbol\]?](./puppeteer.jshandle.___jshandlesymbol_.md) | | T | <i>(Optional)</i> Used for nominally typing [JSHandle](./puppeteer.jshandle.md). |
| Property | Modifiers | Type | Description |
| --------------------------------------------------------------------- | --------- | ---- | --------------------------------------------------------------------------- |
| [\[\_\_JSHandleSymbol\]?](./puppeteer.jshandle.___jshandlesymbol_.md) | | T | _(Optional)_ Used for nominally typing [JSHandle](./puppeteer.jshandle.md). |
## Methods

8
docs/api/puppeteer.keyboard.down.md
View File

@ -22,10 +22,10 @@ class Keyboard {
## Parameters
| Parameter | Type | Description |
| --------- | ----------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| key | [KeyInput](./puppeteer.keyinput.md) | Name of key to press, such as <code>ArrowLeft</code>. See [KeyInput](./puppeteer.keyinput.md) for a list of all key names. |
| options | { text?: string; commands?: string\[\]; } | <i>(Optional)</i> An object of options. Accepts text which, if specified, generates an input event with this text. Accepts commands which, if specified, is the commands of keyboard shortcuts, see [Chromium Source Code](https://source.chromium.org/chromium/chromium/src/+/main:third_party/blink/renderer/core/editing/commands/editor_command_names.h) for valid command names. |
| Parameter | Type | Description |
| --------- | ----------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| key | [KeyInput](./puppeteer.keyinput.md) | Name of key to press, such as <code>ArrowLeft</code>. See [KeyInput](./puppeteer.keyinput.md) for a list of all key names. |
| options | { text?: string; commands?: string\[\]; } | _(Optional)_ An object of options. Accepts text which, if specified, generates an input event with this text. Accepts commands which, if specified, is the commands of keyboard shortcuts, see [Chromium Source Code](https://source.chromium.org/chromium/chromium/src/+/main:third_party/blink/renderer/core/editing/commands/editor_command_names.h) for valid command names. |
**Returns:**

8
docs/api/puppeteer.keyboard.press.md
View File

@ -23,10 +23,10 @@ class Keyboard {
## Parameters
| Parameter | Type | Description |
| --------- | --------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| key | [KeyInput](./puppeteer.keyinput.md) | Name of key to press, such as <code>ArrowLeft</code>. See [KeyInput](./puppeteer.keyinput.md) for a list of all key names. |
| options | { delay?: number; text?: string; commands?: string\[\]; } | <i>(Optional)</i> An object of options. Accepts text which, if specified, generates an input event with this text. Accepts delay which, if specified, is the time to wait between <code>keydown</code> and <code>keyup</code> in milliseconds. Defaults to 0. Accepts commands which, if specified, is the commands of keyboard shortcuts, see [Chromium Source Code](https://source.chromium.org/chromium/chromium/src/+/main:third_party/blink/renderer/core/editing/commands/editor_command_names.h) for valid command names. |
| Parameter | Type | Description |
| --------- | --------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| key | [KeyInput](./puppeteer.keyinput.md) | Name of key to press, such as <code>ArrowLeft</code>. See [KeyInput](./puppeteer.keyinput.md) for a list of all key names. |
| options | { delay?: number; text?: string; commands?: string\[\]; } | _(Optional)_ An object of options. Accepts text which, if specified, generates an input event with this text. Accepts delay which, if specified, is the time to wait between <code>keydown</code> and <code>keyup</code> in milliseconds. Defaults to 0. Accepts commands which, if specified, is the commands of keyboard shortcuts, see [Chromium Source Code](https://source.chromium.org/chromium/chromium/src/+/main:third_party/blink/renderer/core/editing/commands/editor_command_names.h) for valid command names. |
**Returns:**

8
docs/api/puppeteer.keyboard.type.md
View File

@ -21,10 +21,10 @@ class Keyboard {
## Parameters
| Parameter | Type | Description |
| --------- | ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| text | string | A text to type into a focused element. |
| options | { delay?: number; } | <i>(Optional)</i> An object of options. Accepts delay which, if specified, is the time to wait between <code>keydown</code> and <code>keyup</code> in milliseconds. Defaults to 0. |
| Parameter | Type | Description |
| --------- | ------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| text | string | A text to type into a focused element. |
| options | { delay?: number; } | _(Optional)_ An object of options. Accepts delay which, if specified, is the time to wait between <code>keydown</code> and <code>keyup</code> in milliseconds. Defaults to 0. |
**Returns:**

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

@ -14,18 +14,18 @@ export interface LaunchOptions
## Properties
| Property | Modifiers | Type | Description | Default |
| ---------------------------------------------------------------------- | --------- | ----------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------- |
| [channel?](./puppeteer.launchoptions.channel.md) | | [ChromeReleaseChannel](./puppeteer.chromereleasechannel.md) | <i>(Optional)</i> Chrome Release Channel | |
| [dumpio?](./puppeteer.launchoptions.dumpio.md) | | boolean | <i>(Optional)</i> If true, pipes the browser process stdout and stderr to <code>process.stdout</code> and <code>process.stderr</code>. | false |
| [env?](./puppeteer.launchoptions.env.md) | | Record&lt;string, string \| undefined&gt; | <i>(Optional)</i> Specify environment variables that will be visible to the browser. | The contents of <code>process.env</code>. |
| [executablePath?](./puppeteer.launchoptions.executablepath.md) | | string | <i>(Optional)</i> 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?](./puppeteer.launchoptions.extraprefsfirefox.md) | | Record&lt;string, unknown&gt; | <i>(Optional)</i> [Additional preferences](https://searchfox.org/mozilla-release/source/modules/libpref/init/all.js) that can be passed when launching with Firefox. | |
| [handleSIGHUP?](./puppeteer.launchoptions.handlesighup.md) | | boolean | <i>(Optional)</i> Close the browser process on <code>SIGHUP</code>. | <code>true</code> |
| [handleSIGINT?](./puppeteer.launchoptions.handlesigint.md) | | boolean | <i>(Optional)</i> Close the browser process on <code>Ctrl+C</code>. | <code>true</code> |
| [handleSIGTERM?](./puppeteer.launchoptions.handlesigterm.md) | | boolean | <i>(Optional)</i> Close the browser process on <code>SIGTERM</code>. | <code>true</code> |
| [ignoreDefaultArgs?](./puppeteer.launchoptions.ignoredefaultargs.md) | | boolean \| string\[\] | <i>(Optional)</i> 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 |
| [pipe?](./puppeteer.launchoptions.pipe.md) | | boolean | <i>(Optional)</i> Connect to a browser over a pipe instead of a WebSocket. | false |
| [product?](./puppeteer.launchoptions.product.md) | | [Product](./puppeteer.product.md) | <i>(Optional)</i> Which browser to launch. | <code>chrome</code> |
| [timeout?](./puppeteer.launchoptions.timeout.md) | | number | <i>(Optional)</i> Maximum time in milliseconds to wait for the browser to start. Pass <code>0</code> to disable the timeout. | 30000 (30 seconds). |
| [waitForInitialPage?](./puppeteer.launchoptions.waitforinitialpage.md) | | boolean | <i>(Optional)</i> 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 |
| Property | Modifiers | Type | Description | Default |
| ---------------------------------------------------------------------- | --------- | ----------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------- |
| [channel?](./puppeteer.launchoptions.channel.md) | | [ChromeReleaseChannel](./puppeteer.chromereleasechannel.md) | _(Optional)_ Chrome Release Channel | |
| [dumpio?](./puppeteer.launchoptions.dumpio.md) | | boolean | _(Optional)_ If true, pipes the browser process stdout and stderr to <code>process.stdout</code> and <code>process.stderr</code>. | false |
| [env?](./puppeteer.launchoptions.env.md) | | Record&lt;string, string \| undefined&gt; | _(Optional)_ Specify environment variables that will be visible to the browser. | The contents of <code>process.env</code>. |
| [executablePath?](./puppeteer.launchoptions.executablepath.md) | | string | _(Optional)_ 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?](./puppeteer.launchoptions.extraprefsfirefox.md) | | Record&lt;string, unknown&gt; | _(Optional)_ [Additional preferences](https://searchfox.org/mozilla-release/source/modules/libpref/init/all.js) that can be passed when launching with Firefox. | |
| [handleSIGHUP?](./puppeteer.launchoptions.handlesighup.md) | | boolean | _(Optional)_ Close the browser process on <code>SIGHUP</code>. | <code>true</code> |
| [handleSIGINT?](./puppeteer.launchoptions.handlesigint.md) | | boolean | _(Optional)_ Close the browser process on <code>Ctrl+C</code>. | <code>true</code> |
| [handleSIGTERM?](./puppeteer.launchoptions.handlesigterm.md) | | boolean | _(Optional)_ Close the browser process on <code>SIGTERM</code>. | <code>true</code> |
| [ignoreDefaultArgs?](./puppeteer.launchoptions.ignoredefaultargs.md) | | boolean \| string\[\] | _(Optional)_ 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 |
| [pipe?](./puppeteer.launchoptions.pipe.md) | | boolean | _(Optional)_ Connect to a browser over a pipe instead of a WebSocket. | false |
| [product?](./puppeteer.launchoptions.product.md) | | [Product](./puppeteer.product.md) | _(Optional)_ Which browser to launch. | <code>chrome</code> |
| [timeout?](./puppeteer.launchoptions.timeout.md) | | number | _(Optional)_ Maximum time in milliseconds to wait for the browser to start. Pass <code>0</code> to disable the timeout. | 30000 (30 seconds). |
| [waitForInitialPage?](./puppeteer.launchoptions.waitforinitialpage.md) | | boolean | _(Optional)_ 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 |

30
docs/api/puppeteer.metrics.md
View File

@ -12,18 +12,18 @@ export interface Metrics
## Properties
| Property | Modifiers | Type | Description | Default |
| ------------------------------------------------------------------ | --------- | ------ | ----------------- | ------- |
| [Documents?](./puppeteer.metrics.documents.md) | | number | <i>(Optional)</i> | |
| [Frames?](./puppeteer.metrics.frames.md) | | number | <i>(Optional)</i> | |
| [JSEventListeners?](./puppeteer.metrics.jseventlisteners.md) | | number | <i>(Optional)</i> | |
| [JSHeapTotalSize?](./puppeteer.metrics.jsheaptotalsize.md) | | number | <i>(Optional)</i> | |
| [JSHeapUsedSize?](./puppeteer.metrics.jsheapusedsize.md) | | number | <i>(Optional)</i> | |
| [LayoutCount?](./puppeteer.metrics.layoutcount.md) | | number | <i>(Optional)</i> | |
| [LayoutDuration?](./puppeteer.metrics.layoutduration.md) | | number | <i>(Optional)</i> | |
| [Nodes?](./puppeteer.metrics.nodes.md) | | number | <i>(Optional)</i> | |
| [RecalcStyleCount?](./puppeteer.metrics.recalcstylecount.md) | | number | <i>(Optional)</i> | |
| [RecalcStyleDuration?](./puppeteer.metrics.recalcstyleduration.md) | | number | <i>(Optional)</i> | |
| [ScriptDuration?](./puppeteer.metrics.scriptduration.md) | | number | <i>(Optional)</i> | |
| [TaskDuration?](./puppeteer.metrics.taskduration.md) | | number | <i>(Optional)</i> | |
| [Timestamp?](./puppeteer.metrics.timestamp.md) | | number | <i>(Optional)</i> | |
| Property | Modifiers | Type | Description | Default |
| ------------------------------------------------------------------ | --------- | ------ | ------------ | ------- |
| [Documents?](./puppeteer.metrics.documents.md) | | number | _(Optional)_ | |
| [Frames?](./puppeteer.metrics.frames.md) | | number | _(Optional)_ | |
| [JSEventListeners?](./puppeteer.metrics.jseventlisteners.md) | | number | _(Optional)_ | |
| [JSHeapTotalSize?](./puppeteer.metrics.jsheaptotalsize.md) | | number | _(Optional)_ | |
| [JSHeapUsedSize?](./puppeteer.metrics.jsheapusedsize.md) | | number | _(Optional)_ | |
| [LayoutCount?](./puppeteer.metrics.layoutcount.md) | | number | _(Optional)_ | |
| [LayoutDuration?](./puppeteer.metrics.layoutduration.md) | | number | _(Optional)_ | |
| [Nodes?](./puppeteer.metrics.nodes.md) | | number | _(Optional)_ | |
| [RecalcStyleCount?](./puppeteer.metrics.recalcstylecount.md) | | number | _(Optional)_ | |
| [RecalcStyleDuration?](./puppeteer.metrics.recalcstyleduration.md) | | number | _(Optional)_ | |
| [ScriptDuration?](./puppeteer.metrics.scriptduration.md) | | number | _(Optional)_ | |
| [TaskDuration?](./puppeteer.metrics.taskduration.md) | | number | _(Optional)_ | |
| [Timestamp?](./puppeteer.metrics.timestamp.md) | | number | _(Optional)_ | |

10
docs/api/puppeteer.mouse.click.md
View File

@ -22,11 +22,11 @@ class Mouse {
## Parameters
| Parameter | Type | Description |
| --------- | --------------------------------------------------------------------- | ----------------------------------------------------- |
| x | number | Horizontal position of the mouse. |
| y | number | Vertical position of the mouse. |
| options | [MouseOptions](./puppeteer.mouseoptions.md) &amp; { delay?: number; } | <i>(Optional)</i> Optional <code>MouseOptions</code>. |
| Parameter | Type | Description |
| --------- | --------------------------------------------------------------------- | ------------------------------------------------ |
| x | number | Horizontal position of the mouse. |
| y | number | Vertical position of the mouse. |
| options | [MouseOptions](./puppeteer.mouseoptions.md) &amp; { delay?: number; } | _(Optional)_ Optional <code>MouseOptions</code>. |
**Returns:**

6
docs/api/puppeteer.mouse.down.md
View File

@ -16,9 +16,9 @@ class Mouse {
## Parameters
| Parameter | Type | Description |
| --------- | ------------------------------------------- | ----------------------------------------------------- |
| options | [MouseOptions](./puppeteer.mouseoptions.md) | <i>(Optional)</i> Optional <code>MouseOptions</code>. |
| Parameter | Type | Description |
| --------- | ------------------------------------------- | ------------------------------------------------ |
| options | [MouseOptions](./puppeteer.mouseoptions.md) | _(Optional)_ Optional <code>MouseOptions</code>. |
**Returns:**

10
docs/api/puppeteer.mouse.draganddrop.md
View File

@ -22,11 +22,11 @@ class Mouse {
## Parameters
| Parameter | Type | Description |
| --------- | ----------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| start | [Point](./puppeteer.point.md) | point to drag from |
| target | [Point](./puppeteer.point.md) | point to drop on |
| options | { delay?: number; } | <i>(Optional)</i> An object of options. Accepts delay which, if specified, is the time to wait between <code>dragover</code> and <code>drop</code> in milliseconds. Defaults to 0. |
| Parameter | Type | Description |
| --------- | ----------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| start | [Point](./puppeteer.point.md) | point to drag from |
| target | [Point](./puppeteer.point.md) | point to drop on |
| options | { delay?: number; } | _(Optional)_ An object of options. Accepts delay which, if specified, is the time to wait between <code>dragover</code> and <code>drop</code> in milliseconds. Defaults to 0. |
**Returns:**

10
docs/api/puppeteer.mouse.move.md
View File

@ -22,11 +22,11 @@ class Mouse {
## Parameters
| Parameter | Type | Description |
| --------- | ------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| x | number | Horizontal position of the mouse. |
| y | number | Vertical position of the mouse. |
| options | { steps?: number; } | <i>(Optional)</i> Optional object. If specified, the <code>steps</code> property sends intermediate <code>mousemove</code> events when set to <code>1</code> (default). |
| Parameter | Type | Description |
| --------- | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| x | number | Horizontal position of the mouse. |
| y | number | Vertical position of the mouse. |
| options | { steps?: number; } | _(Optional)_ Optional object. If specified, the <code>steps</code> property sends intermediate <code>mousemove</code> events when set to <code>1</code> (default). |
**Returns:**

6
docs/api/puppeteer.mouse.up.md
View File

@ -16,9 +16,9 @@ class Mouse {
## Parameters
| Parameter | Type | Description |
| --------- | ------------------------------------------- | ----------------------------------------------------- |
| options | [MouseOptions](./puppeteer.mouseoptions.md) | <i>(Optional)</i> Optional <code>MouseOptions</code>. |
| Parameter | Type | Description |
| --------- | ------------------------------------------- | ------------------------------------------------ |
| options | [MouseOptions](./puppeteer.mouseoptions.md) | _(Optional)_ Optional <code>MouseOptions</code>. |
**Returns:**

6
docs/api/puppeteer.mouse.wheel.md
View File

@ -16,9 +16,9 @@ class Mouse {
## Parameters
| Parameter | Type | Description |
| --------- | ----------------------------------------------------- | ----------------------------------------------------------- |
| options | [MouseWheelOptions](./puppeteer.mousewheeloptions.md) | <i>(Optional)</i> Optional: <code>MouseWheelOptions</code>. |
| Parameter | Type | Description |
| --------- | ----------------------------------------------------- | ------------------------------------------------------ |
| options | [MouseWheelOptions](./puppeteer.mousewheeloptions.md) | _(Optional)_ Optional: <code>MouseWheelOptions</code>. |
**Returns:**

8
docs/api/puppeteer.mouseoptions.md
View File

@ -12,7 +12,7 @@ export interface MouseOptions
## Properties
| Property | Modifiers | Type | Description | Default |
| ----------------------------------------------------- | --------- | ----------------------------------------- | ----------------- | ------- |
| [button?](./puppeteer.mouseoptions.button.md) | | [MouseButton](./puppeteer.mousebutton.md) | <i>(Optional)</i> | |
| [clickCount?](./puppeteer.mouseoptions.clickcount.md) | | number | <i>(Optional)</i> | |
| Property | Modifiers | Type | Description | Default |
| ----------------------------------------------------- | --------- | ----------------------------------------- | ------------ | ------- |
| [button?](./puppeteer.mouseoptions.button.md) | | [MouseButton](./puppeteer.mousebutton.md) | _(Optional)_ | |
| [clickCount?](./puppeteer.mouseoptions.clickcount.md) | | number | _(Optional)_ | |

8
docs/api/puppeteer.mousewheeloptions.md
View File

@ -12,7 +12,7 @@ export interface MouseWheelOptions
## Properties
| Property | Modifiers | Type | Description | Default |
| -------------------------------------------------- | --------- | ------ | ----------------- | ------- |
| [deltaX?](./puppeteer.mousewheeloptions.deltax.md) | | number | <i>(Optional)</i> | |
| [deltaY?](./puppeteer.mousewheeloptions.deltay.md) | | number | <i>(Optional)</i> | |
| Property | Modifiers | Type | Description | Default |
| -------------------------------------------------- | --------- | ------ | ------------ | ------- |
| [deltaX?](./puppeteer.mousewheeloptions.deltax.md) | | number | _(Optional)_ | |
| [deltaY?](./puppeteer.mousewheeloptions.deltay.md) | | number | _(Optional)_ | |

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

@ -26,7 +26,7 @@ class Page {
| Parameter | Type | Description |
| --------- | -------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
| selector | string | A <code>selector</code> to search for element to click. If there are multiple elements satisfying the <code>selector</code>, the first will be clicked |
| options | { delay?: number; button?: [MouseButton](./puppeteer.mousebutton.md); clickCount?: number; } | <i>(Optional)</i> <code>Object</code> |
| options | { delay?: number; button?: [MouseButton](./puppeteer.mousebutton.md); clickCount?: number; } | _(Optional)_ <code>Object</code> |
**Returns:**

6
docs/api/puppeteer.page.close.md
View File

@ -14,9 +14,9 @@ class Page {
## Parameters
| Parameter | Type | Description |
| --------- | ------------------------------ | ----------------- |
| options | { runBeforeUnload?: boolean; } | <i>(Optional)</i> |
| Parameter | Type | Description |
| --------- | ------------------------------ | ------------ |
| options | { runBeforeUnload?: boolean; } | _(Optional)_ |
**Returns:**

6
docs/api/puppeteer.page.createpdfstream.md
View File

@ -16,9 +16,9 @@ class Page {
## Parameters
| Parameter | Type | Description |
| --------- | --------------------------------------- | ------------------------------------------------- |
| options | [PDFOptions](./puppeteer.pdfoptions.md) | <i>(Optional)</i> options for generating the PDF. |
| Parameter | Type | Description |
| --------- | --------------------------------------- | -------------------------------------------- |
| options | [PDFOptions](./puppeteer.pdfoptions.md) | _(Optional)_ options for generating the PDF. |
**Returns:**

6
docs/api/puppeteer.page.emulateidlestate.md
View File

@ -19,9 +19,9 @@ class Page {
## Parameters
| Parameter | Type | Description |
| --------- | ----------------------------------------------------- | -------------------------------------------------------------------- |
| overrides | { isUserActive: boolean; isScreenUnlocked: boolean; } | <i>(Optional)</i> Mock idle state. If not set, clears idle overrides |
| Parameter | Type | Description |
| --------- | ----------------------------------------------------- | --------------------------------------------------------------- |
| overrides | { isUserActive: boolean; isScreenUnlocked: boolean; } | _(Optional)_ Mock idle state. If not set, clears idle overrides |
**Returns:**

6
docs/api/puppeteer.page.emulatemediafeatures.md
View File

@ -14,9 +14,9 @@ class Page {
## Parameters
| Parameter | Type | Description |
| --------- | ----------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| features | [MediaFeature](./puppeteer.mediafeature.md)\[\] | <i>(Optional)</i> <code>&lt;?Array&lt;Object&gt;&gt;</code> Given an array of media feature objects, emulates CSS media features on the page. Each media feature object must have the following properties: |
| Parameter | Type | Description |
| --------- | ----------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| features | [MediaFeature](./puppeteer.mediafeature.md)\[\] | _(Optional)_ <code>&lt;?Array&lt;Object&gt;&gt;</code> Given an array of media feature objects, emulates CSS media features on the page. Each media feature object must have the following properties: |
**Returns:**

6
docs/api/puppeteer.page.emulatemediatype.md
View File

@ -14,9 +14,9 @@ class Page {
## Parameters
| Parameter | Type | Description |
| --------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| type | string | <i>(Optional)</i> Changes the CSS media type of the page. The only allowed values are <code>screen</code>, <code>print</code> and <code>null</code>. Passing <code>null</code> disables CSS media emulation. |
| Parameter | Type | Description |
| --------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| type | string | _(Optional)_ Changes the CSS media type of the page. The only allowed values are <code>screen</code>, <code>print</code> and <code>null</code>. Passing <code>null</code> disables CSS media emulation. |
**Returns:**

6
docs/api/puppeteer.page.emulatetimezone.md
View File

@ -14,9 +14,9 @@ class Page {
## Parameters
| Parameter | Type | Description |
| ---------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| timezoneId | string | <i>(Optional)</i> Changes the timezone of the page. See [ICU’s metaZones.txt](https://source.chromium.org/chromium/chromium/deps/icu.git/+/faee8bc70570192d82d2978a71e2a615788597d1:source/data/misc/metaZones.txt) for a list of supported timezone IDs. Passing <code>null</code> disables timezone emulation. |
| Parameter | Type | Description |
| ---------- | ------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| timezoneId | string | _(Optional)_ Changes the timezone of the page. See [ICU’s metaZones.txt](https://source.chromium.org/chromium/chromium/deps/icu.git/+/faee8bc70570192d82d2978a71e2a615788597d1:source/data/misc/metaZones.txt) for a list of supported timezone IDs. Passing <code>null</code> disables timezone emulation. |
**Returns:**

6
docs/api/puppeteer.page.emulatevisiondeficiency.md
View File

@ -18,9 +18,9 @@ class Page {
## Parameters
| Parameter | Type | Description |
| --------- | --------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
| type | Protocol.Emulation.SetEmulatedVisionDeficiencyRequest\['type'\] | <i>(Optional)</i> the type of deficiency to simulate, or <code>'none'</code> to reset. |
| Parameter | Type | Description |
| --------- | --------------------------------------------------------------- | --------------------------------------------------------------------------------- |
| type | Protocol.Emulation.SetEmulatedVisionDeficiencyRequest\['type'\] | _(Optional)_ the type of deficiency to simulate, or <code>'none'</code> to reset. |
**Returns:**

6
docs/api/puppeteer.page.goback.md
View File

@ -16,9 +16,9 @@ class Page {
## Parameters
| Parameter | Type | Description |
| --------- | ----------------------------------------------- | --------------------------------------- |
| options | [WaitForOptions](./puppeteer.waitforoptions.md) | <i>(Optional)</i> Navigation parameters |
| Parameter | Type | Description |
| --------- | ----------------------------------------------- | ---------------------------------- |
| options | [WaitForOptions](./puppeteer.waitforoptions.md) | _(Optional)_ Navigation parameters |
**Returns:**

6
docs/api/puppeteer.page.goforward.md
View File

@ -16,9 +16,9 @@ class Page {
## Parameters
| Parameter | Type | Description |
| --------- | ----------------------------------------------- | -------------------------------------- |
| options | [WaitForOptions](./puppeteer.waitforoptions.md) | <i>(Optional)</i> Navigation Parameter |
| Parameter | Type | Description |
| --------- | ----------------------------------------------- | --------------------------------- |
| options | [WaitForOptions](./puppeteer.waitforoptions.md) | _(Optional)_ Navigation Parameter |
**Returns:**

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

@ -23,7 +23,7 @@ class Page {
| Parameter | Type | Description |
| --------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
| url | string | URL to navigate page to. The URL should include scheme, e.g. <code>https://</code> |
| options | [WaitForOptions](./puppeteer.waitforoptions.md) &amp; { referer?: string; referrerPolicy?: string; } | <i>(Optional)</i> Navigation Parameter |
| options | [WaitForOptions](./puppeteer.waitforoptions.md) &amp; { referer?: string; referrerPolicy?: string; } | _(Optional)_ Navigation Parameter |
**Returns:**

6
docs/api/puppeteer.page.pdf.md
View File

@ -14,9 +14,9 @@ class Page {
## Parameters
| Parameter | Type | Description |
| --------- | --------------------------------------- | ----------------- |
| options | [PDFOptions](./puppeteer.pdfoptions.md) | <i>(Optional)</i> |
| Parameter | Type | Description |
| --------- | --------------------------------------- | ------------ |
| options | [PDFOptions](./puppeteer.pdfoptions.md) | _(Optional)_ |
**Returns:**

6
docs/api/puppeteer.page.reload.md
View File

@ -14,9 +14,9 @@ class Page {
## Parameters
| Parameter | Type | Description |
| --------- | ----------------------------------------------- | ---------------------------------------------------------------------------------- |
| options | [WaitForOptions](./puppeteer.waitforoptions.md) | <i>(Optional)</i> Navigation parameters which might have the following properties: |
| Parameter | Type | Description |
| --------- | ----------------------------------------------- | ----------------------------------------------------------------------------- |
| options | [WaitForOptions](./puppeteer.waitforoptions.md) | _(Optional)_ Navigation parameters which might have the following properties: |
**Returns:**

6
docs/api/puppeteer.page.screenshot_1.md
View File

@ -18,9 +18,9 @@ class Page {
## Parameters
| Parameter | Type | Description |
| --------- | ------------------------------------------------------------------------------------ | ----------------- |
| options | [ScreenshotOptions](./puppeteer.screenshotoptions.md) &amp; { encoding?: 'binary'; } | <i>(Optional)</i> |
| Parameter | Type | Description |
| --------- | ------------------------------------------------------------------------------------ | ------------ |
| options | [ScreenshotOptions](./puppeteer.screenshotoptions.md) &amp; { encoding?: 'binary'; } | _(Optional)_ |
**Returns:**

6
docs/api/puppeteer.page.screenshot_2.md
View File

@ -14,9 +14,9 @@ class Page {
## Parameters
| Parameter | Type | Description |
| --------- | ----------------------------------------------------- | ----------------- |
| options | [ScreenshotOptions](./puppeteer.screenshotoptions.md) | <i>(Optional)</i> |
| Parameter | Type | Description |
| --------- | ----------------------------------------------------- | ------------ |
| options | [ScreenshotOptions](./puppeteer.screenshotoptions.md) | _(Optional)_ |
**Returns:**

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

@ -16,9 +16,9 @@ class Page {
## Parameters
| Parameter | Type | Description |
| --------- | ------- | -------------------------------------------------------------- |
| enabled | boolean | <i>(Optional)</i> sets the <code>enabled</code> state of cache |
| Parameter | Type | Description |
| --------- | ------- | --------------------------------------------------------- |
| enabled | boolean | _(Optional)_ sets the <code>enabled</code> state of cache |
**Returns:**

8
docs/api/puppeteer.page.setcontent.md
View File

@ -14,10 +14,10 @@ class Page {
## Parameters
| Parameter | Type | Description |
| --------- | ----------------------------------------------- | ------------------------------------------------------ |
| html | string | HTML markup to assign to the page. |
| options | [WaitForOptions](./puppeteer.waitforoptions.md) | <i>(Optional)</i> Parameters that has some properties. |
| Parameter | Type | Description |
| --------- | ----------------------------------------------- | ------------------------------------------------- |
| html | string | HTML markup to assign to the page. |
| options | [WaitForOptions](./puppeteer.waitforoptions.md) | _(Optional)_ Parameters that has some properties. |
**Returns:**

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

@ -20,7 +20,7 @@ class Page {
| Parameter | Type | Description |
| ----------------- | ------------------------------------ | --------------------------------------- |
| userAgent | string | Specific user agent to use in this page |
| userAgentMetadata | Protocol.Emulation.UserAgentMetadata | <i>(Optional)</i> |
| userAgentMetadata | Protocol.Emulation.UserAgentMetadata | _(Optional)_ |
**Returns:**

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

@ -28,7 +28,7 @@ class Page {
| --------- | ------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| selector | string | A [selector](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Selectors) of an element to type into. If there are multiple elements satisfying the selector, the first will be used. |
| text | string | A text to type into a focused element. |
| options | { delay: number; } | <i>(Optional)</i> have property <code>delay</code> which is the Time to wait between key presses in milliseconds. Defaults to <code>0</code>. |
| options | { delay: number; } | _(Optional)_ have property <code>delay</code> which is the Time to wait between key presses in milliseconds. Defaults to <code>0</code>. |
**Returns:**

6
docs/api/puppeteer.page.waitforfilechooser.md
View File

@ -22,9 +22,9 @@ class Page {
## Parameters
| Parameter | Type | Description |
| --------- | ------------------------------------------------------- | ----------------- |
| options | [WaitTimeoutOptions](./puppeteer.waittimeoutoptions.md) | <i>(Optional)</i> |
| Parameter | Type | Description |
| --------- | ------------------------------------------------------- | ------------ |
| options | [WaitTimeoutOptions](./puppeteer.waittimeoutoptions.md) | _(Optional)_ |
**Returns:**

8
docs/api/puppeteer.page.waitforframe.md
View File

@ -19,10 +19,10 @@ class Page {
## Parameters
| Parameter | Type | Description |
| -------------- | ------------------------------------------------------------------------------------------ | --------------------------------------------- |
| urlOrPredicate | string \| ((frame: [Frame](./puppeteer.frame.md)) =&gt; boolean \| Promise&lt;boolean&gt;) | A URL or predicate to wait for. |
| options | { timeout?: number; } | <i>(Optional)</i> Optional waiting parameters |
| Parameter | Type | Description |
| -------------- | ------------------------------------------------------------------------------------------ | ---------------------------------------- |
| urlOrPredicate | string \| ((frame: [Frame](./puppeteer.frame.md)) =&gt; boolean \| Promise&lt;boolean&gt;) | A URL or predicate to wait for. |
| options | { timeout?: number; } | _(Optional)_ Optional waiting parameters |
**Returns:**

10
docs/api/puppeteer.page.waitforfunction.md
View File

@ -23,11 +23,11 @@ class Page {
## Parameters
| Parameter | Type | Description |
| ------------ | ------------------------------------------------------------------------- | ----------------------------------------------------------- |
| pageFunction | Func \| string | Function to be evaluated in browser context |
| options | [FrameWaitForFunctionOptions](./puppeteer.framewaitforfunctionoptions.md) | <i>(Optional)</i> Options for configuring waiting behavior. |
| args | Params | |
| Parameter | Type | Description |
| ------------ | ------------------------------------------------------------------------- | ------------------------------------------------------ |
| pageFunction | Func \| string | Function to be evaluated in browser context |
| options | [FrameWaitForFunctionOptions](./puppeteer.framewaitforfunctionoptions.md) | _(Optional)_ Options for configuring waiting behavior. |
| args | Params | |
**Returns:**

6
docs/api/puppeteer.page.waitfornavigation.md
View File

@ -16,9 +16,9 @@ class Page {
## Parameters
| Parameter | Type | Description |
| --------- | ----------------------------------------------- | ---------------------------------------------------------------------------------- |
| options | [WaitForOptions](./puppeteer.waitforoptions.md) | <i>(Optional)</i> Navigation parameters which might have the following properties: |
| Parameter | Type | Description |
| --------- | ----------------------------------------------- | ----------------------------------------------------------------------------- |
| options | [WaitForOptions](./puppeteer.waitforoptions.md) | _(Optional)_ Navigation parameters which might have the following properties: |
**Returns:**

6
docs/api/puppeteer.page.waitfornetworkidle.md
View File

@ -17,9 +17,9 @@ class Page {
## Parameters
| Parameter | Type | Description |
| --------- | ---------------------------------------- | --------------------------------------------- |
| options | { idleTime?: number; timeout?: number; } | <i>(Optional)</i> Optional waiting parameters |
| Parameter | Type | Description |
| --------- | ---------------------------------------- | ---------------------------------------- |
| options | { idleTime?: number; timeout?: number; } | _(Optional)_ Optional waiting parameters |
**Returns:**

8
docs/api/puppeteer.page.waitforrequest.md
View File

@ -19,10 +19,10 @@ class Page {
## Parameters
| Parameter | Type | Description |
| -------------- | ---------------------------------------------------------------------------------------------------- | --------------------------------------------- |
| urlOrPredicate | string \| ((req: [HTTPRequest](./puppeteer.httprequest.md)) =&gt; boolean \| Promise&lt;boolean&gt;) | A URL or predicate to wait for |
| options | { timeout?: number; } | <i>(Optional)</i> Optional waiting parameters |
| Parameter | Type | Description |
| -------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------- |
| urlOrPredicate | string \| ((req: [HTTPRequest](./puppeteer.httprequest.md)) =&gt; boolean \| Promise&lt;boolean&gt;) | A URL or predicate to wait for |
| options | { timeout?: number; } | _(Optional)_ Optional waiting parameters |
**Returns:**

8
docs/api/puppeteer.page.waitforresponse.md
View File

@ -21,10 +21,10 @@ class Page {
## Parameters
| Parameter | Type | Description |
| -------------- | ------------------------------------------------------------------------------------------------------ | --------------------------------------------- |
| urlOrPredicate | string \| ((res: [HTTPResponse](./puppeteer.httpresponse.md)) =&gt; boolean \| Promise&lt;boolean&gt;) | A URL or predicate to wait for. |
| options | { timeout?: number; } | <i>(Optional)</i> Optional waiting parameters |
| Parameter | Type | Description |
| -------------- | ------------------------------------------------------------------------------------------------------ | ---------------------------------------- |
| urlOrPredicate | string \| ((res: [HTTPResponse](./puppeteer.httpresponse.md)) =&gt; boolean \| Promise&lt;boolean&gt;) | A URL or predicate to wait for. |
| options | { timeout?: number; } | _(Optional)_ Optional waiting parameters |
**Returns:**

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

@ -44,7 +44,7 @@ class Page {
| Parameter | Type | Description |
| --------- | --------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------ |
| selector | Selector | A [selector](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Selectors) of an element to wait for |
| options | [WaitForSelectorOptions](./puppeteer.waitforselectoroptions.md) | <i>(Optional)</i> Optional waiting parameters |
| options | [WaitForSelectorOptions](./puppeteer.waitforselectoroptions.md) | _(Optional)_ Optional waiting parameters |
**Returns:**

Some files were not shown because too many files have changed in this diff Show More