From 13962744774c404cec18c0e52a2f867ae4098c6d Mon Sep 17 00:00:00 2001 From: Nikolay Vitkov <34244704+Lightning00Blade@users.noreply.github.com> Date: Thu, 30 Mar 2023 13:54:00 +0200 Subject: [PATCH] docs: remove some redundant instances of @returns (#9943) --- docs/api/puppeteer.browserfetcher.host.md | 4 +- docs/api/puppeteer.browserfetcher.md | 20 ++++---- docs/api/puppeteer.browserfetcher.platform.md | 4 +- docs/api/puppeteer.browserfetcher.product.md | 4 +- .../puppeteer.browserlaunchargumentoptions.md | 2 +- docs/api/puppeteer.consolemessage.args.md | 4 +- docs/api/puppeteer.consolemessage.location.md | 4 +- docs/api/puppeteer.consolemessage.md | 14 +++--- .../puppeteer.consolemessage.stacktrace.md | 4 +- docs/api/puppeteer.consolemessage.text.md | 4 +- docs/api/puppeteer.consolemessage.type.md | 4 +- docs/api/puppeteer.coverage.md | 12 ++--- .../api/puppeteer.coverage.stopcsscoverage.md | 4 +- docs/api/puppeteer.coverage.stopjscoverage.md | 4 +- docs/api/puppeteer.customqueryhandler.md | 8 ++-- docs/api/puppeteer.dialog.accept.md | 4 +- docs/api/puppeteer.dialog.defaultvalue.md | 4 +- docs/api/puppeteer.dialog.dismiss.md | 4 +- docs/api/puppeteer.dialog.md | 14 +++--- docs/api/puppeteer.dialog.message.md | 4 +- docs/api/puppeteer.dialog.type.md | 4 +- docs/api/puppeteer.frame.childframes.md | 4 +- docs/api/puppeteer.frame.content.md | 4 +- docs/api/puppeteer.frame.isdetached.md | 4 +- docs/api/puppeteer.frame.isoopframe.md | 4 +- docs/api/puppeteer.frame.md | 18 ++++---- docs/api/puppeteer.frame.name.md | 4 +- docs/api/puppeteer.frame.page.md | 4 +- docs/api/puppeteer.frame.parentframe.md | 4 +- docs/api/puppeteer.frame.title.md | 4 +- docs/api/puppeteer.frame.url.md | 4 +- .../puppeteer.httprequest.aborterrorreason.md | 4 +- ...er.httprequest.continuerequestoverrides.md | 4 +- docs/api/puppeteer.httprequest.frame.md | 4 +- docs/api/puppeteer.httprequest.headers.md | 4 +- docs/api/puppeteer.httprequest.initiator.md | 4 +- ...er.httprequest.interceptresolutionstate.md | 12 ++--- ...ttprequest.isinterceptresolutionhandled.md | 4 +- ...ppeteer.httprequest.isnavigationrequest.md | 4 +- docs/api/puppeteer.httprequest.md | 46 +++++++++---------- docs/api/puppeteer.httprequest.method.md | 4 +- docs/api/puppeteer.httprequest.postdata.md | 4 +- docs/api/puppeteer.httprequest.response.md | 4 +- ...uppeteer.httprequest.responseforrequest.md | 4 +- docs/api/puppeteer.httprequest.url.md | 4 +- docs/api/puppeteer.httpresponse.buffer.md | 4 +- docs/api/puppeteer.httpresponse.frame.md | 4 +- docs/api/puppeteer.httpresponse.fromcache.md | 4 +- ...uppeteer.httpresponse.fromserviceworker.md | 4 +- docs/api/puppeteer.httpresponse.headers.md | 4 +- docs/api/puppeteer.httpresponse.json.md | 4 +- docs/api/puppeteer.httpresponse.md | 34 +++++++------- docs/api/puppeteer.httpresponse.ok.md | 4 +- .../puppeteer.httpresponse.remoteaddress.md | 4 +- docs/api/puppeteer.httpresponse.request.md | 4 +- .../puppeteer.httpresponse.securitydetails.md | 4 +- docs/api/puppeteer.httpresponse.status.md | 4 +- docs/api/puppeteer.httpresponse.statustext.md | 4 +- docs/api/puppeteer.httpresponse.text.md | 4 +- docs/api/puppeteer.httpresponse.timing.md | 4 +- docs/api/puppeteer.httpresponse.url.md | 4 +- docs/api/puppeteer.jshandle.aselement.md | 4 +- docs/api/puppeteer.jshandle.jsonvalue.md | 4 +- docs/api/puppeteer.jshandle.md | 4 +- docs/api/puppeteer.page.content.md | 2 + docs/api/puppeteer.page.frames.md | 4 +- docs/api/puppeteer.page.getdefaulttimeout.md | 4 +- ...uppeteer.page.isdraginterceptionenabled.md | 4 +- .../api/puppeteer.page.isjavascriptenabled.md | 4 +- docs/api/puppeteer.page.mainframe.md | 4 +- docs/api/puppeteer.page.md | 28 +++++------ docs/api/puppeteer.page.metrics.md | 4 +- docs/api/puppeteer.page.screenshot.md | 4 +- docs/api/puppeteer.page.setcontent.md | 2 + docs/api/puppeteer.page.target.md | 4 +- docs/api/puppeteer.page.title.md | 4 +- docs/api/puppeteer.page.url.md | 2 + docs/api/puppeteer.page.viewport.md | 2 + docs/api/puppeteer.page.workers.md | 4 +- .../puppeteer.puppeteernode.executablepath.md | 4 +- docs/api/puppeteer.puppeteernode.md | 12 ++--- docs/api/puppeteer.securitydetails.issuer.md | 4 +- docs/api/puppeteer.securitydetails.md | 16 +++---- .../api/puppeteer.securitydetails.protocol.md | 4 +- ...securitydetails.subjectalternativenames.md | 4 +- .../puppeteer.securitydetails.subjectname.md | 4 +- .../puppeteer.securitydetails.validfrom.md | 4 +- docs/api/puppeteer.securitydetails.validto.md | 4 +- docs/api/puppeteer.webworker.md | 2 +- docs/api/puppeteer.webworker.url.md | 4 +- .../puppeteer-core/src/api/HTTPRequest.ts | 26 +++++------ .../puppeteer-core/src/api/HTTPResponse.ts | 31 ++++++------- packages/puppeteer-core/src/api/JSHandle.ts | 4 +- packages/puppeteer-core/src/api/Page.ts | 35 ++++++++------ .../src/common/ChromeTargetManager.ts | 1 - .../src/common/ConsoleMessage.ts | 10 ++-- .../puppeteer-core/src/common/Coverage.ts | 5 +- .../src/common/CustomQueryHandler.ts | 4 +- packages/puppeteer-core/src/common/Dialog.ts | 11 +++-- packages/puppeteer-core/src/common/Frame.ts | 18 ++++---- .../puppeteer-core/src/common/JSHandle.ts | 2 +- .../src/common/SecurityDetails.ts | 12 ++--- .../puppeteer-core/src/common/WebWorker.ts | 2 +- .../puppeteer-core/src/node/BrowserFetcher.ts | 6 +-- .../puppeteer-core/src/node/LaunchOptions.ts | 2 +- .../puppeteer-core/src/node/PuppeteerNode.ts | 22 ++------- 106 files changed, 364 insertions(+), 361 deletions(-) diff --git a/docs/api/puppeteer.browserfetcher.host.md b/docs/api/puppeteer.browserfetcher.host.md index 0ecfeaf7c18..378b53abbd2 100644 --- a/docs/api/puppeteer.browserfetcher.host.md +++ b/docs/api/puppeteer.browserfetcher.host.md @@ -4,6 +4,8 @@ sidebar_label: BrowserFetcher.host # BrowserFetcher.host() method +The download host being used. + #### Signature: ```typescript @@ -15,5 +17,3 @@ class BrowserFetcher { **Returns:** string - -The download host being used. diff --git a/docs/api/puppeteer.browserfetcher.md b/docs/api/puppeteer.browserfetcher.md index 41441849784..0b7a8caf0dc 100644 --- a/docs/api/puppeteer.browserfetcher.md +++ b/docs/api/puppeteer.browserfetcher.md @@ -36,13 +36,13 @@ const browser = await puppeteer.launch({ ## Methods -| Method | Modifiers | Description | -| ------------------------------------------------------------------------------ | --------- | --------------------------------------------------------------- | -| [canDownload(revision)](./puppeteer.browserfetcher.candownload.md) | | Initiates a HEAD request to check if the revision is available. | -| [download(revision, progressCallback)](./puppeteer.browserfetcher.download.md) | | Initiates a GET request to download the revision from the host. | -| [host()](./puppeteer.browserfetcher.host.md) | | | -| [localRevisions()](./puppeteer.browserfetcher.localrevisions.md) | | | -| [platform()](./puppeteer.browserfetcher.platform.md) | | | -| [product()](./puppeteer.browserfetcher.product.md) | | | -| [remove(revision)](./puppeteer.browserfetcher.remove.md) | | | -| [revisionInfo(revision)](./puppeteer.browserfetcher.revisioninfo.md) | | | +| Method | Modifiers | Description | +| ------------------------------------------------------------------------------ | --------- | ------------------------------------------------------------------------------------------------------------------------------------------ | +| [canDownload(revision)](./puppeteer.browserfetcher.candownload.md) | | Initiates a HEAD request to check if the revision is available. | +| [download(revision, progressCallback)](./puppeteer.browserfetcher.download.md) | | Initiates a GET request to download the revision from the host. | +| [host()](./puppeteer.browserfetcher.host.md) | | The download host being used. | +| [localRevisions()](./puppeteer.browserfetcher.localrevisions.md) | | | +| [platform()](./puppeteer.browserfetcher.platform.md) | | Returns the current Platform, which is one of mac, linux, win32 or win64. | +| [product()](./puppeteer.browserfetcher.product.md) | | Returns the current Product, which is one of chrome or firefox. | +| [remove(revision)](./puppeteer.browserfetcher.remove.md) | | | +| [revisionInfo(revision)](./puppeteer.browserfetcher.revisioninfo.md) | | | diff --git a/docs/api/puppeteer.browserfetcher.platform.md b/docs/api/puppeteer.browserfetcher.platform.md index 9f3d8f74724..50ec11b3ba9 100644 --- a/docs/api/puppeteer.browserfetcher.platform.md +++ b/docs/api/puppeteer.browserfetcher.platform.md @@ -4,6 +4,8 @@ sidebar_label: BrowserFetcher.platform # BrowserFetcher.platform() method +Returns the current `Platform`, which is one of `mac`, `linux`, `win32` or `win64`. + #### Signature: ```typescript @@ -15,5 +17,3 @@ class BrowserFetcher { **Returns:** [Platform](./puppeteer.platform.md) - -Returns the current `Platform`, which is one of `mac`, `linux`, `win32` or `win64`. diff --git a/docs/api/puppeteer.browserfetcher.product.md b/docs/api/puppeteer.browserfetcher.product.md index 512f603461b..826e696ef9b 100644 --- a/docs/api/puppeteer.browserfetcher.product.md +++ b/docs/api/puppeteer.browserfetcher.product.md @@ -4,6 +4,8 @@ sidebar_label: BrowserFetcher.product # BrowserFetcher.product() method +Returns the current `Product`, which is one of `chrome` or `firefox`. + #### Signature: ```typescript @@ -15,5 +17,3 @@ class BrowserFetcher { **Returns:** [Product](./puppeteer.product.md) - -Returns the current `Product`, which is one of `chrome` or `firefox`. diff --git a/docs/api/puppeteer.browserlaunchargumentoptions.md b/docs/api/puppeteer.browserlaunchargumentoptions.md index 1b161e8a493..70daff25704 100644 --- a/docs/api/puppeteer.browserlaunchargumentoptions.md +++ b/docs/api/puppeteer.browserlaunchargumentoptions.md @@ -17,7 +17,7 @@ export interface BrowserLaunchArgumentOptions | Property | Modifiers | Type | Description | Default | | ------------- | --------------------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | | args | optional | string\[\] | Additional command line arguments to pass to the browser instance. | | -| debuggingPort | optional | number | | | +| debuggingPort | optional | number | Specify the debugging port number to use | | | devtools | optional | boolean | Whether to auto-open a DevTools panel for each tab. If this is set to true, then headless will be forced to false. | false | | headless | optional | boolean \| 'new' | Whether to run the browser in headless mode. | true | | userDataDir | optional | string | Path to a user data directory. [see the Chromium docs](https://chromium.googlesource.com/chromium/src/+/refs/heads/main/docs/user_data_dir.md) for more info. | | diff --git a/docs/api/puppeteer.consolemessage.args.md b/docs/api/puppeteer.consolemessage.args.md index 565fd6bc537..e10a90ee818 100644 --- a/docs/api/puppeteer.consolemessage.args.md +++ b/docs/api/puppeteer.consolemessage.args.md @@ -4,6 +4,8 @@ sidebar_label: ConsoleMessage.args # ConsoleMessage.args() method +An array of arguments passed to the console. + #### Signature: ```typescript @@ -15,5 +17,3 @@ class ConsoleMessage { **Returns:** [JSHandle](./puppeteer.jshandle.md)\[\] - -An array of arguments passed to the console. diff --git a/docs/api/puppeteer.consolemessage.location.md b/docs/api/puppeteer.consolemessage.location.md index d26c80b5e00..f4696e1a070 100644 --- a/docs/api/puppeteer.consolemessage.location.md +++ b/docs/api/puppeteer.consolemessage.location.md @@ -4,6 +4,8 @@ sidebar_label: ConsoleMessage.location # ConsoleMessage.location() method +The location of the console message. + #### Signature: ```typescript @@ -15,5 +17,3 @@ class ConsoleMessage { **Returns:** [ConsoleMessageLocation](./puppeteer.consolemessagelocation.md) - -The location of the console message. diff --git a/docs/api/puppeteer.consolemessage.md b/docs/api/puppeteer.consolemessage.md index 86ed1c0efe1..812da548198 100644 --- a/docs/api/puppeteer.consolemessage.md +++ b/docs/api/puppeteer.consolemessage.md @@ -20,10 +20,10 @@ export declare class ConsoleMessage ## Methods -| Method | Modifiers | Description | -| -------------------------------------------------------- | --------- | ----------- | -| [args()](./puppeteer.consolemessage.args.md) | | | -| [location()](./puppeteer.consolemessage.location.md) | | | -| [stackTrace()](./puppeteer.consolemessage.stacktrace.md) | | | -| [text()](./puppeteer.consolemessage.text.md) | | | -| [type()](./puppeteer.consolemessage.type.md) | | | +| Method | Modifiers | Description | +| -------------------------------------------------------- | --------- | ----------------------------------------------------------- | +| [args()](./puppeteer.consolemessage.args.md) | | An array of arguments passed to the console. | +| [location()](./puppeteer.consolemessage.location.md) | | The location of the console message. | +| [stackTrace()](./puppeteer.consolemessage.stacktrace.md) | | The array of locations on the stack of the console message. | +| [text()](./puppeteer.consolemessage.text.md) | | The text of the console message. | +| [type()](./puppeteer.consolemessage.type.md) | | The type of the console message. | diff --git a/docs/api/puppeteer.consolemessage.stacktrace.md b/docs/api/puppeteer.consolemessage.stacktrace.md index f589b9aed3a..aa48e6048a9 100644 --- a/docs/api/puppeteer.consolemessage.stacktrace.md +++ b/docs/api/puppeteer.consolemessage.stacktrace.md @@ -4,6 +4,8 @@ sidebar_label: ConsoleMessage.stackTrace # ConsoleMessage.stackTrace() method +The array of locations on the stack of the console message. + #### Signature: ```typescript @@ -15,5 +17,3 @@ class ConsoleMessage { **Returns:** [ConsoleMessageLocation](./puppeteer.consolemessagelocation.md)\[\] - -The array of locations on the stack of the console message. diff --git a/docs/api/puppeteer.consolemessage.text.md b/docs/api/puppeteer.consolemessage.text.md index 4e86e4651b4..3957ede4180 100644 --- a/docs/api/puppeteer.consolemessage.text.md +++ b/docs/api/puppeteer.consolemessage.text.md @@ -4,6 +4,8 @@ sidebar_label: ConsoleMessage.text # ConsoleMessage.text() method +The text of the console message. + #### Signature: ```typescript @@ -15,5 +17,3 @@ class ConsoleMessage { **Returns:** string - -The text of the console message. diff --git a/docs/api/puppeteer.consolemessage.type.md b/docs/api/puppeteer.consolemessage.type.md index 9f0224a248b..e253d847b61 100644 --- a/docs/api/puppeteer.consolemessage.type.md +++ b/docs/api/puppeteer.consolemessage.type.md @@ -4,6 +4,8 @@ sidebar_label: ConsoleMessage.type # ConsoleMessage.type() method +The type of the console message. + #### Signature: ```typescript @@ -15,5 +17,3 @@ class ConsoleMessage { **Returns:** [ConsoleMessageType](./puppeteer.consolemessagetype.md) - -The type of the console message. diff --git a/docs/api/puppeteer.coverage.md b/docs/api/puppeteer.coverage.md index f0ac68faa13..dfd32f6043c 100644 --- a/docs/api/puppeteer.coverage.md +++ b/docs/api/puppeteer.coverage.md @@ -51,9 +51,9 @@ console.log(`Bytes used: ${(usedBytes / totalBytes) * 100}%`); ## Methods -| Method | Modifiers | Description | -| --------------------------------------------------------------------- | --------- | ----------- | -| [startCSSCoverage(options)](./puppeteer.coverage.startcsscoverage.md) | | | -| [startJSCoverage(options)](./puppeteer.coverage.startjscoverage.md) | | | -| [stopCSSCoverage()](./puppeteer.coverage.stopcsscoverage.md) | | | -| [stopJSCoverage()](./puppeteer.coverage.stopjscoverage.md) | | | +| Method | Modifiers | Description | +| --------------------------------------------------------------------- | --------- | --------------------------------------------------------------------------- | +| [startCSSCoverage(options)](./puppeteer.coverage.startcsscoverage.md) | | | +| [startJSCoverage(options)](./puppeteer.coverage.startjscoverage.md) | | | +| [stopCSSCoverage()](./puppeteer.coverage.stopcsscoverage.md) | | Promise that resolves to the array of coverage reports for all stylesheets. | +| [stopJSCoverage()](./puppeteer.coverage.stopjscoverage.md) | | Promise that resolves to the array of coverage reports for all scripts. | diff --git a/docs/api/puppeteer.coverage.stopcsscoverage.md b/docs/api/puppeteer.coverage.stopcsscoverage.md index db43fab553b..143b34f46f1 100644 --- a/docs/api/puppeteer.coverage.stopcsscoverage.md +++ b/docs/api/puppeteer.coverage.stopcsscoverage.md @@ -4,6 +4,8 @@ sidebar_label: Coverage.stopCSSCoverage # Coverage.stopCSSCoverage() method +Promise that resolves to the array of coverage reports for all stylesheets. + #### Signature: ```typescript @@ -16,8 +18,6 @@ class Coverage { Promise<[CoverageEntry](./puppeteer.coverageentry.md)\[\]> -Promise that resolves to the array of coverage reports for all stylesheets. - ## Remarks CSS Coverage doesn't include dynamically injected style tags without sourceURLs. diff --git a/docs/api/puppeteer.coverage.stopjscoverage.md b/docs/api/puppeteer.coverage.stopjscoverage.md index 996db5c5bb7..483bb8dd759 100644 --- a/docs/api/puppeteer.coverage.stopjscoverage.md +++ b/docs/api/puppeteer.coverage.stopjscoverage.md @@ -4,6 +4,8 @@ sidebar_label: Coverage.stopJSCoverage # Coverage.stopJSCoverage() method +Promise that resolves to the array of coverage reports for all scripts. + #### Signature: ```typescript @@ -16,8 +18,6 @@ class Coverage { Promise<[JSCoverageEntry](./puppeteer.jscoverageentry.md)\[\]> -Promise that resolves to the array of coverage reports for all scripts. - ## Remarks JavaScript Coverage doesn't include anonymous scripts by default. However, scripts with sourceURLs are reported. diff --git a/docs/api/puppeteer.customqueryhandler.md b/docs/api/puppeteer.customqueryhandler.md index 2719a00984c..83d6a1e13dd 100644 --- a/docs/api/puppeteer.customqueryhandler.md +++ b/docs/api/puppeteer.customqueryhandler.md @@ -12,7 +12,7 @@ export interface CustomQueryHandler ## Properties -| Property | Modifiers | Type | Description | Default | -| -------- | --------------------- | --------------------------------------------------------- | ----------- | ------- | -| queryAll | optional | (node: Node, selector: string) => Iterable<Node> | | | -| queryOne | optional | (node: Node, selector: string) => Node \| null | | | +| Property | Modifiers | Type | Description | Default | +| -------- | --------------------- | --------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- | +| queryAll | optional | (node: Node, selector: string) => Iterable<Node> | Searches for some [Nodes](https://developer.mozilla.org/en-US/docs/Web/API/Node) matching the given selector from [node](https://developer.mozilla.org/en-US/docs/Web/API/Node). | | +| queryOne | optional | (node: Node, selector: string) => Node \| null | Searches for a [Node](https://developer.mozilla.org/en-US/docs/Web/API/Node) matching the given selector from [node](https://developer.mozilla.org/en-US/docs/Web/API/Node). | | diff --git a/docs/api/puppeteer.dialog.accept.md b/docs/api/puppeteer.dialog.accept.md index 996989d806e..fbf2f90e1a6 100644 --- a/docs/api/puppeteer.dialog.accept.md +++ b/docs/api/puppeteer.dialog.accept.md @@ -4,6 +4,8 @@ sidebar_label: Dialog.accept # Dialog.accept() method +A promise that resolves when the dialog has been accepted. + #### Signature: ```typescript @@ -21,5 +23,3 @@ class Dialog { **Returns:** Promise<void> - -A promise that resolves when the dialog has been accepted. diff --git a/docs/api/puppeteer.dialog.defaultvalue.md b/docs/api/puppeteer.dialog.defaultvalue.md index 75c23618276..6041646d0b6 100644 --- a/docs/api/puppeteer.dialog.defaultvalue.md +++ b/docs/api/puppeteer.dialog.defaultvalue.md @@ -4,6 +4,8 @@ sidebar_label: Dialog.defaultValue # Dialog.defaultValue() method +The default value of the prompt, or an empty string if the dialog is not a `prompt`. + #### Signature: ```typescript @@ -15,5 +17,3 @@ class Dialog { **Returns:** string - -The default value of the prompt, or an empty string if the dialog is not a `prompt`. diff --git a/docs/api/puppeteer.dialog.dismiss.md b/docs/api/puppeteer.dialog.dismiss.md index c76ff4e33b8..8f4889b4db0 100644 --- a/docs/api/puppeteer.dialog.dismiss.md +++ b/docs/api/puppeteer.dialog.dismiss.md @@ -4,6 +4,8 @@ sidebar_label: Dialog.dismiss # Dialog.dismiss() method +A promise which will resolve once the dialog has been dismissed + #### Signature: ```typescript @@ -15,5 +17,3 @@ class Dialog { **Returns:** Promise<void> - -A promise which will resolve once the dialog has been dismissed diff --git a/docs/api/puppeteer.dialog.md b/docs/api/puppeteer.dialog.md index 4851c802268..2b65ef35983 100644 --- a/docs/api/puppeteer.dialog.md +++ b/docs/api/puppeteer.dialog.md @@ -35,10 +35,10 @@ import puppeteer from 'puppeteer'; ## Methods -| Method | Modifiers | Description | -| ---------------------------------------------------- | --------- | ----------- | -| [accept(promptText)](./puppeteer.dialog.accept.md) | | | -| [defaultValue()](./puppeteer.dialog.defaultvalue.md) | | | -| [dismiss()](./puppeteer.dialog.dismiss.md) | | | -| [message()](./puppeteer.dialog.message.md) | | | -| [type()](./puppeteer.dialog.type.md) | | | +| Method | Modifiers | Description | +| ---------------------------------------------------- | --------- | ----------------------------------------------------------------------------------------------- | +| [accept(promptText)](./puppeteer.dialog.accept.md) | | A promise that resolves when the dialog has been accepted. | +| [defaultValue()](./puppeteer.dialog.defaultvalue.md) | | The default value of the prompt, or an empty string if the dialog is not a prompt. | +| [dismiss()](./puppeteer.dialog.dismiss.md) | | A promise which will resolve once the dialog has been dismissed | +| [message()](./puppeteer.dialog.message.md) | | The message displayed in the dialog. | +| [type()](./puppeteer.dialog.type.md) | | The type of the dialog. | diff --git a/docs/api/puppeteer.dialog.message.md b/docs/api/puppeteer.dialog.message.md index e837d1dec02..b39526eafba 100644 --- a/docs/api/puppeteer.dialog.message.md +++ b/docs/api/puppeteer.dialog.message.md @@ -4,6 +4,8 @@ sidebar_label: Dialog.message # Dialog.message() method +The message displayed in the dialog. + #### Signature: ```typescript @@ -15,5 +17,3 @@ class Dialog { **Returns:** string - -The message displayed in the dialog. diff --git a/docs/api/puppeteer.dialog.type.md b/docs/api/puppeteer.dialog.type.md index 948b751523a..9ef343d2f2e 100644 --- a/docs/api/puppeteer.dialog.type.md +++ b/docs/api/puppeteer.dialog.type.md @@ -4,6 +4,8 @@ sidebar_label: Dialog.type # Dialog.type() method +The type of the dialog. + #### Signature: ```typescript @@ -15,5 +17,3 @@ class Dialog { **Returns:** Protocol.Page.DialogType - -The type of the dialog. diff --git a/docs/api/puppeteer.frame.childframes.md b/docs/api/puppeteer.frame.childframes.md index 8d9a1400069..e62165680f1 100644 --- a/docs/api/puppeteer.frame.childframes.md +++ b/docs/api/puppeteer.frame.childframes.md @@ -4,6 +4,8 @@ sidebar_label: Frame.childFrames # Frame.childFrames() method +An array of child frames. + #### Signature: ```typescript @@ -15,5 +17,3 @@ class Frame { **Returns:** [Frame](./puppeteer.frame.md)\[\] - -An array of child frames. diff --git a/docs/api/puppeteer.frame.content.md b/docs/api/puppeteer.frame.content.md index 14ad7535cd2..ec9852e0aad 100644 --- a/docs/api/puppeteer.frame.content.md +++ b/docs/api/puppeteer.frame.content.md @@ -4,6 +4,8 @@ sidebar_label: Frame.content # Frame.content() method +The full HTML contents of the frame, including the DOCTYPE. + #### Signature: ```typescript @@ -15,5 +17,3 @@ class Frame { **Returns:** Promise<string> - -The full HTML contents of the frame, including the DOCTYPE. diff --git a/docs/api/puppeteer.frame.isdetached.md b/docs/api/puppeteer.frame.isdetached.md index c994ff1b076..a43bcb70e3a 100644 --- a/docs/api/puppeteer.frame.isdetached.md +++ b/docs/api/puppeteer.frame.isdetached.md @@ -4,6 +4,8 @@ sidebar_label: Frame.isDetached # Frame.isDetached() method +Is`true` if the frame has been detached. Otherwise, `false`. + #### Signature: ```typescript @@ -15,5 +17,3 @@ class Frame { **Returns:** boolean - -`true` if the frame has been detached. Otherwise, `false`. diff --git a/docs/api/puppeteer.frame.isoopframe.md b/docs/api/puppeteer.frame.isoopframe.md index 8f6da464b12..222faa07b73 100644 --- a/docs/api/puppeteer.frame.isoopframe.md +++ b/docs/api/puppeteer.frame.isoopframe.md @@ -4,6 +4,8 @@ sidebar_label: Frame.isOOPFrame # Frame.isOOPFrame() method +Is `true` if the frame is an out-of-process (OOP) frame. Otherwise, `false`. + #### Signature: ```typescript @@ -15,5 +17,3 @@ class Frame { **Returns:** boolean - -`true` if the frame is an out-of-process (OOP) frame. Otherwise, `false`. diff --git a/docs/api/puppeteer.frame.md b/docs/api/puppeteer.frame.md index ea076618822..0450f2c8a01 100644 --- a/docs/api/puppeteer.frame.md +++ b/docs/api/puppeteer.frame.md @@ -71,25 +71,25 @@ console.log(text); | [addScriptTag(options)](./puppeteer.frame.addscripttag.md) | | Adds a <script> tag into the page with the desired url or content. | | [addStyleTag(options)](./puppeteer.frame.addstyletag.md) | | Adds a <link rel="stylesheet"> tag into the page with the desired URL or a <style type="text/css"> tag with the content. | | [addStyleTag(options)](./puppeteer.frame.addstyletag_1.md) | | | -| [childFrames()](./puppeteer.frame.childframes.md) | | | +| [childFrames()](./puppeteer.frame.childframes.md) | | An array of child frames. | | [click(selector, options)](./puppeteer.frame.click.md) | | Clicks the first element found that matches selector. | -| [content()](./puppeteer.frame.content.md) | | | +| [content()](./puppeteer.frame.content.md) | | The full HTML contents of the frame, including the DOCTYPE. | | [evaluate(pageFunction, args)](./puppeteer.frame.evaluate.md) | | Behaves identically to [Page.evaluate()](./puppeteer.page.evaluate.md) except it's run within the the context of this frame. | | [evaluateHandle(pageFunction, args)](./puppeteer.frame.evaluatehandle.md) | | Behaves identically to [Page.evaluateHandle()](./puppeteer.page.evaluatehandle.md) except it's run within the context of this frame. | | [focus(selector)](./puppeteer.frame.focus.md) | | Focuses the first element that matches the selector. | | [goto(url, options)](./puppeteer.frame.goto.md) | | Navigates a frame to the given url. | | [hover(selector)](./puppeteer.frame.hover.md) | | Hovers the pointer over the center of the first element that matches the selector. | -| [isDetached()](./puppeteer.frame.isdetached.md) | | | -| [isOOPFrame()](./puppeteer.frame.isoopframe.md) | | | -| [name()](./puppeteer.frame.name.md) | | | -| [page()](./puppeteer.frame.page.md) | | | -| [parentFrame()](./puppeteer.frame.parentframe.md) | | | +| [isDetached()](./puppeteer.frame.isdetached.md) | | Istrue if the frame has been detached. Otherwise, false. | +| [isOOPFrame()](./puppeteer.frame.isoopframe.md) | | Is true if the frame is an out-of-process (OOP) frame. Otherwise, false. | +| [name()](./puppeteer.frame.name.md) | | The frame's name attribute as specified in the tag. | +| [page()](./puppeteer.frame.page.md) | | The page associated with the frame. | +| [parentFrame()](./puppeteer.frame.parentframe.md) | | The parent frame, if any. Detached and main frames return null. | | [select(selector, values)](./puppeteer.frame.select.md) | | Selects a set of value on the first <select> element that matches the selector. | | [setContent(html, options)](./puppeteer.frame.setcontent.md) | | Set the content of the frame. | | [tap(selector)](./puppeteer.frame.tap.md) | | Taps the first element that matches the selector. | -| [title()](./puppeteer.frame.title.md) | | | +| [title()](./puppeteer.frame.title.md) | | The frame's title. | | [type(selector, text, options)](./puppeteer.frame.type.md) | | Sends a keydown, keypress/input, and keyup event for each character in the text. | -| [url()](./puppeteer.frame.url.md) | | | +| [url()](./puppeteer.frame.url.md) | | The frame's URL. | | [waitForDevicePrompt(options)](./puppeteer.frame.waitfordeviceprompt.md) | |

This method is typically coupled with an action that triggers a device request from an api such as WebBluetooth.

:::caution

This must be called before the device request is made. It will not return a currently active device prompt.

:::

| | [waitForFunction(pageFunction, options, args)](./puppeteer.frame.waitforfunction.md) | | | | [waitForNavigation(options)](./puppeteer.frame.waitfornavigation.md) | |

Waits for the frame to navigate. It is useful for when you run code which will indirectly cause the frame to navigate.

Usage of the [History API](https://developer.mozilla.org/en-US/docs/Web/API/History_API) to change the URL is considered a navigation.

| diff --git a/docs/api/puppeteer.frame.name.md b/docs/api/puppeteer.frame.name.md index a5995fe1578..cfb472d233c 100644 --- a/docs/api/puppeteer.frame.name.md +++ b/docs/api/puppeteer.frame.name.md @@ -4,6 +4,8 @@ sidebar_label: Frame.name # Frame.name() method +The frame's `name` attribute as specified in the tag. + #### Signature: ```typescript @@ -16,8 +18,6 @@ class Frame { string -The frame's `name` attribute as specified in the tag. - ## Remarks This value is calculated once when the frame is created, and will not update if the attribute is changed later. diff --git a/docs/api/puppeteer.frame.page.md b/docs/api/puppeteer.frame.page.md index 96dce12e295..dd4027c71de 100644 --- a/docs/api/puppeteer.frame.page.md +++ b/docs/api/puppeteer.frame.page.md @@ -4,6 +4,8 @@ sidebar_label: Frame.page # Frame.page() method +The page associated with the frame. + #### Signature: ```typescript @@ -15,5 +17,3 @@ class Frame { **Returns:** [Page](./puppeteer.page.md) - -The page associated with the frame. diff --git a/docs/api/puppeteer.frame.parentframe.md b/docs/api/puppeteer.frame.parentframe.md index ac1a5fa0f12..5b0879b1827 100644 --- a/docs/api/puppeteer.frame.parentframe.md +++ b/docs/api/puppeteer.frame.parentframe.md @@ -4,6 +4,8 @@ sidebar_label: Frame.parentFrame # Frame.parentFrame() method +The parent frame, if any. Detached and main frames return `null`. + #### Signature: ```typescript @@ -15,5 +17,3 @@ class Frame { **Returns:** [Frame](./puppeteer.frame.md) \| null - -The parent frame, if any. Detached and main frames return `null`. diff --git a/docs/api/puppeteer.frame.title.md b/docs/api/puppeteer.frame.title.md index 96e474f20fc..a6fe9945c0b 100644 --- a/docs/api/puppeteer.frame.title.md +++ b/docs/api/puppeteer.frame.title.md @@ -4,6 +4,8 @@ sidebar_label: Frame.title # Frame.title() method +The frame's title. + #### Signature: ```typescript @@ -15,5 +17,3 @@ class Frame { **Returns:** Promise<string> - -the frame's title. diff --git a/docs/api/puppeteer.frame.url.md b/docs/api/puppeteer.frame.url.md index d6339c6cbdc..7c757b42643 100644 --- a/docs/api/puppeteer.frame.url.md +++ b/docs/api/puppeteer.frame.url.md @@ -4,6 +4,8 @@ sidebar_label: Frame.url # Frame.url() method +The frame's URL. + #### Signature: ```typescript @@ -15,5 +17,3 @@ class Frame { **Returns:** string - -The frame's URL. diff --git a/docs/api/puppeteer.httprequest.aborterrorreason.md b/docs/api/puppeteer.httprequest.aborterrorreason.md index b5ca91c3e09..ed4c782d923 100644 --- a/docs/api/puppeteer.httprequest.aborterrorreason.md +++ b/docs/api/puppeteer.httprequest.aborterrorreason.md @@ -4,6 +4,8 @@ sidebar_label: HTTPRequest.abortErrorReason # HTTPRequest.abortErrorReason() method +The most recent reason for aborting the request + #### Signature: ```typescript @@ -15,5 +17,3 @@ class HTTPRequest { **Returns:** Protocol.Network.ErrorReason \| null - -the most recent reason for aborting the request diff --git a/docs/api/puppeteer.httprequest.continuerequestoverrides.md b/docs/api/puppeteer.httprequest.continuerequestoverrides.md index 597f66a5fb1..832d430deeb 100644 --- a/docs/api/puppeteer.httprequest.continuerequestoverrides.md +++ b/docs/api/puppeteer.httprequest.continuerequestoverrides.md @@ -4,6 +4,8 @@ sidebar_label: HTTPRequest.continueRequestOverrides # HTTPRequest.continueRequestOverrides() method +The `ContinueRequestOverrides` that will be used if the interception is allowed to continue (ie, `abort()` and `respond()` aren't called). + #### Signature: ```typescript @@ -15,5 +17,3 @@ class HTTPRequest { **Returns:** [ContinueRequestOverrides](./puppeteer.continuerequestoverrides.md) - -the `ContinueRequestOverrides` that will be used if the interception is allowed to continue (ie, `abort()` and `respond()` aren't called). diff --git a/docs/api/puppeteer.httprequest.frame.md b/docs/api/puppeteer.httprequest.frame.md index 718486e462d..f32e9cfbb01 100644 --- a/docs/api/puppeteer.httprequest.frame.md +++ b/docs/api/puppeteer.httprequest.frame.md @@ -4,6 +4,8 @@ sidebar_label: HTTPRequest.frame # HTTPRequest.frame() method +The frame that initiated the request, or null if navigating to error pages. + #### Signature: ```typescript @@ -15,5 +17,3 @@ class HTTPRequest { **Returns:** [Frame](./puppeteer.frame.md) \| null - -the frame that initiated the request, or null if navigating to error pages. diff --git a/docs/api/puppeteer.httprequest.headers.md b/docs/api/puppeteer.httprequest.headers.md index 750af334a9f..6c0a7496787 100644 --- a/docs/api/puppeteer.httprequest.headers.md +++ b/docs/api/puppeteer.httprequest.headers.md @@ -4,6 +4,8 @@ sidebar_label: HTTPRequest.headers # HTTPRequest.headers() method +An object with HTTP headers associated with the request. All header names are lower-case. + #### Signature: ```typescript @@ -15,5 +17,3 @@ class HTTPRequest { **Returns:** Record<string, string> - -an object with HTTP headers associated with the request. All header names are lower-case. diff --git a/docs/api/puppeteer.httprequest.initiator.md b/docs/api/puppeteer.httprequest.initiator.md index e413108c610..f66f174a531 100644 --- a/docs/api/puppeteer.httprequest.initiator.md +++ b/docs/api/puppeteer.httprequest.initiator.md @@ -4,6 +4,8 @@ sidebar_label: HTTPRequest.initiator # HTTPRequest.initiator() method +The initiator of the request. + #### Signature: ```typescript @@ -15,5 +17,3 @@ class HTTPRequest { **Returns:** Protocol.Network.Initiator - -the initiator of the request. diff --git a/docs/api/puppeteer.httprequest.interceptresolutionstate.md b/docs/api/puppeteer.httprequest.interceptresolutionstate.md index 08bd85a1dc3..2adca7ac17b 100644 --- a/docs/api/puppeteer.httprequest.interceptresolutionstate.md +++ b/docs/api/puppeteer.httprequest.interceptresolutionstate.md @@ -4,6 +4,12 @@ sidebar_label: HTTPRequest.interceptResolutionState # HTTPRequest.interceptResolutionState() method +An InterceptResolutionState object describing the current resolution action and priority. + +InterceptResolutionState contains: action: InterceptResolutionAction priority?: number + +InterceptResolutionAction is one of: `abort`, `respond`, `continue`, `disabled`, `none`, or `already-handled`. + #### Signature: ```typescript @@ -15,9 +21,3 @@ class HTTPRequest { **Returns:** [InterceptResolutionState](./puppeteer.interceptresolutionstate.md) - -An InterceptResolutionState object describing the current resolution action and priority. - -InterceptResolutionState contains: action: InterceptResolutionAction priority?: number - -InterceptResolutionAction is one of: `abort`, `respond`, `continue`, `disabled`, `none`, or `already-handled`. diff --git a/docs/api/puppeteer.httprequest.isinterceptresolutionhandled.md b/docs/api/puppeteer.httprequest.isinterceptresolutionhandled.md index 4bc772fe2ac..2807a9cfb16 100644 --- a/docs/api/puppeteer.httprequest.isinterceptresolutionhandled.md +++ b/docs/api/puppeteer.httprequest.isinterceptresolutionhandled.md @@ -4,6 +4,8 @@ sidebar_label: HTTPRequest.isInterceptResolutionHandled # HTTPRequest.isInterceptResolutionHandled() method +Is `true` if the intercept resolution has already been handled, `false` otherwise. + #### Signature: ```typescript @@ -15,5 +17,3 @@ class HTTPRequest { **Returns:** boolean - -`true` if the intercept resolution has already been handled, `false` otherwise. diff --git a/docs/api/puppeteer.httprequest.isnavigationrequest.md b/docs/api/puppeteer.httprequest.isnavigationrequest.md index 35f03cd1784..cfb120e2bc5 100644 --- a/docs/api/puppeteer.httprequest.isnavigationrequest.md +++ b/docs/api/puppeteer.httprequest.isnavigationrequest.md @@ -4,6 +4,8 @@ sidebar_label: HTTPRequest.isNavigationRequest # HTTPRequest.isNavigationRequest() method +True if the request is the driver of the current frame's navigation. + #### Signature: ```typescript @@ -15,5 +17,3 @@ class HTTPRequest { **Returns:** boolean - -true if the request is the driver of the current frame's navigation. diff --git a/docs/api/puppeteer.httprequest.md b/docs/api/puppeteer.httprequest.md index 594706d9b5e..500d4c10e4e 100644 --- a/docs/api/puppeteer.httprequest.md +++ b/docs/api/puppeteer.httprequest.md @@ -40,26 +40,26 @@ The constructor for this class is marked as internal. Third-party code should no ## Methods -| Method | Modifiers | Description | -| ------------------------------------------------------------------------------------------- | --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [abort(errorCode, priority)](./puppeteer.httprequest.abort.md) | | Aborts a request. | -| [abortErrorReason()](./puppeteer.httprequest.aborterrorreason.md) | | | -| [continue(overrides, priority)](./puppeteer.httprequest.continue.md) | | Continues request with optional request overrides. | -| [continueRequestOverrides()](./puppeteer.httprequest.continuerequestoverrides.md) | | | -| [enqueueInterceptAction(pendingHandler)](./puppeteer.httprequest.enqueueinterceptaction.md) | | Adds an async request handler to the processing queue. Deferred handlers are not guaranteed to execute in any particular order, but they are guaranteed to resolve before the request interception is finalized. | -| [failure()](./puppeteer.httprequest.failure.md) | | Access information about the request's failure. | -| [finalizeInterceptions()](./puppeteer.httprequest.finalizeinterceptions.md) | | Awaits pending interception handlers and then decides how to fulfill the request interception. | -| [frame()](./puppeteer.httprequest.frame.md) | | | -| [headers()](./puppeteer.httprequest.headers.md) | | | -| [initiator()](./puppeteer.httprequest.initiator.md) | | | -| [interceptResolutionState()](./puppeteer.httprequest.interceptresolutionstate.md) | | | -| [isInterceptResolutionHandled()](./puppeteer.httprequest.isinterceptresolutionhandled.md) | | | -| [isNavigationRequest()](./puppeteer.httprequest.isnavigationrequest.md) | | | -| [method()](./puppeteer.httprequest.method.md) | | | -| [postData()](./puppeteer.httprequest.postdata.md) | | | -| [redirectChain()](./puppeteer.httprequest.redirectchain.md) | | A redirectChain is a chain of requests initiated to fetch a resource. | -| [resourceType()](./puppeteer.httprequest.resourcetype.md) | | Contains the request's resource type as it was perceived by the rendering engine. | -| [respond(response, priority)](./puppeteer.httprequest.respond.md) | | Fulfills a request with the given response. | -| [response()](./puppeteer.httprequest.response.md) | | | -| [responseForRequest()](./puppeteer.httprequest.responseforrequest.md) | | | -| [url()](./puppeteer.httprequest.url.md) | | | +| Method | Modifiers | Description | +| ------------------------------------------------------------------------------------------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| [abort(errorCode, priority)](./puppeteer.httprequest.abort.md) | | Aborts a request. | +| [abortErrorReason()](./puppeteer.httprequest.aborterrorreason.md) | | The most recent reason for aborting the request | +| [continue(overrides, priority)](./puppeteer.httprequest.continue.md) | | Continues request with optional request overrides. | +| [continueRequestOverrides()](./puppeteer.httprequest.continuerequestoverrides.md) | | The ContinueRequestOverrides that will be used if the interception is allowed to continue (ie, abort() and respond() aren't called). | +| [enqueueInterceptAction(pendingHandler)](./puppeteer.httprequest.enqueueinterceptaction.md) | | Adds an async request handler to the processing queue. Deferred handlers are not guaranteed to execute in any particular order, but they are guaranteed to resolve before the request interception is finalized. | +| [failure()](./puppeteer.httprequest.failure.md) | | Access information about the request's failure. | +| [finalizeInterceptions()](./puppeteer.httprequest.finalizeinterceptions.md) | | Awaits pending interception handlers and then decides how to fulfill the request interception. | +| [frame()](./puppeteer.httprequest.frame.md) | | The frame that initiated the request, or null if navigating to error pages. | +| [headers()](./puppeteer.httprequest.headers.md) | | An object with HTTP headers associated with the request. All header names are lower-case. | +| [initiator()](./puppeteer.httprequest.initiator.md) | | The initiator of the request. | +| [interceptResolutionState()](./puppeteer.httprequest.interceptresolutionstate.md) | |

An InterceptResolutionState object describing the current resolution action and priority.

InterceptResolutionState contains: action: InterceptResolutionAction priority?: number

InterceptResolutionAction is one of: abort, respond, continue, disabled, none, or already-handled.

| +| [isInterceptResolutionHandled()](./puppeteer.httprequest.isinterceptresolutionhandled.md) | | Is true if the intercept resolution has already been handled, false otherwise. | +| [isNavigationRequest()](./puppeteer.httprequest.isnavigationrequest.md) | | True if the request is the driver of the current frame's navigation. | +| [method()](./puppeteer.httprequest.method.md) | | The method used (GET, POST, etc.) | +| [postData()](./puppeteer.httprequest.postdata.md) | | The request's post body, if any. | +| [redirectChain()](./puppeteer.httprequest.redirectchain.md) | | A redirectChain is a chain of requests initiated to fetch a resource. | +| [resourceType()](./puppeteer.httprequest.resourcetype.md) | | Contains the request's resource type as it was perceived by the rendering engine. | +| [respond(response, priority)](./puppeteer.httprequest.respond.md) | | Fulfills a request with the given response. | +| [response()](./puppeteer.httprequest.response.md) | | A matching HTTPResponse object, or null if the response has not been received yet. | +| [responseForRequest()](./puppeteer.httprequest.responseforrequest.md) | | The ResponseForRequest that gets used if the interception is allowed to respond (ie, abort() is not called). | +| [url()](./puppeteer.httprequest.url.md) | | The URL of the request | diff --git a/docs/api/puppeteer.httprequest.method.md b/docs/api/puppeteer.httprequest.method.md index aec833c36f8..ce261ac28ff 100644 --- a/docs/api/puppeteer.httprequest.method.md +++ b/docs/api/puppeteer.httprequest.method.md @@ -4,6 +4,8 @@ sidebar_label: HTTPRequest.method # HTTPRequest.method() method +The method used (`GET`, `POST`, etc.) + #### Signature: ```typescript @@ -15,5 +17,3 @@ class HTTPRequest { **Returns:** string - -the method used (`GET`, `POST`, etc.) diff --git a/docs/api/puppeteer.httprequest.postdata.md b/docs/api/puppeteer.httprequest.postdata.md index 6461de652f7..7b7e1b328d5 100644 --- a/docs/api/puppeteer.httprequest.postdata.md +++ b/docs/api/puppeteer.httprequest.postdata.md @@ -4,6 +4,8 @@ sidebar_label: HTTPRequest.postData # HTTPRequest.postData() method +The request's post body, if any. + #### Signature: ```typescript @@ -15,5 +17,3 @@ class HTTPRequest { **Returns:** string \| undefined - -the request's post body, if any. diff --git a/docs/api/puppeteer.httprequest.response.md b/docs/api/puppeteer.httprequest.response.md index e797a055ebb..57a193bb74e 100644 --- a/docs/api/puppeteer.httprequest.response.md +++ b/docs/api/puppeteer.httprequest.response.md @@ -4,6 +4,8 @@ sidebar_label: HTTPRequest.response # HTTPRequest.response() method +A matching `HTTPResponse` object, or null if the response has not been received yet. + #### Signature: ```typescript @@ -15,5 +17,3 @@ class HTTPRequest { **Returns:** [HTTPResponse](./puppeteer.httpresponse.md) \| null - -A matching `HTTPResponse` object, or null if the response has not been received yet. diff --git a/docs/api/puppeteer.httprequest.responseforrequest.md b/docs/api/puppeteer.httprequest.responseforrequest.md index 4e4ea2524cf..168b83131b1 100644 --- a/docs/api/puppeteer.httprequest.responseforrequest.md +++ b/docs/api/puppeteer.httprequest.responseforrequest.md @@ -4,6 +4,8 @@ sidebar_label: HTTPRequest.responseForRequest # HTTPRequest.responseForRequest() method +The `ResponseForRequest` that gets used if the interception is allowed to respond (ie, `abort()` is not called). + #### Signature: ```typescript @@ -15,5 +17,3 @@ class HTTPRequest { **Returns:** Partial<[ResponseForRequest](./puppeteer.responseforrequest.md)> \| null - -The `ResponseForRequest` that gets used if the interception is allowed to respond (ie, `abort()` is not called). diff --git a/docs/api/puppeteer.httprequest.url.md b/docs/api/puppeteer.httprequest.url.md index b76e21ff16a..ec8e667fa5f 100644 --- a/docs/api/puppeteer.httprequest.url.md +++ b/docs/api/puppeteer.httprequest.url.md @@ -4,6 +4,8 @@ sidebar_label: HTTPRequest.url # HTTPRequest.url() method +The URL of the request + #### Signature: ```typescript @@ -15,5 +17,3 @@ class HTTPRequest { **Returns:** string - -the URL of the request diff --git a/docs/api/puppeteer.httpresponse.buffer.md b/docs/api/puppeteer.httpresponse.buffer.md index 15607279051..75c64d4ac67 100644 --- a/docs/api/puppeteer.httpresponse.buffer.md +++ b/docs/api/puppeteer.httpresponse.buffer.md @@ -4,6 +4,8 @@ sidebar_label: HTTPResponse.buffer # HTTPResponse.buffer() method +Promise which resolves to a buffer with response body. + #### Signature: ```typescript @@ -15,5 +17,3 @@ class HTTPResponse { **Returns:** Promise<Buffer> - -Promise which resolves to a buffer with response body. diff --git a/docs/api/puppeteer.httpresponse.frame.md b/docs/api/puppeteer.httpresponse.frame.md index 83a0964c9f9..781736cd29b 100644 --- a/docs/api/puppeteer.httpresponse.frame.md +++ b/docs/api/puppeteer.httpresponse.frame.md @@ -4,6 +4,8 @@ sidebar_label: HTTPResponse.frame # HTTPResponse.frame() method +A [Frame](./puppeteer.frame.md) that initiated this response, or `null` if navigating to error pages. + #### Signature: ```typescript @@ -15,5 +17,3 @@ class HTTPResponse { **Returns:** [Frame](./puppeteer.frame.md) \| null - -A [Frame](./puppeteer.frame.md) that initiated this response, or `null` if navigating to error pages. diff --git a/docs/api/puppeteer.httpresponse.fromcache.md b/docs/api/puppeteer.httpresponse.fromcache.md index ddf029ff912..ec38a9ebb44 100644 --- a/docs/api/puppeteer.httpresponse.fromcache.md +++ b/docs/api/puppeteer.httpresponse.fromcache.md @@ -4,6 +4,8 @@ sidebar_label: HTTPResponse.fromCache # HTTPResponse.fromCache() method +True if the response was served from either the browser's disk cache or memory cache. + #### Signature: ```typescript @@ -15,5 +17,3 @@ class HTTPResponse { **Returns:** boolean - -True if the response was served from either the browser's disk cache or memory cache. diff --git a/docs/api/puppeteer.httpresponse.fromserviceworker.md b/docs/api/puppeteer.httpresponse.fromserviceworker.md index e5a126694bf..7de43d3c17a 100644 --- a/docs/api/puppeteer.httpresponse.fromserviceworker.md +++ b/docs/api/puppeteer.httpresponse.fromserviceworker.md @@ -4,6 +4,8 @@ sidebar_label: HTTPResponse.fromServiceWorker # HTTPResponse.fromServiceWorker() method +True if the response was served by a service worker. + #### Signature: ```typescript @@ -15,5 +17,3 @@ class HTTPResponse { **Returns:** boolean - -True if the response was served by a service worker. diff --git a/docs/api/puppeteer.httpresponse.headers.md b/docs/api/puppeteer.httpresponse.headers.md index 775d4a41246..05790794ffd 100644 --- a/docs/api/puppeteer.httpresponse.headers.md +++ b/docs/api/puppeteer.httpresponse.headers.md @@ -4,6 +4,8 @@ sidebar_label: HTTPResponse.headers # HTTPResponse.headers() method +An object with HTTP headers associated with the response. All header names are lower-case. + #### Signature: ```typescript @@ -15,5 +17,3 @@ class HTTPResponse { **Returns:** Record<string, string> - -An object with HTTP headers associated with the response. All header names are lower-case. diff --git a/docs/api/puppeteer.httpresponse.json.md b/docs/api/puppeteer.httpresponse.json.md index 229a50b3133..d3641eb5454 100644 --- a/docs/api/puppeteer.httpresponse.json.md +++ b/docs/api/puppeteer.httpresponse.json.md @@ -4,6 +4,8 @@ sidebar_label: HTTPResponse.json # HTTPResponse.json() method +Promise which resolves to a JSON representation of response body. + #### Signature: ```typescript @@ -16,8 +18,6 @@ class HTTPResponse { Promise<any> -Promise which resolves to a JSON representation of response body. - ## Remarks This method will throw if the response body is not parsable via `JSON.parse`. diff --git a/docs/api/puppeteer.httpresponse.md b/docs/api/puppeteer.httpresponse.md index d9be4dd79e0..411b48c7cff 100644 --- a/docs/api/puppeteer.httpresponse.md +++ b/docs/api/puppeteer.httpresponse.md @@ -18,20 +18,20 @@ The constructor for this class is marked as internal. Third-party code should no ## Methods -| Method | Modifiers | Description | -| -------------------------------------------------------------------- | --------- | ----------- | -| [buffer()](./puppeteer.httpresponse.buffer.md) | | | -| [frame()](./puppeteer.httpresponse.frame.md) | | | -| [fromCache()](./puppeteer.httpresponse.fromcache.md) | | | -| [fromServiceWorker()](./puppeteer.httpresponse.fromserviceworker.md) | | | -| [headers()](./puppeteer.httpresponse.headers.md) | | | -| [json()](./puppeteer.httpresponse.json.md) | | | -| [ok()](./puppeteer.httpresponse.ok.md) | | | -| [remoteAddress()](./puppeteer.httpresponse.remoteaddress.md) | | | -| [request()](./puppeteer.httpresponse.request.md) | | | -| [securityDetails()](./puppeteer.httpresponse.securitydetails.md) | | | -| [status()](./puppeteer.httpresponse.status.md) | | | -| [statusText()](./puppeteer.httpresponse.statustext.md) | | | -| [text()](./puppeteer.httpresponse.text.md) | | | -| [timing()](./puppeteer.httpresponse.timing.md) | | | -| [url()](./puppeteer.httpresponse.url.md) | | | +| Method | Modifiers | Description | +| -------------------------------------------------------------------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------ | +| [buffer()](./puppeteer.httpresponse.buffer.md) | | Promise which resolves to a buffer with response body. | +| [frame()](./puppeteer.httpresponse.frame.md) | | A [Frame](./puppeteer.frame.md) that initiated this response, or null if navigating to error pages. | +| [fromCache()](./puppeteer.httpresponse.fromcache.md) | | True if the response was served from either the browser's disk cache or memory cache. | +| [fromServiceWorker()](./puppeteer.httpresponse.fromserviceworker.md) | | True if the response was served by a service worker. | +| [headers()](./puppeteer.httpresponse.headers.md) | | An object with HTTP headers associated with the response. All header names are lower-case. | +| [json()](./puppeteer.httpresponse.json.md) | | Promise which resolves to a JSON representation of response body. | +| [ok()](./puppeteer.httpresponse.ok.md) | | True if the response was successful (status in the range 200-299). | +| [remoteAddress()](./puppeteer.httpresponse.remoteaddress.md) | | The IP address and port number used to connect to the remote server. | +| [request()](./puppeteer.httpresponse.request.md) | | A matching [HTTPRequest](./puppeteer.httprequest.md) object. | +| [securityDetails()](./puppeteer.httpresponse.securitydetails.md) | | [SecurityDetails](./puppeteer.securitydetails.md) if the response was received over the secure connection, or null otherwise. | +| [status()](./puppeteer.httpresponse.status.md) | | The status code of the response (e.g., 200 for a success). | +| [statusText()](./puppeteer.httpresponse.statustext.md) | | The status text of the response (e.g. usually an "OK" for a success). | +| [text()](./puppeteer.httpresponse.text.md) | | Promise which resolves to a text representation of response body. | +| [timing()](./puppeteer.httpresponse.timing.md) | | Timing information related to the response. | +| [url()](./puppeteer.httpresponse.url.md) | | The URL of the response. | diff --git a/docs/api/puppeteer.httpresponse.ok.md b/docs/api/puppeteer.httpresponse.ok.md index 287faf09584..bc0955eb1b7 100644 --- a/docs/api/puppeteer.httpresponse.ok.md +++ b/docs/api/puppeteer.httpresponse.ok.md @@ -4,6 +4,8 @@ sidebar_label: HTTPResponse.ok # HTTPResponse.ok() method +True if the response was successful (status in the range 200-299). + #### Signature: ```typescript @@ -15,5 +17,3 @@ class HTTPResponse { **Returns:** boolean - -True if the response was successful (status in the range 200-299). diff --git a/docs/api/puppeteer.httpresponse.remoteaddress.md b/docs/api/puppeteer.httpresponse.remoteaddress.md index e9dee405e89..fb34ae9eb09 100644 --- a/docs/api/puppeteer.httpresponse.remoteaddress.md +++ b/docs/api/puppeteer.httpresponse.remoteaddress.md @@ -4,6 +4,8 @@ sidebar_label: HTTPResponse.remoteAddress # HTTPResponse.remoteAddress() method +The IP address and port number used to connect to the remote server. + #### Signature: ```typescript @@ -15,5 +17,3 @@ class HTTPResponse { **Returns:** [RemoteAddress](./puppeteer.remoteaddress.md) - -The IP address and port number used to connect to the remote server. diff --git a/docs/api/puppeteer.httpresponse.request.md b/docs/api/puppeteer.httpresponse.request.md index 21e06ec3609..aeb88988dbc 100644 --- a/docs/api/puppeteer.httpresponse.request.md +++ b/docs/api/puppeteer.httpresponse.request.md @@ -4,6 +4,8 @@ sidebar_label: HTTPResponse.request # HTTPResponse.request() method +A matching [HTTPRequest](./puppeteer.httprequest.md) object. + #### Signature: ```typescript @@ -15,5 +17,3 @@ class HTTPResponse { **Returns:** [HTTPRequest](./puppeteer.httprequest.md) - -A matching [HTTPRequest](./puppeteer.httprequest.md) object. diff --git a/docs/api/puppeteer.httpresponse.securitydetails.md b/docs/api/puppeteer.httpresponse.securitydetails.md index bd1954f8d36..d8f086d9fa8 100644 --- a/docs/api/puppeteer.httpresponse.securitydetails.md +++ b/docs/api/puppeteer.httpresponse.securitydetails.md @@ -4,6 +4,8 @@ sidebar_label: HTTPResponse.securityDetails # HTTPResponse.securityDetails() method +[SecurityDetails](./puppeteer.securitydetails.md) if the response was received over the secure connection, or `null` otherwise. + #### Signature: ```typescript @@ -15,5 +17,3 @@ class HTTPResponse { **Returns:** [SecurityDetails](./puppeteer.securitydetails.md) \| null - -[SecurityDetails](./puppeteer.securitydetails.md) if the response was received over the secure connection, or `null` otherwise. diff --git a/docs/api/puppeteer.httpresponse.status.md b/docs/api/puppeteer.httpresponse.status.md index 7f22189568d..fcb0ab1e1b6 100644 --- a/docs/api/puppeteer.httpresponse.status.md +++ b/docs/api/puppeteer.httpresponse.status.md @@ -4,6 +4,8 @@ sidebar_label: HTTPResponse.status # HTTPResponse.status() method +The status code of the response (e.g., 200 for a success). + #### Signature: ```typescript @@ -15,5 +17,3 @@ class HTTPResponse { **Returns:** number - -The status code of the response (e.g., 200 for a success). diff --git a/docs/api/puppeteer.httpresponse.statustext.md b/docs/api/puppeteer.httpresponse.statustext.md index 127b2dccbf8..30449231460 100644 --- a/docs/api/puppeteer.httpresponse.statustext.md +++ b/docs/api/puppeteer.httpresponse.statustext.md @@ -4,6 +4,8 @@ sidebar_label: HTTPResponse.statusText # HTTPResponse.statusText() method +The status text of the response (e.g. usually an "OK" for a success). + #### Signature: ```typescript @@ -15,5 +17,3 @@ class HTTPResponse { **Returns:** string - -The status text of the response (e.g. usually an "OK" for a success). diff --git a/docs/api/puppeteer.httpresponse.text.md b/docs/api/puppeteer.httpresponse.text.md index bd76b751866..9e040a3f0d5 100644 --- a/docs/api/puppeteer.httpresponse.text.md +++ b/docs/api/puppeteer.httpresponse.text.md @@ -4,6 +4,8 @@ sidebar_label: HTTPResponse.text # HTTPResponse.text() method +Promise which resolves to a text representation of response body. + #### Signature: ```typescript @@ -15,5 +17,3 @@ class HTTPResponse { **Returns:** Promise<string> - -Promise which resolves to a text representation of response body. diff --git a/docs/api/puppeteer.httpresponse.timing.md b/docs/api/puppeteer.httpresponse.timing.md index db2e44a0009..273d14c395b 100644 --- a/docs/api/puppeteer.httpresponse.timing.md +++ b/docs/api/puppeteer.httpresponse.timing.md @@ -4,6 +4,8 @@ sidebar_label: HTTPResponse.timing # HTTPResponse.timing() method +Timing information related to the response. + #### Signature: ```typescript @@ -15,5 +17,3 @@ class HTTPResponse { **Returns:** Protocol.Network.ResourceTiming \| null - -Timing information related to the response. diff --git a/docs/api/puppeteer.httpresponse.url.md b/docs/api/puppeteer.httpresponse.url.md index c2fe551b94a..01dbb6c3853 100644 --- a/docs/api/puppeteer.httpresponse.url.md +++ b/docs/api/puppeteer.httpresponse.url.md @@ -4,6 +4,8 @@ sidebar_label: HTTPResponse.url # HTTPResponse.url() method +The URL of the response. + #### Signature: ```typescript @@ -15,5 +17,3 @@ class HTTPResponse { **Returns:** string - -The URL of the response. diff --git a/docs/api/puppeteer.jshandle.aselement.md b/docs/api/puppeteer.jshandle.aselement.md index 63383a636da..c2107434c56 100644 --- a/docs/api/puppeteer.jshandle.aselement.md +++ b/docs/api/puppeteer.jshandle.aselement.md @@ -4,6 +4,8 @@ sidebar_label: JSHandle.asElement # JSHandle.asElement() method +Either `null` or the handle itself if the handle is an instance of [ElementHandle](./puppeteer.elementhandle.md). + #### Signature: ```typescript @@ -15,5 +17,3 @@ class JSHandle { **Returns:** [ElementHandle](./puppeteer.elementhandle.md)<Node> \| null - -Either `null` or the handle itself if the handle is an instance of [ElementHandle](./puppeteer.elementhandle.md). diff --git a/docs/api/puppeteer.jshandle.jsonvalue.md b/docs/api/puppeteer.jshandle.jsonvalue.md index 4e54fe9fbb5..6f33818ba28 100644 --- a/docs/api/puppeteer.jshandle.jsonvalue.md +++ b/docs/api/puppeteer.jshandle.jsonvalue.md @@ -4,6 +4,8 @@ sidebar_label: JSHandle.jsonValue # JSHandle.jsonValue() method +A vanilla object representing the serializable portions of the referenced object. + #### Signature: ```typescript @@ -16,8 +18,6 @@ class JSHandle { Promise<T> -A vanilla object representing the serializable portions of the referenced object. - ## Exceptions Throws if the object cannot be serialized due to circularity. diff --git a/docs/api/puppeteer.jshandle.md b/docs/api/puppeteer.jshandle.md index d1a49561862..1a56e5d0bc3 100644 --- a/docs/api/puppeteer.jshandle.md +++ b/docs/api/puppeteer.jshandle.md @@ -36,7 +36,7 @@ const windowHandle = await page.evaluateHandle(() => window); | Method | Modifiers | Description | | ---------------------------------------------------------------------------- | --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [asElement()](./puppeteer.jshandle.aselement.md) | | | +| [asElement()](./puppeteer.jshandle.aselement.md) | | Either null or the handle itself if the handle is an instance of [ElementHandle](./puppeteer.elementhandle.md). | | [dispose()](./puppeteer.jshandle.dispose.md) | | Releases the object referenced by the handle for garbage collection. | | [evaluate(pageFunction, args)](./puppeteer.jshandle.evaluate.md) | | Evaluates the given function with the current handle as its first argument. | | [evaluateHandle(pageFunction, args)](./puppeteer.jshandle.evaluatehandle.md) | | Evaluates the given function with the current handle as its first argument. | @@ -44,6 +44,6 @@ const windowHandle = await page.evaluateHandle(() => window); | [getProperty(propertyName)](./puppeteer.jshandle.getproperty.md) | | Fetches a single property from the referenced object. | | [getProperty(propertyName)](./puppeteer.jshandle.getproperty_1.md) | | | | [getProperty(propertyName)](./puppeteer.jshandle.getproperty_2.md) | | | -| [jsonValue()](./puppeteer.jshandle.jsonvalue.md) | | | +| [jsonValue()](./puppeteer.jshandle.jsonvalue.md) | | A vanilla object representing the serializable portions of the referenced object. | | [remoteObject()](./puppeteer.jshandle.remoteobject.md) | | Provides access to the \[Protocol.Runtime.RemoteObject\](https://chromedevtools.github.io/devtools-protocol/tot/Runtime/\#type-RemoteObject) backing this handle. | | [toString()](./puppeteer.jshandle.tostring.md) | | Returns a string representation of the JSHandle. | diff --git a/docs/api/puppeteer.page.content.md b/docs/api/puppeteer.page.content.md index d6077c132f7..fe0e11cd9cb 100644 --- a/docs/api/puppeteer.page.content.md +++ b/docs/api/puppeteer.page.content.md @@ -4,6 +4,8 @@ sidebar_label: Page.content # Page.content() method +The full HTML contents of the page, including the DOCTYPE. + #### Signature: ```typescript diff --git a/docs/api/puppeteer.page.frames.md b/docs/api/puppeteer.page.frames.md index b69c04c944f..385e465cec9 100644 --- a/docs/api/puppeteer.page.frames.md +++ b/docs/api/puppeteer.page.frames.md @@ -4,6 +4,8 @@ sidebar_label: Page.frames # Page.frames() method +An array of all frames attached to the page. + #### Signature: ```typescript @@ -15,5 +17,3 @@ class Page { **Returns:** [Frame](./puppeteer.frame.md)\[\] - -An array of all frames attached to the page. diff --git a/docs/api/puppeteer.page.getdefaulttimeout.md b/docs/api/puppeteer.page.getdefaulttimeout.md index e3820d211b1..3acaec3c042 100644 --- a/docs/api/puppeteer.page.getdefaulttimeout.md +++ b/docs/api/puppeteer.page.getdefaulttimeout.md @@ -4,6 +4,8 @@ sidebar_label: Page.getDefaultTimeout # Page.getDefaultTimeout() method +Maximum time in milliseconds. + #### Signature: ```typescript @@ -15,5 +17,3 @@ class Page { **Returns:** number - -Maximum time in milliseconds. diff --git a/docs/api/puppeteer.page.isdraginterceptionenabled.md b/docs/api/puppeteer.page.isdraginterceptionenabled.md index 0cfe3807816..ff01da1cd6f 100644 --- a/docs/api/puppeteer.page.isdraginterceptionenabled.md +++ b/docs/api/puppeteer.page.isdraginterceptionenabled.md @@ -4,6 +4,8 @@ sidebar_label: Page.isDragInterceptionEnabled # Page.isDragInterceptionEnabled() method +`true` if drag events are being intercepted, `false` otherwise. + #### Signature: ```typescript @@ -15,5 +17,3 @@ class Page { **Returns:** boolean - -`true` if drag events are being intercepted, `false` otherwise. diff --git a/docs/api/puppeteer.page.isjavascriptenabled.md b/docs/api/puppeteer.page.isjavascriptenabled.md index 87177338dd5..32ed419eb6b 100644 --- a/docs/api/puppeteer.page.isjavascriptenabled.md +++ b/docs/api/puppeteer.page.isjavascriptenabled.md @@ -4,6 +4,8 @@ sidebar_label: Page.isJavaScriptEnabled # Page.isJavaScriptEnabled() method +`true` if the page has JavaScript enabled, `false` otherwise. + #### Signature: ```typescript @@ -15,5 +17,3 @@ class Page { **Returns:** boolean - -`true` if the page has JavaScript enabled, `false` otherwise. diff --git a/docs/api/puppeteer.page.mainframe.md b/docs/api/puppeteer.page.mainframe.md index 529521d8762..383bbe5f632 100644 --- a/docs/api/puppeteer.page.mainframe.md +++ b/docs/api/puppeteer.page.mainframe.md @@ -4,6 +4,8 @@ sidebar_label: Page.mainFrame # Page.mainFrame() method +The page's main frame. + #### Signature: ```typescript @@ -16,8 +18,6 @@ class Page { [Frame](./puppeteer.frame.md) -The page's main frame. - ## Remarks Page is guaranteed to have a main frame which persists during navigations. diff --git a/docs/api/puppeteer.page.md b/docs/api/puppeteer.page.md index d0d29a9fed5..05c622b3866 100644 --- a/docs/api/puppeteer.page.md +++ b/docs/api/puppeteer.page.md @@ -91,7 +91,7 @@ page.off('request', logRequest); | [browserContext()](./puppeteer.page.browsercontext.md) | | Get the browser context that the page belongs to. | | [click(selector, options)](./puppeteer.page.click.md) | | This method fetches an element with selector, scrolls it into view if needed, and then uses [Page.mouse](./puppeteer.page.md) to click in the center of the element. If there's no element matching selector, the method throws an error. | | [close(options)](./puppeteer.page.close.md) | | | -| [content()](./puppeteer.page.content.md) | | | +| [content()](./puppeteer.page.content.md) | | The full HTML contents of the page, including the DOCTYPE. | | [cookies(urls)](./puppeteer.page.cookies.md) | | If no URLs are specified, this method returns cookies for the current page URL. If URLs are specified, only cookies for those URLs are returned. | | [createPDFStream(options)](./puppeteer.page.createpdfstream.md) | | Generates a PDF of the page with the print CSS media type. | | [deleteCookie(cookies)](./puppeteer.page.deletecookie.md) | | | @@ -108,30 +108,30 @@ page.off('request', logRequest); | [evaluateOnNewDocument(pageFunction, args)](./puppeteer.page.evaluateonnewdocument.md) | |

Adds a function which would be invoked in one of the following scenarios:

- whenever the page is navigated

- whenever the child frame is attached or navigated. In this case, the function is invoked in the context of the newly attached frame.

The function is invoked after the document was created but before any of its scripts were run. This is useful to amend the JavaScript environment, e.g. to seed Math.random.

| | [exposeFunction(name, pptrFunction)](./puppeteer.page.exposefunction.md) | |

The method adds a function called name on the page's window object. When called, the function executes puppeteerFunction in node.js and returns a Promise which resolves to the return value of puppeteerFunction.

If the puppeteerFunction returns a Promise, it will be awaited.

:::note

Functions installed via page.exposeFunction survive navigations.

:::note

| | [focus(selector)](./puppeteer.page.focus.md) | | This method fetches an element with selector and focuses it. If there's no element matching selector, the method throws an error. | -| [frames()](./puppeteer.page.frames.md) | | | -| [getDefaultTimeout()](./puppeteer.page.getdefaulttimeout.md) | | | +| [frames()](./puppeteer.page.frames.md) | | An array of all frames attached to the page. | +| [getDefaultTimeout()](./puppeteer.page.getdefaulttimeout.md) | | Maximum time in milliseconds. | | [goBack(options)](./puppeteer.page.goback.md) | | This method navigate to the previous page in history. | | [goForward(options)](./puppeteer.page.goforward.md) | | This method navigate to the next page in history. | | [goto(url, options)](./puppeteer.page.goto.md) | | | | [hover(selector)](./puppeteer.page.hover.md) | | This method fetches an element with selector, scrolls it into view if needed, and then uses [Page.mouse](./puppeteer.page.md) to hover over the center of the element. If there's no element matching selector, the method throws an error. | | [isClosed()](./puppeteer.page.isclosed.md) | | Indicates that the page has been closed. | -| [isDragInterceptionEnabled()](./puppeteer.page.isdraginterceptionenabled.md) | | | -| [isJavaScriptEnabled()](./puppeteer.page.isjavascriptenabled.md) | | | -| [mainFrame()](./puppeteer.page.mainframe.md) | | | -| [metrics()](./puppeteer.page.metrics.md) | | | +| [isDragInterceptionEnabled()](./puppeteer.page.isdraginterceptionenabled.md) | | true if drag events are being intercepted, false otherwise. | +| [isJavaScriptEnabled()](./puppeteer.page.isjavascriptenabled.md) | | true if the page has JavaScript enabled, false otherwise. | +| [mainFrame()](./puppeteer.page.mainframe.md) | | The page's main frame. | +| [metrics()](./puppeteer.page.metrics.md) | | Object containing metrics as key/value pairs. | | [off(eventName, handler)](./puppeteer.page.off.md) | | | | [on(eventName, handler)](./puppeteer.page.on.md) | |

Listen to page events.

:::note

This method exists to define event typings and handle proper wireup of cooperative request interception. Actual event listening and dispatching is delegated to [EventEmitter](./puppeteer.eventemitter.md).

:::

| | [once(eventName, handler)](./puppeteer.page.once.md) | | | | [pdf(options)](./puppeteer.page.pdf.md) | | Generates a PDF of the page with the print CSS media type. | | [queryObjects(prototypeHandle)](./puppeteer.page.queryobjects.md) | | This method iterates the JavaScript heap and finds all objects with the given prototype. | | [reload(options)](./puppeteer.page.reload.md) | | | -| [screenshot(options)](./puppeteer.page.screenshot.md) | | | +| [screenshot(options)](./puppeteer.page.screenshot.md) | | Captures screenshot of the current page. | | [screenshot(options)](./puppeteer.page.screenshot_1.md) | | | | [screenshot(options)](./puppeteer.page.screenshot_2.md) | | | | [select(selector, values)](./puppeteer.page.select.md) | | Triggers a change and input event once all the provided options have been selected. If there's no <select> element matching selector, the method throws an error. | | [setBypassCSP(enabled)](./puppeteer.page.setbypasscsp.md) | | Toggles bypassing page's Content-Security-Policy. | | [setCacheEnabled(enabled)](./puppeteer.page.setcacheenabled.md) | | Toggles ignoring cache for each request based on the enabled state. By default, caching is enabled. | -| [setContent(html, options)](./puppeteer.page.setcontent.md) | | | +| [setContent(html, options)](./puppeteer.page.setcontent.md) | | Set the content of the page. | | [setCookie(cookies)](./puppeteer.page.setcookie.md) | | | | [setDefaultNavigationTimeout(timeout)](./puppeteer.page.setdefaultnavigationtimeout.md) | |

This setting will change the default maximum navigation time for the following methods and related shortcuts:

- [page.goBack(options)](./puppeteer.page.goback.md)

- [page.goForward(options)](./puppeteer.page.goforward.md)

- [page.goto(url,options)](./puppeteer.page.goto.md)

- [page.reload(options)](./puppeteer.page.reload.md)

- [page.setContent(html,options)](./puppeteer.page.setcontent.md)

- [page.waitForNavigation(options)](./puppeteer.page.waitfornavigation.md)

| | [setDefaultTimeout(timeout)](./puppeteer.page.setdefaulttimeout.md) | | | @@ -144,11 +144,11 @@ page.off('request', logRequest); | [setUserAgent(userAgent, userAgentMetadata)](./puppeteer.page.setuseragent.md) | | | | [setViewport(viewport)](./puppeteer.page.setviewport.md) | |

page.setViewport will resize the page. A lot of websites don't expect phones to change size, so you should set the viewport before navigating to the page.

In the case of multiple pages in a single browser, each page can have its own viewport size.

| | [tap(selector)](./puppeteer.page.tap.md) | | This method fetches an element with selector, scrolls it into view if needed, and then uses [Page.touchscreen](./puppeteer.page.md) to tap in the center of the element. If there's no element matching selector, the method throws an error. | -| [target()](./puppeteer.page.target.md) | | | -| [title()](./puppeteer.page.title.md) | | | +| [target()](./puppeteer.page.target.md) | | A target this page was created from. | +| [title()](./puppeteer.page.title.md) | | The page's title | | [type(selector, text, options)](./puppeteer.page.type.md) | |

Sends a keydown, keypress/input, and keyup event for each character in the text.

To press a special key, like Control or ArrowDown, use [Keyboard.press()](./puppeteer.keyboard.press.md).

| -| [url()](./puppeteer.page.url.md) | | | -| [viewport()](./puppeteer.page.viewport.md) | | | +| [url()](./puppeteer.page.url.md) | | The page's URL. | +| [viewport()](./puppeteer.page.viewport.md) | | Current page viewport settings. | | [waitForDevicePrompt(options)](./puppeteer.page.waitfordeviceprompt.md) | |

This method is typically coupled with an action that triggers a device request from an api such as WebBluetooth.

:::caution

This must be called before the device request is made. It will not return a currently active device prompt.

:::

| | [waitForFileChooser(options)](./puppeteer.page.waitforfilechooser.md) | |

This method is typically coupled with an action that triggers file choosing.

:::caution

This must be called before the file chooser is launched. It will not return a currently active file chooser.

:::

| | [waitForFrame(urlOrPredicate, options)](./puppeteer.page.waitforframe.md) | | | @@ -160,4 +160,4 @@ page.off('request', logRequest); | [waitForSelector(selector, options)](./puppeteer.page.waitforselector.md) | | Wait for the selector to appear in page. If at the moment of calling the method the selector already exists, the method will return immediately. If the selector doesn't appear after the timeout milliseconds of waiting, the function will throw. | | [waitForTimeout(milliseconds)](./puppeteer.page.waitfortimeout.md) | | | | [waitForXPath(xpath, options)](./puppeteer.page.waitforxpath.md) | | Wait for the xpath to appear in page. If at the moment of calling the method the xpath already exists, the method will return immediately. If the xpath doesn't appear after the timeout milliseconds of waiting, the function will throw. | -| [workers()](./puppeteer.page.workers.md) | | | +| [workers()](./puppeteer.page.workers.md) | | All of the dedicated [WebWorkers](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API) associated with the page. | diff --git a/docs/api/puppeteer.page.metrics.md b/docs/api/puppeteer.page.metrics.md index 14b0e82ba3d..90c34d04218 100644 --- a/docs/api/puppeteer.page.metrics.md +++ b/docs/api/puppeteer.page.metrics.md @@ -4,6 +4,8 @@ sidebar_label: Page.metrics # Page.metrics() method +Object containing metrics as key/value pairs. + #### Signature: ```typescript @@ -16,8 +18,6 @@ class Page { Promise<[Metrics](./puppeteer.metrics.md)> -Object containing metrics as key/value pairs. - - `Timestamp` : The timestamp when the metrics sample was taken. - `Documents` : Number of documents in the page. diff --git a/docs/api/puppeteer.page.screenshot.md b/docs/api/puppeteer.page.screenshot.md index 7d4e1add903..06a4df736f5 100644 --- a/docs/api/puppeteer.page.screenshot.md +++ b/docs/api/puppeteer.page.screenshot.md @@ -4,6 +4,8 @@ sidebar_label: Page.screenshot # Page.screenshot() method +Captures screenshot of the current page. + #### Signature: ```typescript @@ -49,5 +51,3 @@ Options object which might have the following properties: - `captureBeyondViewport` : When true, captures screenshot [beyond the viewport](https://chromedevtools.github.io/devtools-protocol/tot/Page/#method-captureScreenshot). When false, falls back to old behaviour, and cuts the screenshot by the viewport size. Defaults to `true`. - `fromSurface` : When true, captures screenshot [from the surface rather than the view](https://chromedevtools.github.io/devtools-protocol/tot/Page/#method-captureScreenshot). When false, works only in headful mode and ignores page viewport (but not browser window's bounds). Defaults to `true`. - -NOTE: Screenshots take at least 1/6 second on OS X. See [https://crbug.com/741689](https://crbug.com/741689) for discussion. diff --git a/docs/api/puppeteer.page.setcontent.md b/docs/api/puppeteer.page.setcontent.md index 7fca64d554d..aacfeda921b 100644 --- a/docs/api/puppeteer.page.setcontent.md +++ b/docs/api/puppeteer.page.setcontent.md @@ -4,6 +4,8 @@ sidebar_label: Page.setContent # Page.setContent() method +Set the content of the page. + #### Signature: ```typescript diff --git a/docs/api/puppeteer.page.target.md b/docs/api/puppeteer.page.target.md index e44ade04cdc..f44a26b200f 100644 --- a/docs/api/puppeteer.page.target.md +++ b/docs/api/puppeteer.page.target.md @@ -4,6 +4,8 @@ sidebar_label: Page.target # Page.target() method +A target this page was created from. + #### Signature: ```typescript @@ -15,5 +17,3 @@ class Page { **Returns:** [Target](./puppeteer.target.md) - -A target this page was created from. diff --git a/docs/api/puppeteer.page.title.md b/docs/api/puppeteer.page.title.md index 1b58bb19c16..170cb0ad6f6 100644 --- a/docs/api/puppeteer.page.title.md +++ b/docs/api/puppeteer.page.title.md @@ -4,6 +4,8 @@ sidebar_label: Page.title # Page.title() method +The page's title + #### Signature: ```typescript @@ -16,8 +18,6 @@ class Page { Promise<string> -The page's title - ## Remarks Shortcut for [page.mainFrame().title()](./puppeteer.frame.title.md). diff --git a/docs/api/puppeteer.page.url.md b/docs/api/puppeteer.page.url.md index fd4f7fd868c..3faf8330968 100644 --- a/docs/api/puppeteer.page.url.md +++ b/docs/api/puppeteer.page.url.md @@ -4,6 +4,8 @@ sidebar_label: Page.url # Page.url() method +The page's URL. + #### Signature: ```typescript diff --git a/docs/api/puppeteer.page.viewport.md b/docs/api/puppeteer.page.viewport.md index cb37bf36b07..1162d99a00f 100644 --- a/docs/api/puppeteer.page.viewport.md +++ b/docs/api/puppeteer.page.viewport.md @@ -4,6 +4,8 @@ sidebar_label: Page.viewport # Page.viewport() method +Current page viewport settings. + #### Signature: ```typescript diff --git a/docs/api/puppeteer.page.workers.md b/docs/api/puppeteer.page.workers.md index c660032c02c..64143902414 100644 --- a/docs/api/puppeteer.page.workers.md +++ b/docs/api/puppeteer.page.workers.md @@ -4,6 +4,8 @@ sidebar_label: Page.workers # Page.workers() method +All of the dedicated [WebWorkers](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API) associated with the page. + #### Signature: ```typescript @@ -16,8 +18,6 @@ class Page { [WebWorker](./puppeteer.webworker.md)\[\] -all of the dedicated [WebWorkers](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API) associated with the page. - ## Remarks This does not contain ServiceWorkers diff --git a/docs/api/puppeteer.puppeteernode.executablepath.md b/docs/api/puppeteer.puppeteernode.executablepath.md index bea7a932b34..afa1291a601 100644 --- a/docs/api/puppeteer.puppeteernode.executablepath.md +++ b/docs/api/puppeteer.puppeteernode.executablepath.md @@ -4,6 +4,8 @@ sidebar_label: PuppeteerNode.executablePath # PuppeteerNode.executablePath() method +The default executable path. + #### Signature: ```typescript @@ -21,5 +23,3 @@ class PuppeteerNode { **Returns:** string - -The default executable path. diff --git a/docs/api/puppeteer.puppeteernode.md b/docs/api/puppeteer.puppeteernode.md index 62f72eb711c..ae6c94ed5f0 100644 --- a/docs/api/puppeteer.puppeteernode.md +++ b/docs/api/puppeteer.puppeteernode.md @@ -44,11 +44,11 @@ Once you have created a `page` you have access to a large API to interact with t ## Properties -| Property | Modifiers | Type | Description | -| ------------------- | --------------------- | --------------------------------- | ----------- | -| defaultProduct | readonly | [Product](./puppeteer.product.md) | | -| lastLaunchedProduct | readonly | [Product](./puppeteer.product.md) | | -| product | readonly | string | | +| Property | Modifiers | Type | Description | +| ------------------- | --------------------- | --------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| defaultProduct | readonly | [Product](./puppeteer.product.md) | The name of the browser that will be launched by default. For puppeteer, this is influenced by your configuration. Otherwise, it's chrome. | +| lastLaunchedProduct | readonly | [Product](./puppeteer.product.md) | The name of the browser that was last launched. | +| product | readonly | string | | ## Methods @@ -57,5 +57,5 @@ Once you have created a `page` you have access to a large API to interact with t | [connect(options)](./puppeteer.puppeteernode.connect.md) | | This method attaches Puppeteer to an existing browser instance. | | [createBrowserFetcher(options)](./puppeteer.puppeteernode.createbrowserfetcher.md) | | | | [defaultArgs(options)](./puppeteer.puppeteernode.defaultargs.md) | | | -| [executablePath(channel)](./puppeteer.puppeteernode.executablepath.md) | | | +| [executablePath(channel)](./puppeteer.puppeteernode.executablepath.md) | | The default executable path. | | [launch(options)](./puppeteer.puppeteernode.launch.md) | |

Launches a browser instance with given arguments and options when specified.

When using with puppeteer-core, [options.executablePath](./puppeteer.launchoptions.md) or [options.channel](./puppeteer.launchoptions.md) must be provided.

| diff --git a/docs/api/puppeteer.securitydetails.issuer.md b/docs/api/puppeteer.securitydetails.issuer.md index a7bb3fded73..b82835a844f 100644 --- a/docs/api/puppeteer.securitydetails.issuer.md +++ b/docs/api/puppeteer.securitydetails.issuer.md @@ -4,6 +4,8 @@ sidebar_label: SecurityDetails.issuer # SecurityDetails.issuer() method +The name of the issuer of the certificate. + #### Signature: ```typescript @@ -15,5 +17,3 @@ class SecurityDetails { **Returns:** string - -The name of the issuer of the certificate. diff --git a/docs/api/puppeteer.securitydetails.md b/docs/api/puppeteer.securitydetails.md index db50be39adb..1c9fa17deb2 100644 --- a/docs/api/puppeteer.securitydetails.md +++ b/docs/api/puppeteer.securitydetails.md @@ -18,11 +18,11 @@ The constructor for this class is marked as internal. Third-party code should no ## Methods -| Method | Modifiers | Description | -| ----------------------------------------------------------------------------------- | --------- | ----------- | -| [issuer()](./puppeteer.securitydetails.issuer.md) | | | -| [protocol()](./puppeteer.securitydetails.protocol.md) | | | -| [subjectAlternativeNames()](./puppeteer.securitydetails.subjectalternativenames.md) | | | -| [subjectName()](./puppeteer.securitydetails.subjectname.md) | | | -| [validFrom()](./puppeteer.securitydetails.validfrom.md) | | | -| [validTo()](./puppeteer.securitydetails.validto.md) | | | +| Method | Modifiers | Description | +| ----------------------------------------------------------------------------------- | --------- | -------------------------------------------------------------------------------------------------------------------------- | +| [issuer()](./puppeteer.securitydetails.issuer.md) | | The name of the issuer of the certificate. | +| [protocol()](./puppeteer.securitydetails.protocol.md) | | The security protocol being used, e.g. "TLS 1.2". | +| [subjectAlternativeNames()](./puppeteer.securitydetails.subjectalternativenames.md) | | The list of [subject alternative names (SANs)](https://en.wikipedia.org/wiki/Subject_Alternative_Name) of the certificate. | +| [subjectName()](./puppeteer.securitydetails.subjectname.md) | | The name of the subject to which the certificate was issued. | +| [validFrom()](./puppeteer.securitydetails.validfrom.md) | | [Unix timestamp](https://en.wikipedia.org/wiki/Unix_time) marking the start of the certificate's validity. | +| [validTo()](./puppeteer.securitydetails.validto.md) | | [Unix timestamp](https://en.wikipedia.org/wiki/Unix_time) marking the end of the certificate's validity. | diff --git a/docs/api/puppeteer.securitydetails.protocol.md b/docs/api/puppeteer.securitydetails.protocol.md index d6a7b735e29..421a82e20a4 100644 --- a/docs/api/puppeteer.securitydetails.protocol.md +++ b/docs/api/puppeteer.securitydetails.protocol.md @@ -4,6 +4,8 @@ sidebar_label: SecurityDetails.protocol # SecurityDetails.protocol() method +The security protocol being used, e.g. "TLS 1.2". + #### Signature: ```typescript @@ -15,5 +17,3 @@ class SecurityDetails { **Returns:** string - -The security protocol being used, e.g. "TLS 1.2". diff --git a/docs/api/puppeteer.securitydetails.subjectalternativenames.md b/docs/api/puppeteer.securitydetails.subjectalternativenames.md index 926991082c0..448651fd581 100644 --- a/docs/api/puppeteer.securitydetails.subjectalternativenames.md +++ b/docs/api/puppeteer.securitydetails.subjectalternativenames.md @@ -4,6 +4,8 @@ sidebar_label: SecurityDetails.subjectAlternativeNames # SecurityDetails.subjectAlternativeNames() method +The list of [subject alternative names (SANs)](https://en.wikipedia.org/wiki/Subject_Alternative_Name) of the certificate. + #### Signature: ```typescript @@ -15,5 +17,3 @@ class SecurityDetails { **Returns:** string\[\] - -The list of [subject alternative names (SANs)](https://en.wikipedia.org/wiki/Subject_Alternative_Name) of the certificate. diff --git a/docs/api/puppeteer.securitydetails.subjectname.md b/docs/api/puppeteer.securitydetails.subjectname.md index 0727f2dbb08..211c67bc029 100644 --- a/docs/api/puppeteer.securitydetails.subjectname.md +++ b/docs/api/puppeteer.securitydetails.subjectname.md @@ -4,6 +4,8 @@ sidebar_label: SecurityDetails.subjectName # SecurityDetails.subjectName() method +The name of the subject to which the certificate was issued. + #### Signature: ```typescript @@ -15,5 +17,3 @@ class SecurityDetails { **Returns:** string - -The name of the subject to which the certificate was issued. diff --git a/docs/api/puppeteer.securitydetails.validfrom.md b/docs/api/puppeteer.securitydetails.validfrom.md index 7bd6d81ad7b..e42cb0c0072 100644 --- a/docs/api/puppeteer.securitydetails.validfrom.md +++ b/docs/api/puppeteer.securitydetails.validfrom.md @@ -4,6 +4,8 @@ sidebar_label: SecurityDetails.validFrom # SecurityDetails.validFrom() method +[Unix timestamp](https://en.wikipedia.org/wiki/Unix_time) marking the start of the certificate's validity. + #### Signature: ```typescript @@ -15,5 +17,3 @@ class SecurityDetails { **Returns:** number - -[Unix timestamp](https://en.wikipedia.org/wiki/Unix_time) marking the start of the certificate's validity. diff --git a/docs/api/puppeteer.securitydetails.validto.md b/docs/api/puppeteer.securitydetails.validto.md index 85629da76a7..e1710b1a64d 100644 --- a/docs/api/puppeteer.securitydetails.validto.md +++ b/docs/api/puppeteer.securitydetails.validto.md @@ -4,6 +4,8 @@ sidebar_label: SecurityDetails.validTo # SecurityDetails.validTo() method +[Unix timestamp](https://en.wikipedia.org/wiki/Unix_time) marking the end of the certificate's validity. + #### Signature: ```typescript @@ -15,5 +17,3 @@ class SecurityDetails { **Returns:** number - -[Unix timestamp](https://en.wikipedia.org/wiki/Unix_time) marking the end of the certificate's validity. diff --git a/docs/api/puppeteer.webworker.md b/docs/api/puppeteer.webworker.md index 5662bc435fd..d0f683ffae9 100644 --- a/docs/api/puppeteer.webworker.md +++ b/docs/api/puppeteer.webworker.md @@ -42,4 +42,4 @@ for (const worker of page.workers()) { | ----------------------------------------------------------------------------- | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [evaluate(pageFunction, args)](./puppeteer.webworker.evaluate.md) | | If the function passed to the worker.evaluate returns a Promise, then worker.evaluate would wait for the promise to resolve and return its value. If the function passed to the worker.evaluate returns a non-serializable value, then worker.evaluate resolves to undefined. DevTools Protocol also supports transferring some additional values that are not serializable by JSON: -0, NaN, Infinity, -Infinity, and bigint literals. Shortcut for await worker.executionContext()).evaluate(pageFunction, ...args). | | [evaluateHandle(pageFunction, args)](./puppeteer.webworker.evaluatehandle.md) | | The only difference between worker.evaluate and worker.evaluateHandle is that worker.evaluateHandle returns in-page object (JSHandle). If the function passed to the worker.evaluateHandle returns a Promise, then worker.evaluateHandle would wait for the promise to resolve and return its value. Shortcut for await worker.executionContext()).evaluateHandle(pageFunction, ...args) | -| [url()](./puppeteer.webworker.url.md) | | | +| [url()](./puppeteer.webworker.url.md) | | The URL of this web worker. | diff --git a/docs/api/puppeteer.webworker.url.md b/docs/api/puppeteer.webworker.url.md index a8a09c6a94c..8893c385dca 100644 --- a/docs/api/puppeteer.webworker.url.md +++ b/docs/api/puppeteer.webworker.url.md @@ -4,6 +4,8 @@ sidebar_label: WebWorker.url # WebWorker.url() method +The URL of this web worker. + #### Signature: ```typescript @@ -15,5 +17,3 @@ class WebWorker { **Returns:** string - -The URL of this web worker. diff --git a/packages/puppeteer-core/src/api/HTTPRequest.ts b/packages/puppeteer-core/src/api/HTTPRequest.ts index 9e3c1b2454f..fb16cc7b005 100644 --- a/packages/puppeteer-core/src/api/HTTPRequest.ts +++ b/packages/puppeteer-core/src/api/HTTPRequest.ts @@ -142,14 +142,14 @@ export class HTTPRequest { constructor() {} /** - * @returns the URL of the request + * The URL of the request */ url(): string { throw new Error('Not implemented'); } /** - * @returns the `ContinueRequestOverrides` that will be used + * The `ContinueRequestOverrides` that will be used * if the interception is allowed to continue (ie, `abort()` and * `respond()` aren't called). */ @@ -158,7 +158,7 @@ export class HTTPRequest { } /** - * @returns The `ResponseForRequest` that gets used if the + * The `ResponseForRequest` that gets used if the * interception is allowed to respond (ie, `abort()` is not called). */ responseForRequest(): Partial | null { @@ -166,14 +166,14 @@ export class HTTPRequest { } /** - * @returns the most recent reason for aborting the request + * The most recent reason for aborting the request */ abortErrorReason(): Protocol.Network.ErrorReason | null { throw new Error('Not implemented'); } /** - * @returns An InterceptResolutionState object describing the current resolution + * An InterceptResolutionState object describing the current resolution * action and priority. * * InterceptResolutionState contains: @@ -188,7 +188,7 @@ export class HTTPRequest { } /** - * @returns `true` if the intercept resolution has already been handled, + * Is `true` if the intercept resolution has already been handled, * `false` otherwise. */ isInterceptResolutionHandled(): boolean { @@ -225,21 +225,21 @@ export class HTTPRequest { } /** - * @returns the method used (`GET`, `POST`, etc.) + * The method used (`GET`, `POST`, etc.) */ method(): string { throw new Error('Not implemented'); } /** - * @returns the request's post body, if any. + * The request's post body, if any. */ postData(): string | undefined { throw new Error('Not implemented'); } /** - * @returns an object with HTTP headers associated with the request. All + * An object with HTTP headers associated with the request. All * header names are lower-case. */ headers(): Record { @@ -247,7 +247,7 @@ export class HTTPRequest { } /** - * @returns A matching `HTTPResponse` object, or null if the response has not + * A matching `HTTPResponse` object, or null if the response has not * been received yet. */ response(): HTTPResponse | null { @@ -255,7 +255,7 @@ export class HTTPRequest { } /** - * @returns the frame that initiated the request, or null if navigating to + * The frame that initiated the request, or null if navigating to * error pages. */ frame(): Frame | null { @@ -263,14 +263,14 @@ export class HTTPRequest { } /** - * @returns true if the request is the driver of the current frame's navigation. + * True if the request is the driver of the current frame's navigation. */ isNavigationRequest(): boolean { throw new Error('Not implemented'); } /** - * @returns the initiator of the request. + * The initiator of the request. */ initiator(): Protocol.Network.Initiator { throw new Error('Not implemented'); diff --git a/packages/puppeteer-core/src/api/HTTPResponse.ts b/packages/puppeteer-core/src/api/HTTPResponse.ts index 00422e42826..ddc56279a47 100644 --- a/packages/puppeteer-core/src/api/HTTPResponse.ts +++ b/packages/puppeteer-core/src/api/HTTPResponse.ts @@ -49,7 +49,7 @@ export class HTTPResponse { } /** - * @returns The IP address and port number used to connect to the remote + * The IP address and port number used to connect to the remote * server. */ remoteAddress(): RemoteAddress { @@ -57,28 +57,28 @@ export class HTTPResponse { } /** - * @returns The URL of the response. + * The URL of the response. */ url(): string { throw new Error('Not implemented'); } /** - * @returns True if the response was successful (status in the range 200-299). + * True if the response was successful (status in the range 200-299). */ ok(): boolean { throw new Error('Not implemented'); } /** - * @returns The status code of the response (e.g., 200 for a success). + * The status code of the response (e.g., 200 for a success). */ status(): number { throw new Error('Not implemented'); } /** - * @returns The status text of the response (e.g. usually an "OK" for a + * The status text of the response (e.g. usually an "OK" for a * success). */ statusText(): string { @@ -86,7 +86,7 @@ export class HTTPResponse { } /** - * @returns An object with HTTP headers associated with the response. All + * An object with HTTP headers associated with the response. All * header names are lower-case. */ headers(): Record { @@ -94,7 +94,7 @@ export class HTTPResponse { } /** - * @returns {@link SecurityDetails} if the response was received over the + * {@link SecurityDetails} if the response was received over the * secure connection, or `null` otherwise. */ securityDetails(): SecurityDetails | null { @@ -102,21 +102,21 @@ export class HTTPResponse { } /** - * @returns Timing information related to the response. + * Timing information related to the response. */ timing(): Protocol.Network.ResourceTiming | null { throw new Error('Not implemented'); } /** - * @returns Promise which resolves to a buffer with response body. + * Promise which resolves to a buffer with response body. */ buffer(): Promise { throw new Error('Not implemented'); } /** - * @returns Promise which resolves to a text representation of response body. + * Promise which resolves to a text representation of response body. */ async text(): Promise { const content = await this.buffer(); @@ -124,8 +124,7 @@ export class HTTPResponse { } /** - * - * @returns Promise which resolves to a JSON representation of response body. + * Promise which resolves to a JSON representation of response body. * * @remarks * @@ -138,14 +137,14 @@ export class HTTPResponse { } /** - * @returns A matching {@link HTTPRequest} object. + * A matching {@link HTTPRequest} object. */ request(): HTTPRequest { throw new Error('Not implemented'); } /** - * @returns True if the response was served from either the browser's disk + * True if the response was served from either the browser's disk * cache or memory cache. */ fromCache(): boolean { @@ -153,14 +152,14 @@ export class HTTPResponse { } /** - * @returns True if the response was served by a service worker. + * True if the response was served by a service worker. */ fromServiceWorker(): boolean { throw new Error('Not implemented'); } /** - * @returns A {@link Frame} that initiated this response, or `null` if + * A {@link Frame} that initiated this response, or `null` if * navigating to error pages. */ frame(): Frame | null { diff --git a/packages/puppeteer-core/src/api/JSHandle.ts b/packages/puppeteer-core/src/api/JSHandle.ts index a94c1ca28eb..1092837b589 100644 --- a/packages/puppeteer-core/src/api/JSHandle.ts +++ b/packages/puppeteer-core/src/api/JSHandle.ts @@ -143,7 +143,7 @@ export class JSHandle { } /** - * @returns A vanilla object representing the serializable portions of the + * A vanilla object representing the serializable portions of the * referenced object. * @throws Throws if the object cannot be serialized due to circularity. * @@ -155,7 +155,7 @@ export class JSHandle { } /** - * @returns Either `null` or the handle itself if the handle is an + * Either `null` or the handle itself if the handle is an * instance of {@link ElementHandle}. */ asElement(): ElementHandle | null { diff --git a/packages/puppeteer-core/src/api/Page.ts b/packages/puppeteer-core/src/api/Page.ts index 9d8f5549e5b..d363fbf4ce9 100644 --- a/packages/puppeteer-core/src/api/Page.ts +++ b/packages/puppeteer-core/src/api/Page.ts @@ -450,14 +450,14 @@ export class Page extends EventEmitter { } /** - * @returns `true` if drag events are being intercepted, `false` otherwise. + * `true` if drag events are being intercepted, `false` otherwise. */ isDragInterceptionEnabled(): boolean { throw new Error('Not implemented'); } /** - * @returns `true` if the page has JavaScript enabled, `false` otherwise. + * `true` if the page has JavaScript enabled, `false` otherwise. */ isJavaScriptEnabled(): boolean { throw new Error('Not implemented'); @@ -566,7 +566,7 @@ export class Page extends EventEmitter { } /** - * @returns A target this page was created from. + * A target this page was created from. */ target(): Target { throw new Error('Not implemented'); @@ -587,7 +587,7 @@ export class Page extends EventEmitter { } /** - * @returns The page's main frame. + * The page's main frame. * * @remarks * Page is guaranteed to have a main frame which persists during navigations. @@ -632,14 +632,14 @@ export class Page extends EventEmitter { } /** - * @returns An array of all frames attached to the page. + * An array of all frames attached to the page. */ frames(): Frame[] { throw new Error('Not implemented'); } /** - * @returns all of the dedicated {@link + * All of the dedicated {@link * https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API | * WebWorkers} associated with the page. * @@ -781,7 +781,7 @@ export class Page extends EventEmitter { } /** - * @returns Maximum time in milliseconds. + * Maximum time in milliseconds. */ getDefaultTimeout(): number { throw new Error('Not implemented'); @@ -1292,7 +1292,9 @@ export class Page extends EventEmitter { } /** - * @returns Object containing metrics as key/value pairs. + * Object containing metrics as key/value pairs. + * + * @returns * * - `Timestamp` : The timestamp when the metrics sample was taken. * @@ -1330,8 +1332,7 @@ export class Page extends EventEmitter { } /** - * - * @returns + * The page's URL. * @remarks Shortcut for * {@link Frame.url | page.mainFrame().url()}. */ @@ -1339,11 +1340,16 @@ export class Page extends EventEmitter { throw new Error('Not implemented'); } + /** + * The full HTML contents of the page, including the DOCTYPE. + */ async content(): Promise { throw new Error('Not implemented'); } /** + * Set the content of the page. + * * @param html - HTML markup to assign to the page. * @param options - Parameters that has some properties. * @remarks @@ -1963,6 +1969,8 @@ export class Page extends EventEmitter { } /** + * Current page viewport settings. + * * @returns * * - `width`: page's width in pixels @@ -2123,6 +2131,8 @@ export class Page extends EventEmitter { } /** + * Captures screenshot of the current page. + * * @remarks * Options object which might have the following properties: * @@ -2166,8 +2176,6 @@ export class Page extends EventEmitter { * headful mode and ignores page viewport (but not browser window's * bounds). Defaults to `true`. * - * NOTE: Screenshots take at least 1/6 second on OS X. See - * {@link https://crbug.com/741689} for discussion. * @returns Promise which resolves to buffer or a base64 string (depending on * the value of `encoding`) with captured screenshot. */ @@ -2266,7 +2274,8 @@ export class Page extends EventEmitter { } /** - * @returns The page's title + * The page's title + * * @remarks * Shortcut for {@link Frame.title | page.mainFrame().title()}. */ diff --git a/packages/puppeteer-core/src/common/ChromeTargetManager.ts b/packages/puppeteer-core/src/common/ChromeTargetManager.ts index 85e14c302a9..4ba515e48ff 100644 --- a/packages/puppeteer-core/src/common/ChromeTargetManager.ts +++ b/packages/puppeteer-core/src/common/ChromeTargetManager.ts @@ -57,7 +57,6 @@ export class ChromeTargetManager extends EventEmitter implements TargetManager { */ #attachedTargetsByTargetId: Map = new Map(); /** - * * Tracks which sessions attach to which target. */ #attachedTargetsBySessionId: Map = new Map(); diff --git a/packages/puppeteer-core/src/common/ConsoleMessage.ts b/packages/puppeteer-core/src/common/ConsoleMessage.ts index 06678382b3c..9e911c81499 100644 --- a/packages/puppeteer-core/src/common/ConsoleMessage.ts +++ b/packages/puppeteer-core/src/common/ConsoleMessage.ts @@ -87,35 +87,35 @@ export class ConsoleMessage { } /** - * @returns The type of the console message. + * The type of the console message. */ type(): ConsoleMessageType { return this.#type; } /** - * @returns The text of the console message. + * The text of the console message. */ text(): string { return this.#text; } /** - * @returns An array of arguments passed to the console. + * An array of arguments passed to the console. */ args(): JSHandle[] { return this.#args; } /** - * @returns The location of the console message. + * The location of the console message. */ location(): ConsoleMessageLocation { return this.#stackTraceLocations[0] ?? {}; } /** - * @returns The array of locations on the stack of the console message. + * The array of locations on the stack of the console message. */ stackTrace(): ConsoleMessageLocation[] { return this.#stackTraceLocations; diff --git a/packages/puppeteer-core/src/common/Coverage.ts b/packages/puppeteer-core/src/common/Coverage.ts index 0ab65ad9b32..27103f90166 100644 --- a/packages/puppeteer-core/src/common/Coverage.ts +++ b/packages/puppeteer-core/src/common/Coverage.ts @@ -158,7 +158,7 @@ export class Coverage { } /** - * @returns Promise that resolves to the array of coverage reports for + * Promise that resolves to the array of coverage reports for * all scripts. * * @remarks @@ -179,8 +179,9 @@ export class Coverage { } /** - * @returns Promise that resolves to the array of coverage reports + * Promise that resolves to the array of coverage reports * for all stylesheets. + * * @remarks * CSS Coverage doesn't include dynamically injected style tags * without sourceURLs. diff --git a/packages/puppeteer-core/src/common/CustomQueryHandler.ts b/packages/puppeteer-core/src/common/CustomQueryHandler.ts index 699006a01a6..89ae0ca0a2c 100644 --- a/packages/puppeteer-core/src/common/CustomQueryHandler.ts +++ b/packages/puppeteer-core/src/common/CustomQueryHandler.ts @@ -26,11 +26,11 @@ import {scriptInjector} from './ScriptInjector.js'; */ export interface CustomQueryHandler { /** - * @returns A {@link https://developer.mozilla.org/en-US/docs/Web/API/Node | Node} matching the given `selector` from {@link https://developer.mozilla.org/en-US/docs/Web/API/Node | node}. + * Searches for a {@link https://developer.mozilla.org/en-US/docs/Web/API/Node | Node} matching the given `selector` from {@link https://developer.mozilla.org/en-US/docs/Web/API/Node | node}. */ queryOne?: (node: Node, selector: string) => Node | null; /** - * @returns Some {@link https://developer.mozilla.org/en-US/docs/Web/API/Node | Nodes} matching the given `selector` from {@link https://developer.mozilla.org/en-US/docs/Web/API/Node | node}. + * Searches for some {@link https://developer.mozilla.org/en-US/docs/Web/API/Node | Nodes} matching the given `selector` from {@link https://developer.mozilla.org/en-US/docs/Web/API/Node | node}. */ queryAll?: (node: Node, selector: string) => Iterable; } diff --git a/packages/puppeteer-core/src/common/Dialog.ts b/packages/puppeteer-core/src/common/Dialog.ts index bc1c1d4a820..5ccc5e1bac7 100644 --- a/packages/puppeteer-core/src/common/Dialog.ts +++ b/packages/puppeteer-core/src/common/Dialog.ts @@ -67,21 +67,21 @@ export class Dialog { } /** - * @returns The type of the dialog. + * The type of the dialog. */ type(): Protocol.Page.DialogType { return this.#type; } /** - * @returns The message displayed in the dialog. + * The message displayed in the dialog. */ message(): string { return this.#message; } /** - * @returns The default value of the prompt, or an empty string if the dialog + * The default value of the prompt, or an empty string if the dialog * is not a `prompt`. */ defaultValue(): string { @@ -89,10 +89,11 @@ export class Dialog { } /** + * A promise that resolves when the dialog has been accepted. + * * @param promptText - optional text that will be entered in the dialog * prompt. Has no effect if the dialog's type is not `prompt`. * - * @returns A promise that resolves when the dialog has been accepted. */ async accept(promptText?: string): Promise { assert(!this.#handled, 'Cannot accept dialog which is already handled!'); @@ -104,7 +105,7 @@ export class Dialog { } /** - * @returns A promise which will resolve once the dialog has been dismissed + * A promise which will resolve once the dialog has been dismissed */ async dismiss(): Promise { assert(!this.#handled, 'Cannot dismiss dialog which is already handled!'); diff --git a/packages/puppeteer-core/src/common/Frame.ts b/packages/puppeteer-core/src/common/Frame.ts index 158977d5cdf..e3125eb5c11 100644 --- a/packages/puppeteer-core/src/common/Frame.ts +++ b/packages/puppeteer-core/src/common/Frame.ts @@ -241,14 +241,14 @@ export class Frame { } /** - * @returns The page associated with the frame. + * The page associated with the frame. */ page(): Page { return this._frameManager.page(); } /** - * @returns `true` if the frame is an out-of-process (OOP) frame. Otherwise, + * Is `true` if the frame is an out-of-process (OOP) frame. Otherwise, * `false`. */ isOOPFrame(): boolean { @@ -714,7 +714,7 @@ export class Frame { } /** - * @returns The full HTML contents of the frame, including the DOCTYPE. + * The full HTML contents of the frame, including the DOCTYPE. */ async content(): Promise { return this.worlds[PUPPETEER_WORLD].content(); @@ -738,7 +738,7 @@ export class Frame { } /** - * @returns The frame's `name` attribute as specified in the tag. + * The frame's `name` attribute as specified in the tag. * * @remarks * If the name is empty, it returns the `id` attribute instead. @@ -752,28 +752,28 @@ export class Frame { } /** - * @returns The frame's URL. + * The frame's URL. */ url(): string { return this.#url; } /** - * @returns The parent frame, if any. Detached and main frames return `null`. + * The parent frame, if any. Detached and main frames return `null`. */ parentFrame(): Frame | null { return this._frameManager._frameTree.parentFrame(this._id) || null; } /** - * @returns An array of child frames. + * An array of child frames. */ childFrames(): Frame[] { return this._frameManager._frameTree.childFrames(this._id); } /** - * @returns `true` if the frame has been detached. Otherwise, `false`. + * Is`true` if the frame has been detached. Otherwise, `false`. */ isDetached(): boolean { return this.#detached; @@ -1082,7 +1082,7 @@ export class Frame { } /** - * @returns the frame's title. + * The frame's title. */ async title(): Promise { return this.worlds[PUPPETEER_WORLD].title(); diff --git a/packages/puppeteer-core/src/common/JSHandle.ts b/packages/puppeteer-core/src/common/JSHandle.ts index 1e405916221..e755e9344cb 100644 --- a/packages/puppeteer-core/src/common/JSHandle.ts +++ b/packages/puppeteer-core/src/common/JSHandle.ts @@ -135,7 +135,7 @@ export class CDPJSHandle extends JSHandle { } /** - * @returns Either `null` or the handle itself if the handle is an + * Either `null` or the handle itself if the handle is an * instance of {@link ElementHandle}. */ override asElement(): CDPElementHandle | null { diff --git a/packages/puppeteer-core/src/common/SecurityDetails.ts b/packages/puppeteer-core/src/common/SecurityDetails.ts index 7df6aef88ab..4dbb71046e7 100644 --- a/packages/puppeteer-core/src/common/SecurityDetails.ts +++ b/packages/puppeteer-core/src/common/SecurityDetails.ts @@ -43,14 +43,14 @@ export class SecurityDetails { } /** - * @returns The name of the issuer of the certificate. + * The name of the issuer of the certificate. */ issuer(): string { return this.#issuer; } /** - * @returns {@link https://en.wikipedia.org/wiki/Unix_time | Unix timestamp} + * {@link https://en.wikipedia.org/wiki/Unix_time | Unix timestamp} * marking the start of the certificate's validity. */ validFrom(): number { @@ -58,7 +58,7 @@ export class SecurityDetails { } /** - * @returns {@link https://en.wikipedia.org/wiki/Unix_time | Unix timestamp} + * {@link https://en.wikipedia.org/wiki/Unix_time | Unix timestamp} * marking the end of the certificate's validity. */ validTo(): number { @@ -66,21 +66,21 @@ export class SecurityDetails { } /** - * @returns The security protocol being used, e.g. "TLS 1.2". + * The security protocol being used, e.g. "TLS 1.2". */ protocol(): string { return this.#protocol; } /** - * @returns The name of the subject to which the certificate was issued. + * The name of the subject to which the certificate was issued. */ subjectName(): string { return this.#subjectName; } /** - * @returns The list of {@link https://en.wikipedia.org/wiki/Subject_Alternative_Name | subject alternative names (SANs)} of the certificate. + * The list of {@link https://en.wikipedia.org/wiki/Subject_Alternative_Name | subject alternative names (SANs)} of the certificate. */ subjectAlternativeNames(): string[] { return this.#sanList; diff --git a/packages/puppeteer-core/src/common/WebWorker.ts b/packages/puppeteer-core/src/common/WebWorker.ts index 9594e52fe53..d4265741e55 100644 --- a/packages/puppeteer-core/src/common/WebWorker.ts +++ b/packages/puppeteer-core/src/common/WebWorker.ts @@ -116,7 +116,7 @@ export class WebWorker extends EventEmitter { } /** - * @returns The URL of this web worker. + * The URL of this web worker. */ url(): string { return this.#url; diff --git a/packages/puppeteer-core/src/node/BrowserFetcher.ts b/packages/puppeteer-core/src/node/BrowserFetcher.ts index d7ef162dee9..6ea3be20fbe 100644 --- a/packages/puppeteer-core/src/node/BrowserFetcher.ts +++ b/packages/puppeteer-core/src/node/BrowserFetcher.ts @@ -272,7 +272,7 @@ export class BrowserFetcher { } /** - * @returns Returns the current `Platform`, which is one of `mac`, `linux`, + * Returns the current `Platform`, which is one of `mac`, `linux`, * `win32` or `win64`. */ platform(): Platform { @@ -280,7 +280,7 @@ export class BrowserFetcher { } /** - * @returns Returns the current `Product`, which is one of `chrome` or + * Returns the current `Product`, which is one of `chrome` or * `firefox`. */ product(): Product { @@ -288,7 +288,7 @@ export class BrowserFetcher { } /** - * @returns The download host being used. + * The download host being used. */ host(): string { return this.#downloadHost; diff --git a/packages/puppeteer-core/src/node/LaunchOptions.ts b/packages/puppeteer-core/src/node/LaunchOptions.ts index 5351a517979..cc14fac9118 100644 --- a/packages/puppeteer-core/src/node/LaunchOptions.ts +++ b/packages/puppeteer-core/src/node/LaunchOptions.ts @@ -41,7 +41,7 @@ export interface BrowserLaunchArgumentOptions { */ devtools?: boolean; /** - * + * Specify the debugging port number to use */ debuggingPort?: number; /** diff --git a/packages/puppeteer-core/src/node/PuppeteerNode.ts b/packages/puppeteer-core/src/node/PuppeteerNode.ts index 4ad9e9beee7..fb61161c92b 100644 --- a/packages/puppeteer-core/src/node/PuppeteerNode.ts +++ b/packages/puppeteer-core/src/node/PuppeteerNode.ts @@ -132,8 +132,6 @@ export class PuppeteerNode extends Puppeteer { * * @param options - Set of configurable options to set on the browser. * @returns Promise which resolves to browser instance. - * - * @public */ override connect(options: ConnectOptions): Promise { return super.connect(options); @@ -172,8 +170,6 @@ export class PuppeteerNode extends Puppeteer { * describes some differences for Linux users. * * @param options - Options to configure launching behavior. - * - * @public */ launch(options: PuppeteerLaunchOptions = {}): Promise { const {product = this.defaultProduct} = options; @@ -207,9 +203,7 @@ export class PuppeteerNode extends Puppeteer { } /** - * @returns The default executable path. - * - * @public + * The default executable path. */ executablePath(channel?: ChromeReleaseChannel): string { return this.#launcher.executablePath(channel); @@ -227,7 +221,7 @@ export class PuppeteerNode extends Puppeteer { } /** - * @returns The default download path for puppeteer. For puppeteer-core, this + * The default download path for puppeteer. For puppeteer-core, this * code should never be called as it is never defined. * * @internal @@ -240,20 +234,16 @@ export class PuppeteerNode extends Puppeteer { } /** - * @returns The name of the browser that was last launched. - * - * @public + * The name of the browser that was last launched. */ get lastLaunchedProduct(): Product { return this.#lastLaunchedProduct ?? this.defaultProduct; } /** - * @returns The name of the browser that will be launched by default. For + * The name of the browser that will be launched by default. For * `puppeteer`, this is influenced by your configuration. Otherwise, it's * `chrome`. - * - * @public */ get defaultProduct(): Product { return this.configuration.defaultProduct ?? 'chrome'; @@ -266,8 +256,6 @@ export class PuppeteerNode extends Puppeteer { * {@link PuppeteerNode.lastLaunchedProduct | lastLaunchedProduct}. * * @returns The name of the browser that is under automation. - * - * @public */ get product(): string { return this.#launcher.product; @@ -277,8 +265,6 @@ export class PuppeteerNode extends Puppeteer { * @param options - Set of configurable options to set on the browser. * * @returns The default flags that Chromium will be launched with. - * - * @public */ defaultArgs(options: BrowserLaunchArgumentOptions = {}): string[] { return this.#launcher.defaultArgs(options);