docs: update packages/puppeteer-core/src/api/Page.ts

puppeteer · Nov 28, 2023 · bc6ffa7 · bc6ffa7
1 parent 23a4d9c
commit bc6ffa7
Show file tree

Hide file tree

Showing 5 changed files with 42 additions and 42 deletions.
diff --git a/docs/api/puppeteer.page.screencast.md b/docs/api/puppeteer.page.screencast.md
@@ -28,6 +28,8 @@ Promise&lt;[ScreenRecorder](./puppeteer.screenrecorder.md)&gt;
 
 All recordings will be [WebM](https://www.webmproject.org/) format using the [VP9](https://www.webmproject.org/vp9/) video codec. The FPS is 30.
 
+You must have [ffmpeg](https://ffmpeg.org/) installed on your system.
+
 ## Example
 
 Recording a [page](./puppeteer.page.md):

diff --git a/docs/api/puppeteer.target.createcdpsession.md b/docs/api/puppeteer.target.createcdpsession.md
@@ -17,5 +17,3 @@ class Target {
 **Returns:**
 
 Promise&lt;[CDPSession](./puppeteer.cdpsession.md)&gt;
-
-## Remarks
diff --git a/docs/webdriver-bidi.md b/docs/webdriver-bidi.md
@@ -54,27 +54,27 @@ await browser.close();
 
 - Browser and page automation
 
-  - Puppeteer.launch
   - Browser.close
+  - Frame.goto() (except `referer` and `referrerPolicy`)
   - Page.bringToFront
-  - Page.goto
+  - Page.goto (except `referer` and `referrerPolicy`)
   - Page.reload (except for `ignoreCache` parameter)
   - Page.setViewport (`width`, `height`, `deviceScaleFactor` only)
+  - Puppeteer.launch
 
 - [Script evaluation](https://pptr.dev/guides/evaluate-javascript):
 
-  - Page.evaluate
-  - Page.exposeFunction
   - JSHandle.evaluate
   - JSHandle.evaluateHandle
+  - Page.evaluate
+  - Page.exposeFunction
 
 - [Selectors](https://pptr.dev/guides/query-selectors) and [locators](https://pptr.dev/guides/locators) except for ARIA:
 
   - Page.$ (ARIA selectors only supported in Chrome)
   - Page.$$ (ARIA selectors only supported in Chrome)
-  - Page.$eval (ARIA selectors only supported in Chrome)
   - Page.$$eval (ARIA selectors only supported in Chrome)
-  - Frame.goto() (except `referer` and `referrerPolicy`)
+  - Page.$eval (ARIA selectors only supported in Chrome)
   - Page.waitForSelector (ARIA selectors only supported in Chrome)
 
 - Input
@@ -86,8 +86,8 @@ await browser.close();
   - Keyboard.type
   - Keyboard.up
   - Mouse events (except for dedicated drag'n'drop API methods)
-  - TouchScreen.\*
   - Page.tap
+  - TouchScreen.\*
 
 - JavaScript dialog interception
 
@@ -107,37 +107,37 @@ await browser.close();
 
 - [Request interception](https://pptr.dev/guides/request-interception)
 
+  - HTTPRequest.abort()
+  - HTTPRequest.abortErrorReason()
   - HTTPRequest.client()
+  - HTTPRequest.continue()
   - HTTPRequest.continueRequestOverrides()
-  - HTTPRequest.responseForRequest()
-  - HTTPRequest.abortErrorReason()
+  - HTTPRequest.failure()
+  - HTTPRequest.finalizeInterceptions()
   - HTTPRequest.interceptResolutionState()
   - HTTPRequest.isInterceptResolutionHandled()
-  - HTTPRequest.finalizeInterceptions()
-  - HTTPRequest.failure()
-  - HTTPRequest.continue()
   - HTTPRequest.respond()
-  - HTTPRequest.abort()
+  - HTTPRequest.responseForRequest()
   - Page.setRequestInterception()
 
 - Permissions
 
-  - BrowserContext.overridePermissions()
   - BrowserContext.clearPermissionOverrides()
+  - BrowserContext.overridePermissions()
 
 - Various emulations (most are only supported with Chrome)
 
   - Page.emulate() (supported only in Chrome)
-  - Page.setJavaScriptEnabled() (supported only in Chrome)
-  - Page.setBypassCSP() (supported only in Chrome)
-  - Page.emulateMediaType() (supported only in Chrome)
   - Page.emulateCPUThrottling() (supported only in Chrome)
+  - Page.emulateIdleState() (supported only in Chrome)
   - Page.emulateMediaFeatures() (supported only in Chrome)
+  - Page.emulateMediaType() (supported only in Chrome)
   - Page.emulateTimezone() (supported only in Chrome)
-  - Page.emulateIdleState() (supported only in Chrome)
   - Page.emulateVisionDeficiency() (supported only in Chrome)
+  - Page.setBypassCSP() (supported only in Chrome)
   - Page.setCacheEnabled() (supported only in Chrome)
   - Page.setGeolocation() (supported only in Chrome)
+  - Page.setJavaScriptEnabled() (supported only in Chrome)
 
 - CDP-specific features
 
@@ -153,35 +153,35 @@ await browser.close();
   - ElementHandle.uploadFile()
   - Frame.isOOPFrame()
   - Frame.waitForDevicePrompt()
-  - Target.opener()
-  - HTTPResponse.securityDetails()
   - HTTPResponse.buffer()
   - HTTPResponse.fromServiceWorker()
+  - HTTPResponse.securityDetails()
   - Input.drag()
+  - Input.dragAndDrop()
   - Input.dragOver()
   - Input.drop()
-  - Input.dragAndDrop()
-  - PageEvent.popup
-  - PageEvent.WorkerCreated
-  - PageEvent.WorkerDestroyed
-  - Page.isServiceWorkerBypassed()
+  - Page.authenticate()
+  - Page.cookies()
+  - Page.deleteCookie()
+  - Page.emulateNetworkConditions()
+  - Page.goBack()
+  - Page.goForward()
   - Page.isDragInterceptionEnabled()
   - Page.isJavaScriptEnabled() (supported only in Chrome)
-  - Page.waitForFileChooser()
-  - Page.workers()
-  - Page.setBypassServiceWorker()
-  - Page.setDragInterception()
-  - Page.setOfflineMode()
-  - Page.emulateNetworkConditions()
+  - Page.isServiceWorkerBypassed()
+  - Page.metrics()
   - Page.queryObjects() (supported only in Chrome)
-  - Page.cookies()
-  - Page.deleteCookie()
+  - Page.screencast() (supported only in Chrome)
+  - Page.setBypassServiceWorker()
   - Page.setCookie()
-  - Page.authenticate()
+  - Page.setDragInterception()
   - Page.setExtraHTTPHeaders()
+  - Page.setOfflineMode()
   - Page.setUserAgent()
-  - Page.metrics()
-  - Page.goBack()
-  - Page.goForward()
-  - Page.screencast() (supported only in Chrome)
   - Page.waitForDevicePrompt()
+  - Page.waitForFileChooser()
+  - Page.workers()
+  - PageEvent.popup
+  - PageEvent.WorkerCreated
+  - PageEvent.WorkerDestroyed
+  - Target.opener()
diff --git a/packages/puppeteer-core/src/api/Page.ts b/packages/puppeteer-core/src/api/Page.ts
@@ -2240,6 +2240,8 @@ export abstract class Page extends EventEmitter<PageEvents> {
    *
    * All recordings will be {@link https://www.webmproject.org/ | WebM} format using
    * the {@link https://www.webmproject.org/vp9/ | VP9} video codec. The FPS is 30.
+   *
+   * You must have {@link https://ffmpeg.org/ | ffmpeg} installed on your system.
    */
   async screencast(
     options: Readonly<ScreencastOptions> = {}

diff --git a/packages/puppeteer-core/src/api/Target.ts b/packages/puppeteer-core/src/api/Target.ts
@@ -70,8 +70,6 @@ export abstract class Target {
 
   /**
    * Creates a Chrome Devtools Protocol session attached to the target.
-   *
-   * @remarks
    */
   abstract createCDPSession(): Promise<CDPSession>;