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

docs: Upgrading to Docusaurus V3 (#11434)

Browse Source 
Co-authored-by: Alex Rudenko <alexrudenko@chromium.org>
This commit is contained in:
Miki Lombardi 2023-11-29 13:06:05 +01:00 committed by Alex Rudenko
parent f67ee9fea7
commit 39e3d4bceb
56 changed files with 6182 additions and 12940 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -12,6 +12,6 @@ export interface AutofillData
## Properties
| Property | Modifiers | Type | Description | Default |
| ---------- | --------- | --------------------------------------------------------------------------------------- | ----------- | ------- |
| creditCard | | { number: string; name: string; expiryMonth: string; expiryYear: string; cvc: string; } | | |
| Property | Modifiers | Type | Description | Default |
| ---------- | --------- | ------------------------------------------------------------------------------------------------- | ----------- | ------- |
| creditCard | | &#123; number: string; name: string; expiryMonth: string; expiryYear: string; cvc: string; &#125; | | |

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

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

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

@ -14,8 +14,8 @@ export interface CoverageEntry
## Properties
| Property | Modifiers | Type | Description | Default |
| -------- | --------- | -------------------------------------------- | --------------------------------------------- | ------- |
| ranges | | Array&lt;{ start: number; end: number; }&gt; | The covered range as start and end positions. | |
| text | | string | The content of the style sheet or script. | |
| url | | string | The URL of the style sheet or script. | |
| Property | Modifiers | Type | Description | Default |
| -------- | --------- | ------------------------------------------------------ | --------------------------------------------- | ------- |
| ranges | | Array&lt;&#123; start: number; end: number; &#125;&gt; | The covered range as start and end positions. | |
| text | | string | The content of the style sheet or script. | |
| url | | string | The URL of the style sheet or script. | |

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

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

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

@ -28,7 +28,7 @@ class ElementHandle {
| --------- | ------------------------------------------------------------ | ------------ |
| this | [ElementHandle](./puppeteer.elementhandle.md)&lt;Element&gt; | |
| target | [ElementHandle](./puppeteer.elementhandle.md)&lt;Node&gt; | |
| options | { delay: number; } | _(Optional)_ |
| options | &#123; delay: number; &#125; | _(Optional)_ |
**Returns:**

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

@ -24,7 +24,7 @@ class ElementHandle {
| Parameter | Type | Description |
| --------- | ------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------- |
| this | [ElementHandle](./puppeteer.elementhandle.md)&lt;Element&gt; | |
| options | { threshold?: number; } | _(Optional)_ Threshold for the intersection between 0 (no intersection) and 1 (full intersection). Defaults to 1. |
| options | &#123; threshold?: number; &#125; | _(Optional)_ Threshold for the intersection between 0 (no intersection) and 1 (full intersection). Defaults to 1. |
**Returns:**

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

@ -20,9 +20,9 @@ class ElementHandle {
## Parameters
| Parameter | Type | Description |
| --------- | --------------------------------------------------------------------------------------------------- | ----------- |
| options | Readonly&lt;[ScreenshotOptions](./puppeteer.screenshotoptions.md)&gt; &amp; { encoding: 'base64'; } | |
| Parameter | Type | Description |
| --------- | ------------------------------------------------------------------------------------------------------------- | ----------- |
| options | Readonly&lt;[ScreenshotOptions](./puppeteer.screenshotoptions.md)&gt; &amp; &#123; encoding: 'base64'; &#125; | |
**Returns:**

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

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

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

@ -24,10 +24,10 @@ class Frame {
## Parameters
| Parameter | Type | Description |
| --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------- |
| url | string | URL to navigate the frame to. The URL should include scheme, e.g. <code>https://</code> |
| options | { referer?: string; referrerPolicy?: string; timeout?: number; waitUntil?: [PuppeteerLifeCycleEvent](./puppeteer.puppeteerlifecycleevent.md) \| [PuppeteerLifeCycleEvent](./puppeteer.puppeteerlifecycleevent.md)\[\]; } | _(Optional)_ Options to configure waiting behavior. |
| Parameter | Type | Description |
| --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
| url | string | URL to navigate the frame to. The URL should include scheme, e.g. <code>https://</code> |
| options | &#123; referer?: string; referrerPolicy?: string; timeout?: number; waitUntil?: [PuppeteerLifeCycleEvent](./puppeteer.puppeteerlifecycleevent.md) \| [PuppeteerLifeCycleEvent](./puppeteer.puppeteerlifecycleevent.md)\[\]; &#125; | _(Optional)_ Options to configure waiting behavior. |
**Returns:**

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

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

2
docs/api/puppeteer.httprequest.failure.md
View File

@ -18,7 +18,7 @@ class HTTPRequest {
**Returns:**
{ errorText: string; } \| null
&#123; errorText: string; &#125; \| null
`null` unless the request failed. If the request fails this can return an object with `errorText` containing a human-readable error message, e.g. `net::ERR_FAILED`. It is not guaranteed that there will be failure text if the request fails.

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

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

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

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

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

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

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

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

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

@ -31,10 +31,10 @@ class Page {
## Parameters
| Parameter | Type | Description |
| ------------ | ---------------------------------- | -------------------------------------------------------------- |
| name | string | Name of the function on the window object |
| pptrFunction | Function \| { default: Function; } | Callback function which will be called in Puppeteer's context. |
| Parameter | Type | Description |
| ------------ | -------------------------------------------- | -------------------------------------------------------------- |
| name | string | Name of the function on the window object |
| pptrFunction | Function \| &#123; default: Function; &#125; | Callback function which will be called in Puppeteer's context. |
**Returns:**

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

@ -20,9 +20,9 @@ class Page {
## Parameters
| Parameter | Type | Description |
| --------- | --------------------------------------------------------------------------------------------------- | ------------------------------- |
| options | Readonly&lt;[ScreenshotOptions](./puppeteer.screenshotoptions.md)&gt; &amp; { encoding: 'base64'; } | Configures screenshot behavior. |
| Parameter | Type | Description |
| --------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------- |
| options | Readonly&lt;[ScreenshotOptions](./puppeteer.screenshotoptions.md)&gt; &amp; &#123; encoding: 'base64'; &#125; | Configures screenshot behavior. |
**Returns:**

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

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

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

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

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

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

42
docs/api/puppeteer.pageevents.md
View File

@ -18,24 +18,24 @@ export interface PageEvents extends Record<EventType, unknown>
## Properties
| Property | Modifiers | Type | Description | Default |
| ---------------------- | --------- | -------------------------------------------------------------- | ----------- | ------- |
| close | | undefined | | |
| console | | [ConsoleMessage](./puppeteer.consolemessage.md) | | |
| dialog | | [Dialog](./puppeteer.dialog.md) | | |
| domcontentloaded | | undefined | | |
| error | | Error | | |
| frameattached | | [Frame](./puppeteer.frame.md) | | |
| framedetached | | [Frame](./puppeteer.frame.md) | | |
| framenavigated | | [Frame](./puppeteer.frame.md) | | |
| load | | undefined | | |
| metrics | | { title: string; metrics: [Metrics](./puppeteer.metrics.md); } | | |
| pageerror | | Error | | |
| popup | | [Page](./puppeteer.page.md) \| null | | |
| request | | [HTTPRequest](./puppeteer.httprequest.md) | | |
| requestfailed | | [HTTPRequest](./puppeteer.httprequest.md) | | |
| requestfinished | | [HTTPRequest](./puppeteer.httprequest.md) | | |
| requestservedfromcache | | [HTTPRequest](./puppeteer.httprequest.md) | | |
| response | | [HTTPResponse](./puppeteer.httpresponse.md) | | |
| workercreated | | [WebWorker](./puppeteer.webworker.md) | | |
| workerdestroyed | | [WebWorker](./puppeteer.webworker.md) | | |
| Property | Modifiers | Type | Description | Default |
| ---------------------- | --------- | ------------------------------------------------------------------------ | ----------- | ------- |
| close | | undefined | | |
| console | | [ConsoleMessage](./puppeteer.consolemessage.md) | | |
| dialog | | [Dialog](./puppeteer.dialog.md) | | |
| domcontentloaded | | undefined | | |
| error | | Error | | |
| frameattached | | [Frame](./puppeteer.frame.md) | | |
| framedetached | | [Frame](./puppeteer.frame.md) | | |
| framenavigated | | [Frame](./puppeteer.frame.md) | | |
| load | | undefined | | |
| metrics | | &#123; title: string; metrics: [Metrics](./puppeteer.metrics.md); &#125; | | |
| pageerror | | Error | | |
| popup | | [Page](./puppeteer.page.md) \| null | | |
| request | | [HTTPRequest](./puppeteer.httprequest.md) | | |
| requestfailed | | [HTTPRequest](./puppeteer.httprequest.md) | | |
| requestfinished | | [HTTPRequest](./puppeteer.httprequest.md) | | |
| requestservedfromcache | | [HTTPRequest](./puppeteer.httprequest.md) | | |
| response | | [HTTPResponse](./puppeteer.httpresponse.md) | | |
| workercreated | | [WebWorker](./puppeteer.webworker.md) | | |
| workerdestroyed | | [WebWorker](./puppeteer.webworker.md) | | |

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

@ -16,6 +16,6 @@ export interface ScreencastOptions
| ---------- | --------------------- | ----------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------- |
| crop | <code>optional</code> | [BoundingBox](./puppeteer.boundingbox.md) | Specifies the region of the viewport to crop. | |
| ffmpegPath | <code>optional</code> | string | <p>Path to the \[ffmpeg\](https://ffmpeg.org/).</p><p>Required if <code>ffmpeg</code> is not in your PATH.</p> | |
| path | <code>optional</code> | \`${string}.webm\` | File path to save the screencast to. | |
| path | <code>optional</code> | \`$&#123;string&#125;.webm\` | File path to save the screencast to. | |
| scale | <code>optional</code> | number | <p>Scales the output video.</p><p>For example, <code>0.5</code> will shrink the width and height of the output video by half. <code>2</code> will double the width and height of the output video.</p> | <code>1</code> |
| speed | <code>optional</code> | number | <p>Specifies the speed to record at.</p><p>For example, <code>0.5</code> will slowdown the output video by 50%. <code>2</code> will double the speed of the output video.</p> | <code>1</code> |

8
docs/browsers-api/browsers.cli._constructor_.md
View File

@ -32,7 +32,7 @@ class CLI {
## Parameters
| Parameter | Type | Description |
| --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ |
| opts | string \| { cachePath?: string; scriptName?: string; prefixCommand?: { cmd: string; description: string; }; allowCachePathOverride?: boolean; pinnedBrowsers?: Partial&lt;{ \[key in [Browser](./browsers.browser.md)\]: string; }&gt;; } | _(Optional)_ |
| rl | readline.Interface | _(Optional)_ |
| Parameter | Type | Description |
| --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ |
| opts | string \| &#123; cachePath?: string; scriptName?: string; prefixCommand?: &#123; cmd: string; description: string; &#125;; allowCachePathOverride?: boolean; pinnedBrowsers?: Partial&lt;&#123; \[key in [Browser](./browsers.browser.md)\]: string; &#125;&gt;; &#125; | _(Optional)_ |
| rl | readline.Interface | _(Optional)_ |

6
docs/browsers-api/browsers.install.md
View File

@ -16,9 +16,9 @@ export declare function install(
## Parameters
| Parameter | Type | Description |
| --------- | ----------------------------------------------------------------------- | ----------- |
| options | [InstallOptions](./browsers.installoptions.md) &amp; { unpack?: true; } | |
| Parameter | Type | Description |
| --------- | --------------------------------------------------------------------------------- | ----------- |
| options | [InstallOptions](./browsers.installoptions.md) &amp; &#123; unpack?: true; &#125; | |
**Returns:**

6
docs/browsers-api/browsers.install_1.md
View File

@ -16,9 +16,9 @@ export declare function install(
## Parameters
| Parameter | Type | Description |
| --------- | ----------------------------------------------------------------------- | ----------- |
| options | [InstallOptions](./browsers.installoptions.md) &amp; { unpack: false; } | |
| Parameter | Type | Description |
| --------- | --------------------------------------------------------------------------------- | ----------- |
| options | [InstallOptions](./browsers.installoptions.md) &amp; &#123; unpack: false; &#125; | |
**Returns:**

2
docs/contributing.md
View File

@ -8,7 +8,7 @@ patches and contributions!
Contributions to this project must be accompanied by a Contributor License
Agreement. You (or your employer) retain the copyright to your contribution,
this simply gives us permission to use and redistribute your contributions as
part of the project. Head over to <https://cla.developers.google.com/> to see
part of the project. Head over to &lt;[https://cla.developers.google.com/](https://cla.developers.google.com/)&gt; to see
your current agreements on file or to sign a new one.
You generally only need to submit a CLA once, so if you've already submitted one

28
tools/docgen/src/custom_markdown_documenter.ts
View File

@ -24,7 +24,7 @@
import * as path from 'path';
import type {DocumenterConfig} from '@microsoft/api-documenter/lib/documenters/DocumenterConfig.js';
import {CustomMarkdownEmitter} from '@microsoft/api-documenter/lib/markdown/CustomMarkdownEmitter.js';
import {CustomMarkdownEmitter as ApiFormatterMarkdownEmitter} from '@microsoft/api-documenter/lib/markdown/CustomMarkdownEmitter.js';
import {CustomDocNodes} from '@microsoft/api-documenter/lib/nodes/CustomDocNodeKind.js';
import {DocEmphasisSpan} from '@microsoft/api-documenter/lib/nodes/DocEmphasisSpan.js';
import {DocHeading} from '@microsoft/api-documenter/lib/nodes/DocHeading.js';
@ -93,6 +93,32 @@ export interface IMarkdownDocumenterOptions {
outputFolder: string;
}
export class CustomMarkdownEmitter extends ApiFormatterMarkdownEmitter {
protected override getEscapedText(text: string): string {
const textWithBackslashes: string = text
.replace(/\\/g, '\\\\') // first replace the escape character
.replace(/[*#[\]_|`~]/g, x => {
return '\\' + x;
}) // then escape any special characters
.replace(/---/g, '\\-\\-\\-') // hyphens only if it's 3 or more
.replace(/&/g, '&amp;')
.replace(/</g, '&lt;')
.replace(/>/g, '&gt;')
.replace(/\{/g, '&#123;')
.replace(/\}/g, '&#125;');
return textWithBackslashes;
}
protected override getTableEscapedText(text: string): string {
return text
.replace(/&/g, '&amp;')
.replace(/"/g, '&quot;')
.replace(/</g, '&lt;')
.replace(/>/g, '&gt;')
.replace(/\|/g, '&#124;');
}
}
/**
* Renders API documentation in the Markdown file format.
* For more info: https://en.wikipedia.org/wiki/Markdown

2
website/README.md
View File

@ -1,6 +1,6 @@
# Website
This website is built using [Docusaurus 2](https://docusaurus.io/).
This website is built using [Docusaurus 3](https://docusaurus.io/).
### Installation

6
website/docusaurus.config.js
View File

@ -19,8 +19,9 @@
const assert = require('assert');
const darkCodeTheme = require('prism-react-renderer/themes/dracula');
const lightCodeTheme = require('prism-react-renderer/themes/github');
const {themes} = require('prism-react-renderer');
const darkCodeTheme = themes.dracula;
const lightCodeTheme = themes.github;
const semver = require('semver');
const archivedVersions = require('./versionsArchived.json');
@ -340,6 +341,7 @@ const config = {
prism: {
theme: lightCodeTheme,
darkTheme: darkCodeTheme,
additionalLanguages: ['bash', 'diff', 'json'],
},
},
};

18836
website/package-lock.json generated
View File

File diff suppressed because it is too large Load Diff

16
website/package.json
View File

@ -15,18 +15,18 @@
"archive": "node archive.js"
},
"dependencies": {
"@docusaurus/core": "2.4.1",
"@docusaurus/plugin-client-redirects": "2.4.1",
"@docusaurus/preset-classic": "2.4.1",
"@mdx-js/react": "1.6.22",
"@docusaurus/core": "3.0.0",
"@docusaurus/plugin-client-redirects": "3.0.0",
"@docusaurus/preset-classic": "3.0.0",
"@mdx-js/react": "3.0.0",
"clsx": "1.2.1",
"prism-react-renderer": "1.3.5",
"prism-react-renderer": "2.1.0",
"semver": "7.5.4",
"react": "17.0.2",
"react-dom": "17.0.2"
"react": "18.2.0",
"react-dom": "18.2.0"
},
"devDependencies": {
"@docusaurus/module-type-aliases": "2.4.1",
"@docusaurus/module-type-aliases": "3.0.0",
"swc-loader": "0.2.3"
},
"browserslist": {

2
website/versioned_docs/version-21.5.2/api/puppeteer.autofilldata.md
View File

@ -14,4 +14,4 @@ export interface AutofillData
| Property | Modifiers | Type | Description | Default |
| ---------- | --------- | --------------------------------------------------------------------------------------- | ----------- | ------- |
| creditCard | | { number: string; name: string; expiryMonth: string; expiryYear: string; cvc: string; } | | |
| creditCard | | \{ number: string; name: string; expiryMonth: string; expiryYear: string; cvc: string; \} | | |

2
website/versioned_docs/version-21.5.2/api/puppeteer.browser.md
View File

@ -78,4 +78,4 @@ await browser2.close();
| [userAgent()](./puppeteer.browser.useragent.md) | | <p>Gets this [browser's](./puppeteer.browser.md) original user agent.</p><p>[Pages](./puppeteer.page.md) can override the user agent with [Page.setUserAgent()](./puppeteer.page.setuseragent.md).</p> |
| [version()](./puppeteer.browser.version.md) | | <p>Gets a string representing this [browser's](./puppeteer.browser.md) name and version.</p><p>For headless browser, this is similar to <code>&quot;HeadlessChrome/61.0.3153.0&quot;</code>. For non-headless or new-headless, this is similar to <code>&quot;Chrome/61.0.3153.0&quot;</code>. For Firefox, it is similar to <code>&quot;Firefox/116.0a1&quot;</code>.</p><p>The format of [Browser.version()](./puppeteer.browser.version.md) might change with future releases of browsers.</p> |
| [waitForTarget(predicate, options)](./puppeteer.browser.waitfortarget.md) | | <p>Waits until a [target](./puppeteer.target.md) matching the given <code>predicate</code> appears and returns it.</p><p>This will look all open [browser contexts](./puppeteer.browsercontext.md).</p> |
| [wsEndpoint()](./puppeteer.browser.wsendpoint.md) | | <p>Gets the WebSocket URL to connect to this [browser](./puppeteer.browser.md).</p><p>This is usually used with [Puppeteer.connect()](./puppeteer.puppeteer.connect.md).</p><p>You can find the debugger URL (<code>webSocketDebuggerUrl</code>) from <code>http://${host}:${port}/json/version</code>.</p><p>See [browser endpoint](https://chromedevtools.github.io/devtools-protocol/#how-do-i-access-the-browser-target) for more information.</p> |
| [wsEndpoint()](./puppeteer.browser.wsendpoint.md) | | <p>Gets the WebSocket URL to connect to this [browser](./puppeteer.browser.md).</p><p>This is usually used with [Puppeteer.connect()](./puppeteer.puppeteer.connect.md).</p><p>You can find the debugger URL (<code>webSocketDebuggerUrl</code>) from <code>http://$\{host\}:$\{port\}/json/version</code>.</p><p>See [browser endpoint](https://chromedevtools.github.io/devtools-protocol/#how-do-i-access-the-browser-target) for more information.</p> |

2
website/versioned_docs/version-21.5.2/api/puppeteer.coverageentry.md
View File

@ -16,6 +16,6 @@ export interface CoverageEntry
| Property | Modifiers | Type | Description | Default |
| -------- | --------- | -------------------------------------------- | --------------------------------------------- | ------- |
| ranges | | Array&lt;{ start: number; end: number; }&gt; | The covered range as start and end positions. | |
| ranges | | Array&lt;\{ start: number; end: number; \}&gt; | The covered range as start and end positions. | |
| text | | string | The content of the style sheet or script. | |
| url | | string | The URL of the style sheet or script. | |

2
website/versioned_docs/version-21.5.2/api/puppeteer.csscoverage.start.md
View File

@ -16,7 +16,7 @@ class CSSCoverage {
| Parameter | Type | Description |
| --------- | -------------------------------- | ------------ |
| options | { resetOnNavigation?: boolean; } | _(Optional)_ |
| options | \{ resetOnNavigation?: boolean; \} | _(Optional)_ |
**Returns:**

2
website/versioned_docs/version-21.5.2/api/puppeteer.elementhandle.draganddrop.md
View File

@ -28,7 +28,7 @@ class ElementHandle {
| --------- | ------------------------------------------------------------ | ------------ |
| this | [ElementHandle](./puppeteer.elementhandle.md)&lt;Element&gt; | |
| target | [ElementHandle](./puppeteer.elementhandle.md)&lt;Node&gt; | |
| options | { delay: number; } | _(Optional)_ |
| options | \{ delay: number; \} | _(Optional)_ |
**Returns:**

2
website/versioned_docs/version-21.5.2/api/puppeteer.elementhandle.isintersectingviewport.md
View File

@ -24,7 +24,7 @@ class ElementHandle {
| Parameter | Type | Description |
| --------- | ------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------- |
| this | [ElementHandle](./puppeteer.elementhandle.md)&lt;Element&gt; | |
| options | { threshold?: number; } | _(Optional)_ Threshold for the intersection between 0 (no intersection) and 1 (full intersection). Defaults to 1. |
| options | \{ threshold?: number; \} | _(Optional)_ Threshold for the intersection between 0 (no intersection) and 1 (full intersection). Defaults to 1. |
**Returns:**

2
website/versioned_docs/version-21.5.2/api/puppeteer.elementhandle.screenshot.md
View File

@ -22,7 +22,7 @@ class ElementHandle {
| Parameter | Type | Description |
| --------- | --------------------------------------------------------------------------------------------------- | ----------- |
| options | Readonly&lt;[ScreenshotOptions](./puppeteer.screenshotoptions.md)&gt; &amp; { encoding: 'base64'; } | |
| options | Readonly&lt;[ScreenshotOptions](./puppeteer.screenshotoptions.md)&gt; &amp; \{ encoding: 'base64'; \} | |
**Returns:**

2
website/versioned_docs/version-21.5.2/api/puppeteer.elementhandle.waitforxpath.md
View File

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

2
website/versioned_docs/version-21.5.2/api/puppeteer.frame.goto.md
View File

@ -27,7 +27,7 @@ class Frame {
| Parameter | Type | Description |
| --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------- |
| url | string | URL to navigate the frame to. The URL should include scheme, e.g. <code>https://</code> |
| options | { referer?: string; referrerPolicy?: string; timeout?: number; waitUntil?: [PuppeteerLifeCycleEvent](./puppeteer.puppeteerlifecycleevent.md) \| [PuppeteerLifeCycleEvent](./puppeteer.puppeteerlifecycleevent.md)\[\]; } | _(Optional)_ Options to configure waiting behavior. |
| options | \{ referer?: string; referrerPolicy?: string; timeout?: number; waitUntil?: [PuppeteerLifeCycleEvent](./puppeteer.puppeteerlifecycleevent.md) \| [PuppeteerLifeCycleEvent](./puppeteer.puppeteerlifecycleevent.md)\[\]; \} | _(Optional)_ Options to configure waiting behavior. |
**Returns:**

2
website/versioned_docs/version-21.5.2/api/puppeteer.frame.setcontent.md
View File

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

2
website/versioned_docs/version-21.5.2/api/puppeteer.httprequest.failure.md
View File

@ -18,7 +18,7 @@ class HTTPRequest {
**Returns:**
{ errorText: string; } \| null
\{ errorText: string; \} \| null
`null` unless the request failed. If the request fails this can return an object with `errorText` containing a human-readable error message, e.g. `net::ERR_FAILED`. It is not guaranteed that there will be failure text if the request fails.

2
website/versioned_docs/version-21.5.2/api/puppeteer.jscoverage.start.md
View File

@ -21,7 +21,7 @@ class JSCoverage {
| Parameter | Type | Description |
| --------- | ---------------------------------------------------------------------------------------------------------------------------------- | ------------ |
| options | { resetOnNavigation?: boolean; reportAnonymousScripts?: boolean; includeRawScriptCoverage?: boolean; useBlockCoverage?: boolean; } | _(Optional)_ |
| options | \{ resetOnNavigation?: boolean; reportAnonymousScripts?: boolean; includeRawScriptCoverage?: boolean; useBlockCoverage?: boolean; \} | _(Optional)_ |
**Returns:**

2
website/versioned_docs/version-21.5.2/api/puppeteer.mouse.draganddrop.md
View File

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

2
website/versioned_docs/version-21.5.2/api/puppeteer.page.close.md
View File

@ -16,7 +16,7 @@ class Page {
| Parameter | Type | Description |
| --------- | ------------------------------ | ------------ |
| options | { runBeforeUnload?: boolean; } | _(Optional)_ |
| options | \{ runBeforeUnload?: boolean; \} | _(Optional)_ |
**Returns:**

2
website/versioned_docs/version-21.5.2/api/puppeteer.page.emulateidlestate.md
View File

@ -21,7 +21,7 @@ class Page {
| Parameter | Type | Description |
| --------- | ----------------------------------------------------- | --------------------------------------------------------------- |
| overrides | { isUserActive: boolean; isScreenUnlocked: boolean; } | _(Optional)_ Mock idle state. If not set, clears idle overrides |
| overrides | \{ isUserActive: boolean; isScreenUnlocked: boolean; \} | _(Optional)_ Mock idle state. If not set, clears idle overrides |
**Returns:**

2
website/versioned_docs/version-21.5.2/api/puppeteer.page.exposefunction.md
View File

@ -34,7 +34,7 @@ class Page {
| Parameter | Type | Description |
| ------------ | ---------------------------------- | -------------------------------------------------------------- |
| name | string | Name of the function on the window object |
| pptrFunction | Function \| { default: Function; } | Callback function which will be called in Puppeteer's context. |
| pptrFunction | Function \| \{ default: Function; \} | Callback function which will be called in Puppeteer's context. |
**Returns:**

2
website/versioned_docs/version-21.5.2/api/puppeteer.page.screenshot.md
View File

@ -22,7 +22,7 @@ class Page {
| Parameter | Type | Description |
| --------- | --------------------------------------------------------------------------------------------------- | ------------------------------- |
| options | Readonly&lt;[ScreenshotOptions](./puppeteer.screenshotoptions.md)&gt; &amp; { encoding: 'base64'; } | Configures screenshot behavior. |
| options | Readonly&lt;[ScreenshotOptions](./puppeteer.screenshotoptions.md)&gt; &amp; \{ encoding: 'base64'; \} | Configures screenshot behavior. |
**Returns:**

2
website/versioned_docs/version-21.5.2/api/puppeteer.page.waitfornetworkidle.md
View File

@ -19,7 +19,7 @@ class Page {
| Parameter | Type | Description |
| --------- | ---------------------------------------- | ---------------------------------------- |
| options | { idleTime?: number; timeout?: number; } | _(Optional)_ Optional waiting parameters |
| options | \{ idleTime?: number; timeout?: number; \} | _(Optional)_ Optional waiting parameters |
**Returns:**

2
website/versioned_docs/version-21.5.2/api/puppeteer.page.waitforrequest.md
View File

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

2
website/versioned_docs/version-21.5.2/api/puppeteer.page.waitforresponse.md
View File

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

2
website/versioned_docs/version-21.5.2/api/puppeteer.pageevents.md
View File

@ -29,7 +29,7 @@ export interface PageEvents extends Record<EventType, unknown>
| framedetached | | [Frame](./puppeteer.frame.md) | | |
| framenavigated | | [Frame](./puppeteer.frame.md) | | |
| load | | undefined | | |
| metrics | | { title: string; metrics: [Metrics](./puppeteer.metrics.md); } | | |
| metrics | | \{ title: string; metrics: [Metrics](./puppeteer.metrics.md); \} | | |
| pageerror | | Error | | |
| popup | | [Page](./puppeteer.page.md) \| null | | |
| request | | [HTTPRequest](./puppeteer.httprequest.md) | | |

2
website/versioned_docs/version-21.5.2/api/puppeteer.screencastoptions.md
View File

@ -16,6 +16,6 @@ export interface ScreencastOptions
| ---------- | --------------------- | ----------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------- |
| crop | <code>optional</code> | [BoundingBox](./puppeteer.boundingbox.md) | Specifies the region of the viewport to crop. | |
| ffmpegPath | <code>optional</code> | string | <p>Path to the \[ffmpeg\](https://ffmpeg.org/).</p><p>Required if <code>ffmpeg</code> is not in your PATH.</p> | |
| path | <code>optional</code> | \`${string}.webm\` | File path to save the screencast to. | |
| path | <code>optional</code> | \`$\{string\}.webm\` | File path to save the screencast to. | |
| scale | <code>optional</code> | number | <p>Scales the output video.</p><p>For example, <code>0.5</code> will shrink the width and height of the output video by half. <code>2</code> will double the width and height of the output video.</p> | <code>1</code> |
| speed | <code>optional</code> | number | <p>Specifies the speed to record at.</p><p>For example, <code>0.5</code> will slowdown the output video by 50%. <code>2</code> will double the speed of the output video.</p> | <code>1</code> |

2
website/versioned_docs/version-21.5.2/browsers-api/browsers.install.md
View File

@ -18,7 +18,7 @@ export declare function install(
| Parameter | Type | Description |
| --------- | ----------------------------------------------------------------------- | ----------- |
| options | [InstallOptions](./browsers.installoptions.md) &amp; { unpack?: true; } | |
| options | [InstallOptions](./browsers.installoptions.md) &amp; \{ unpack?: true; \} | |
**Returns:**

2
website/versioned_docs/version-21.5.2/browsers-api/browsers.install_1.md
View File

@ -18,7 +18,7 @@ export declare function install(
| Parameter | Type | Description |
| --------- | ----------------------------------------------------------------------- | ----------- |
| options | [InstallOptions](./browsers.installoptions.md) &amp; { unpack: false; } | |
| options | [InstallOptions](./browsers.installoptions.md) &amp; \{ unpack: false; \} | |
**Returns:**

2
website/versioned_docs/version-21.5.2/contributing.md
View File

@ -8,7 +8,7 @@ patches and contributions!
Contributions to this project must be accompanied by a Contributor License
Agreement. You (or your employer) retain the copyright to your contribution,
this simply gives us permission to use and redistribute your contributions as
part of the project. Head over to <https://cla.developers.google.com/> to see
part of the project. Head over to &lt;[https://cla.developers.google.com/](https://cla.developers.google.com/)&gt; to see
your current agreements on file or to sign a new one.
You generally only need to submit a CLA once, so if you've already submitted one