chrome-devtools-frontend 1.0.923319 → 1.0.923788

package/front_end/third_party/puppeteer/package/lib/esm/puppeteer/common/Page.d.ts

@@ -14,30 +14,29 @@
  * limitations under the License.
  */
 /// <reference types="node" />
-import { Protocol } from 'devtools-protocol';
-
-import { Accessibility } from './Accessibility.js';
-import { Browser, BrowserContext } from './Browser.js';
+import type { Readable } from 'stream';
+import { EventEmitter } from './EventEmitter.js';
 import { CDPSession } from './Connection.js';
-import { ConsoleMessage } from './ConsoleMessage.js';
-import { Coverage } from './Coverage.js';
 import { Dialog } from './Dialog.js';
-import { EvaluateFn, EvaluateFnReturnType, EvaluateHandleFn, SerializableOrJSHandle, UnwrapPromiseLike , WrapElementHandle} from './EvalTypes.js';
-import { EventEmitter } from './EventEmitter.js';
-import { FileChooser } from './FileChooser.js';
 import { Frame } from './FrameManager.js';
+import { Keyboard, Mouse, Touchscreen, MouseButton } from './Input.js';
+import { Tracing } from './Tracing.js';
+import { Coverage } from './Coverage.js';
+import { WebWorker } from './WebWorker.js';
+import { Browser, BrowserContext } from './Browser.js';
+import { Target } from './Target.js';
+import { JSHandle, ElementHandle } from './JSHandle.js';
+import { Viewport } from './PuppeteerViewport.js';
+import { Credentials, NetworkConditions } from './NetworkManager.js';
 import { HTTPRequest } from './HTTPRequest.js';
 import { HTTPResponse } from './HTTPResponse.js';
-import { Keyboard, Mouse, MouseButton , Touchscreen} from './Input.js';
-import { ElementHandle , JSHandle} from './JSHandle.js';
+import { Accessibility } from './Accessibility.js';
+import { FileChooser } from './FileChooser.js';
+import { ConsoleMessage } from './ConsoleMessage.js';
 import { PuppeteerLifeCycleEvent } from './LifecycleWatcher.js';
-import { Credentials, NetworkConditions } from './NetworkManager.js';
+import { Protocol } from 'devtools-protocol';
+import { SerializableOrJSHandle, EvaluateHandleFn, WrapElementHandle, EvaluateFn, EvaluateFnReturnType, UnwrapPromiseLike } from './EvalTypes.js';
 import { PDFOptions } from './PDFOptions.js';
-import { Viewport } from './PuppeteerViewport.js';
-import { Target } from './Target.js';
-import { Tracing } from './Tracing.js';
-import { WebWorker } from './WebWorker.js';
-
 /**
  * @public
  */
@@ -126,7 +125,7 @@ export interface ScreenshotOptions {
     /**
      * @defaultValue 'png'
      */
-    type?: 'png' | 'jpeg';
+    type?: 'png' | 'jpeg' | 'webp';
     /**
      * The file path to save the image to. The screenshot type will be inferred
      * from file extension. If path is a relative path, then it is resolved
@@ -169,7 +168,9 @@ export interface ScreenshotOptions {
  * @public
  */
 export declare const enum PageEmittedEvents {
-    /** Emitted when the page closes. */
+    /** Emitted when the page closes.
+     * @eventProperty
+     */
     Close = "close",
     /**
      * Emitted when JavaScript within the page calls one of console API methods,
@@ -404,12 +405,17 @@ export declare class Page extends EventEmitter {
     private _workers;
     private _fileChooserInterceptors;
     private _disconnectPromise?;
+    private _userDragInterceptionEnabled;
     /**
      * @internal
      */
     constructor(client: CDPSession, target: Target, ignoreHTTPSErrors: boolean);
     private _initialize;
     private _onFileChooser;
+    /**
+     * @returns `true` if drag events are being intercepted, `false` otherwise.
+     */
+    isDragInterceptionEnabled(): boolean;
     /**
      * @returns `true` if the page has JavaScript enabled, `false` otherwise.
      */
@@ -420,17 +426,33 @@ export declare class Page extends EventEmitter {
     on<K extends keyof PageEventObject>(eventName: K, handler: (event: PageEventObject[K]) => void): EventEmitter;
     once<K extends keyof PageEventObject>(eventName: K, handler: (event: PageEventObject[K]) => void): EventEmitter;
     /**
+     * This method is typically coupled with an action that triggers file
+     * choosing. The following example clicks a button that issues a file chooser
+     * and then responds with `/tmp/myfile.pdf` as if a user has selected this file.
+     *
+     * ```js
+     * const [fileChooser] = await Promise.all([
+     * page.waitForFileChooser(),
+     * page.click('#upload-file-button'),
+     * // some button that triggers file selection
+     * ]);
+     * await fileChooser.accept(['/tmp/myfile.pdf']);
+     * ```
+     *
+     * NOTE: This must be called before the file chooser is launched. It will not
+     * return a currently active file chooser.
      * @param options - Optional waiting parameters
      * @returns Resolves after a page requests a file picker.
+     * @remarks
+     * NOTE: In non-headless Chromium, this method results in the native file picker
+     * dialog `not showing up` for the user.
      */
     waitForFileChooser(options?: WaitTimeoutOptions): Promise<FileChooser>;
     /**
      * Sets the page's geolocation.
-     *
      * @remarks
-     * Consider using {@link BrowserContext.overridePermissions} to grant
+     * NOTE: Consider using {@link BrowserContext.overridePermissions} to grant
      * permissions for the page to read its geolocation.
-     *
      * @example
      * ```js
      * await page.setGeolocation({latitude: 59.95, longitude: 30.31667});
@@ -442,17 +464,24 @@ export declare class Page extends EventEmitter {
      */
     target(): Target;
     /**
-     * @returns The browser this page belongs to.
+     * Get the CDP session client the page belongs to.
+     * @internal
+     */
+    client(): CDPSession;
+    /**
+     * Get the browser the page belongs to.
      */
     browser(): Browser;
     /**
-     * @returns The browser context that the page belongs to
+     * Get the browser context that the page belongs to.
      */
     browserContext(): BrowserContext;
     private _onTargetCrashed;
     private _onLogEntryAdded;
     /**
      * @returns The page's main frame.
+     * @remarks
+     * Page is guaranteed to have a main frame which persists during navigations.
      */
     mainFrame(): Frame;
     get keyboard(): Keyboard;
@@ -466,8 +495,11 @@ export declare class Page extends EventEmitter {
     frames(): Frame[];
     /**
      * @returns all of the dedicated
-     * {@link https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API | WebWorkers}
+     * {@link https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API |
+     * WebWorkers}
      * associated with the page.
+     * @remarks
+     * NOTE: This does not contain ServiceWorkers
      */
     workers(): WebWorker[];
     /**
@@ -500,14 +532,63 @@ export declare class Page extends EventEmitter {
      *   await browser.close();
      * })();
      * ```
+     * NOTE: Enabling request interception disables page caching.
      */
     setRequestInterception(value: boolean): Promise<void>;
+    /**
+     * @param enabled - Whether to enable drag interception.
+     *
+     * @remarks
+     * Activating drag interception enables the `Input.drag`,
+     * methods  This provides the capability to capture drag events emitted
+     * on the page, which can then be used to simulate drag-and-drop.
+     */
+    setDragInterception(enabled: boolean): Promise<void>;
     /**
      * @param enabled - When `true`, enables offline mode for the page.
+     * @remarks
+     * NOTE: while this method sets the network connection to offline, it does
+     * not change the parameters used in [page.emulateNetworkConditions(networkConditions)]
+     * (#pageemulatenetworkconditionsnetworkconditions)
      */
     setOfflineMode(enabled: boolean): Promise<void>;
+    /**
+     * @param networkConditions - Passing `null` disables network condition emulation.
+     * @example
+     * ```js
+     * const puppeteer = require('puppeteer');
+     * const slow3G = puppeteer.networkConditions['Slow 3G'];
+     *
+     * (async () => {
+     * const browser = await puppeteer.launch();
+     * const page = await browser.newPage();
+     * await page.emulateNetworkConditions(slow3G);
+     * await page.goto('https://www.google.com');
+     * // other actions...
+     * await browser.close();
+     * })();
+     * ```
+     * @remarks
+     * NOTE: This does not affect WebSockets and WebRTC PeerConnections (see
+     * https://crbug.com/563644). To set the page offline, you can use
+     * [page.setOfflineMode(enabled)](#pagesetofflinemodeenabled).
+     */
     emulateNetworkConditions(networkConditions: NetworkConditions | null): Promise<void>;
     /**
+     * This setting will change the default maximum navigation time for the
+     * following methods and related shortcuts:
+     *
+     * - {@link Page.goBack | page.goBack(options)}
+     *
+     * - {@link Page.goForward | page.goForward(options)}
+     *
+     * - {@link Page.goto | page.goto(url,options)}
+     *
+     * - {@link Page.reload | page.reload(options)}
+     *
+     * - {@link Page.setContent | page.setContent(html,options)}
+     *
+     * - {@link Page.waitForNavigation | page.waitForNavigation(options)}
      * @param timeout - Maximum navigation time in milliseconds.
      */
     setDefaultNavigationTimeout(timeout: number): void;
@@ -582,6 +663,9 @@ export declare class Page extends EventEmitter {
      * given prototype.
      *
      * @remarks
+     * Shortcut for
+     * {@link ExecutionContext.queryObjects |
+     * page.mainFrame().executionContext().queryObjects(prototypeHandle)}.
      *
      * @example
      *
@@ -598,6 +682,8 @@ export declare class Page extends EventEmitter {
      * await mapPrototype.dispose();
      * ```
      * @param prototypeHandle - a handle to the object prototype.
+     * @returns Promise which resolves to a handle to an array of objects with
+     * this prototype.
      */
     queryObjects(prototypeHandle: JSHandle): Promise<JSHandle>;
     /**
@@ -722,7 +808,22 @@ export declare class Page extends EventEmitter {
      * returned.
      */
     $$eval<ReturnType>(selector: string, pageFunction: (elements: Element[], ...args: unknown[]) => ReturnType | Promise<ReturnType>, ...args: SerializableOrJSHandle[]): Promise<WrapElementHandle<ReturnType>>;
+    /**
+     * The method runs `document.querySelectorAll` within the page. If no elements
+     * match the selector, the return value resolves to `[]`.
+     * @remarks
+     * Shortcut for {@link Frame.$$ | Page.mainFrame().$$(selector) }.
+     * @param selector - A `selector` to query page for
+     */
     $$<T extends Element = Element>(selector: string): Promise<Array<ElementHandle<T>>>;
+    /**
+     * The method evaluates the XPath expression relative to the page document as
+     * its context node. If there are no such elements, the method resolves to an
+     * empty array.
+     * @remarks
+     * Shortcut for {@link Frame.$x | Page.mainFrame().$x(expression) }.
+     * @param expression - Expression to evaluate
+     */
     $x(expression: string): Promise<ElementHandle[]>;
     /**
      * If no URLs are specified, this method returns cookies for the current page
@@ -730,22 +831,155 @@ export declare class Page extends EventEmitter {
      */
     cookies(...urls: string[]): Promise<Protocol.Network.Cookie[]>;
     deleteCookie(...cookies: Protocol.Network.DeleteCookiesRequest[]): Promise<void>;
+    /**
+     * @example
+     * ```js
+     * await page.setCookie(cookieObject1, cookieObject2);
+     * ```
+     */
     setCookie(...cookies: Protocol.Network.CookieParam[]): Promise<void>;
+    /**
+     * Adds a `<script>` tag into the page with the desired URL or content.
+     * @remarks
+     * Shortcut for {@link Frame.addScriptTag | page.mainFrame().addScriptTag(options) }.
+     * @returns Promise which resolves to the added tag when the script's onload fires or
+     * when the script content was injected into frame.
+     */
     addScriptTag(options: {
         url?: string;
         path?: string;
         content?: string;
         type?: string;
+        id?: string;
     }): Promise<ElementHandle>;
+    /**
+     * Adds a `<link rel="stylesheet">` tag into the page with the desired URL or a
+     * `<style type="text/css">` tag with the content.
+     * @returns Promise which resolves to the added tag when the stylesheet's
+     * onload fires or when the CSS content was injected into frame.
+     */
     addStyleTag(options: {
         url?: string;
         path?: string;
         content?: string;
     }): Promise<ElementHandle>;
+    /**
+     * 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.
+     * @param name - Name of the function on the window object
+     * @param puppeteerFunction -  Callback function which will be called in
+     * Puppeteer's context.
+     * @example
+     * An example of adding an `md5` function into the page:
+     * ```js
+     * const puppeteer = require('puppeteer');
+     * const crypto = require('crypto');
+     *
+     * (async () => {
+     * const browser = await puppeteer.launch();
+     * const page = await browser.newPage();
+     * page.on('console', (msg) => console.log(msg.text()));
+     * await page.exposeFunction('md5', (text) =>
+     * crypto.createHash('md5').update(text).digest('hex')
+     * );
+     * await page.evaluate(async () => {
+     * // use window.md5 to compute hashes
+     * const myString = 'PUPPETEER';
+     * const myHash = await window.md5(myString);
+     * console.log(`md5 of ${myString} is ${myHash}`);
+     * });
+     * await browser.close();
+     * })();
+     * ```
+     * An example of adding a `window.readfile` function into the page:
+     * ```js
+     * const puppeteer = require('puppeteer');
+     * const fs = require('fs');
+     *
+     * (async () => {
+     * const browser = await puppeteer.launch();
+     * const page = await browser.newPage();
+     * page.on('console', (msg) => console.log(msg.text()));
+     * await page.exposeFunction('readfile', async (filePath) => {
+     * return new Promise((resolve, reject) => {
+     * fs.readFile(filePath, 'utf8', (err, text) => {
+     *    if (err) reject(err);
+     *    else resolve(text);
+     *  });
+     * });
+     * });
+     * await page.evaluate(async () => {
+     * // use window.readfile to read contents of a file
+     * const content = await window.readfile('/etc/hosts');
+     * console.log(content);
+     * });
+     * await browser.close();
+     * })();
+     * ```
+     */
     exposeFunction(name: string, puppeteerFunction: Function): Promise<void>;
+    /**
+     * Provide credentials for `HTTP authentication`.
+     * @remarks To disable authentication, pass `null`.
+     */
     authenticate(credentials: Credentials): Promise<void>;
+    /**
+     * The extra HTTP headers will be sent with every request the page initiates.
+     * NOTE: All HTTP header names are lowercased. (HTTP headers are
+     * case-insensitive, so this shouldn’t impact your server code.)
+     * NOTE: page.setExtraHTTPHeaders does not guarantee the order of headers in
+     * the outgoing requests.
+     * @param headers - An object containing additional HTTP headers to be sent
+     * with every request. All header values must be strings.
+     * @returns
+     */
     setExtraHTTPHeaders(headers: Record<string, string>): Promise<void>;
-    setUserAgent(userAgent: string): Promise<void>;
+    /**
+     * @param userAgent - Specific user agent to use in this page
+     * @param userAgentData - Specific user agent client hint data to use in this
+     * page
+     * @returns Promise which resolves when the user agent is set.
+     */
+    setUserAgent(userAgent: string, userAgentMetadata?: Protocol.Emulation.UserAgentMetadata): Promise<void>;
+    /**
+     * @returns Object containing metrics as key/value pairs.
+     *
+     * - `Timestamp` : The timestamp when the metrics sample was taken.
+     *
+     * - `Documents` : Number of documents in the page.
+     *
+     * - `Frames` : Number of frames in the page.
+     *
+     * - `JSEventListeners` : Number of events in the page.
+     *
+     * - `Nodes` : Number of DOM nodes in the page.
+     *
+     * - `LayoutCount` : Total number of full or partial page layout.
+     *
+     * - `RecalcStyleCount` : Total number of page style recalculations.
+     *
+     * - `LayoutDuration` : Combined durations of all page layouts.
+     *
+     * - `RecalcStyleDuration` : Combined duration of all page style
+     *   recalculations.
+     *
+     * - `ScriptDuration` : Combined duration of JavaScript execution.
+     *
+     * - `TaskDuration` : Combined duration of all tasks performed by the browser.
+     *
+     *
+     * - `JSHeapUsedSize` : Used JavaScript heap size.
+     *
+     * - `JSHeapTotalSize` : Total JavaScript heap size.
+     * @remarks
+     * NOTE: All timestamps are in monotonic time: monotonically increasing time
+     * in seconds since an arbitrary point in the past.
+     */
     metrics(): Promise<Metrics>;
     private _emitMetrics;
     private _buildMetricsObject;
@@ -762,33 +996,411 @@ export declare class Page extends EventEmitter {
      * Hides default white background
      */
     private _setTransparentBackgroundColor;
+    /**
+     *
+     * @returns
+     * @remarks Shortcut for
+     * {@link Frame.url | page.mainFrame().url()}.
+     */
     url(): string;
     content(): Promise<string>;
+    /**
+     * @param html - HTML markup to assign to the page.
+     * @param options - Parameters that has some properties.
+     * @remarks
+     * The parameter `options` might have the following options.
+     *
+     * - `timeout` : Maximum time in milliseconds for resources to load, defaults
+     *   to 30 seconds, pass `0` to disable timeout. The default value can be
+     *   changed by using the
+     *   {@link Page.setDefaultNavigationTimeout |
+     *   page.setDefaultNavigationTimeout(timeout)}
+     *   or {@link Page.setDefaultTimeout | page.setDefaultTimeout(timeout)}
+     *   methods.
+     *
+     * - `waitUntil`: When to consider setting markup succeeded, defaults to `load`.
+     *    Given an array of event strings, setting content is considered to be
+     *    successful after all events have been fired. Events can be either:<br/>
+     *  - `load` : consider setting content to be finished when the `load` event is
+     *    fired.<br/>
+     *  - `domcontentloaded` : consider setting content to be finished when the
+     *   `DOMContentLoaded` event is fired.<br/>
+     *  - `networkidle0` : consider setting content to be finished when there are no
+     *   more than 0 network connections for at least `500` ms.<br/>
+     *  - `networkidle2` : consider setting content to be finished when there are no
+     *   more than 2 network connections for at least `500` ms.
+     */
     setContent(html: string, options?: WaitForOptions): Promise<void>;
+    /**
+     * @param url - URL to navigate page to. The URL should include scheme, e.g.
+     * `https://`
+     * @param options - Navigation Parameter
+     * @returns Promise which resolves to the main resource response. In case of
+     * multiple redirects, the navigation will resolve with the response of the
+     * last redirect.
+     * @remarks
+     * The argument `options` might have the following properties:
+     *
+     * - `timeout` : Maximum navigation time in milliseconds, defaults to 30
+     *   seconds, pass 0 to disable timeout. The default value can be changed by
+     *   using the
+     *   {@link Page.setDefaultNavigationTimeout |
+     *   page.setDefaultNavigationTimeout(timeout)}
+     *   or {@link Page.setDefaultTimeout | page.setDefaultTimeout(timeout)}
+     *   methods.
+     *
+     * - `waitUntil`:When to consider navigation succeeded, defaults to `load`.
+     *    Given an array of event strings, navigation is considered to be successful
+     *    after all events have been fired. Events can be either:<br/>
+     *  - `load` : consider navigation to be finished when the load event is
+     *    fired.<br/>
+     *  - `domcontentloaded` : consider navigation to be finished when the
+     *    DOMContentLoaded event is fired.<br/>
+     *  - `networkidle0` : consider navigation to be finished when there are no
+     *    more than 0 network connections for at least `500` ms.<br/>
+     *  - `networkidle2` : consider navigation to be finished when there are no
+     *    more than 2 network connections for at least `500` ms.
+     *
+     * - `referer` : Referer header value. If provided it will take preference
+     *   over the referer header value set by
+     *   {@link Page.setExtraHTTPHeaders |page.setExtraHTTPHeaders()}.
+     *
+     * `page.goto` will throw an error if:
+     * - there's an SSL error (e.g. in case of self-signed certificates).
+     * - target URL is invalid.
+     * - the timeout is exceeded during navigation.
+     * - the remote server does not respond or is unreachable.
+     * - the main resource failed to load.
+     *
+     * `page.goto` will not throw an error when any valid HTTP status code is
+     *   returned by the remote server, including 404 "Not Found" and 500
+     *   "Internal Server Error". The status code for such responses can be
+     *   retrieved by calling response.status().
+     *
+     * NOTE: `page.goto` either throws an error or returns a main resource
+     * response. The only exceptions are navigation to about:blank or navigation
+     * to the same URL with a different hash, which would succeed and return null.
+     *
+     * NOTE: Headless mode doesn't support navigation to a PDF document. See the
+     * {@link https://bugs.chromium.org/p/chromium/issues/detail?id=761295
+     * | upstream issue}.
+     *
+     * Shortcut for {@link Frame.goto | page.mainFrame().goto(url, options)}.
+     */
     goto(url: string, options?: WaitForOptions & {
         referer?: string;
     }): Promise<HTTPResponse>;
+    /**
+     * @param options - Navigation parameters which might have the following
+     * properties:
+     * @returns Promise which resolves to the main resource response. In case of
+     * multiple redirects, the navigation will resolve with the response of the
+     * last redirect.
+     * @remarks
+     * The argument `options` might have the following properties:
+     *
+     * - `timeout` : Maximum navigation time in milliseconds, defaults to 30
+     *   seconds, pass 0 to disable timeout. The default value can be changed by
+     *   using the
+     *   {@link Page.setDefaultNavigationTimeout |
+     *   page.setDefaultNavigationTimeout(timeout)}
+     *   or {@link Page.setDefaultTimeout | page.setDefaultTimeout(timeout)}
+     *   methods.
+     *
+     * - `waitUntil`: When to consider navigation succeeded, defaults to `load`.
+     *    Given an array of event strings, navigation is considered to be
+     *    successful after all events have been fired. Events can be either:<br/>
+     *  - `load` : consider navigation to be finished when the load event is fired.<br/>
+     *  - `domcontentloaded` : consider navigation to be finished when the
+     *   DOMContentLoaded event is fired.<br/>
+     *  - `networkidle0` : consider navigation to be finished when there are no
+     *   more than 0 network connections for at least `500` ms.<br/>
+     *  - `networkidle2` : consider navigation to be finished when there are no
+     *   more than 2 network connections for at least `500` ms.
+     */
     reload(options?: WaitForOptions): Promise<HTTPResponse | null>;
+    /**
+     * This resolves when the page navigates to a new URL or reloads. It is useful
+     * when you run code that will indirectly cause the page to navigate. Consider
+     * this example:
+     * ```js
+     * const [response] = await Promise.all([
+     * page.waitForNavigation(), // The promise resolves after navigation has finished
+     * page.click('a.my-link'), // Clicking the link will indirectly cause a navigation
+     * ]);
+     * ```
+     *
+     * @param options - Navigation parameters which might have the following properties:
+     * @returns Promise which resolves to the main resource response. In case of
+     * multiple redirects, the navigation will resolve with the response of the
+     * last redirect. In case of navigation to a different anchor or navigation
+     * due to History API usage, the navigation will resolve with `null`.
+     * @remarks
+     * NOTE: Usage of the
+     * {@link https://developer.mozilla.org/en-US/docs/Web/API/History_API | History API}
+     * to change the URL is considered a navigation.
+     *
+     * Shortcut for
+     * {@link Frame.waitForNavigation | page.mainFrame().waitForNavigation(options)}.
+     */
     waitForNavigation(options?: WaitForOptions): Promise<HTTPResponse | null>;
     private _sessionClosePromise;
+    /**
+     * @param urlOrPredicate - A URL or predicate to wait for
+     * @param options - Optional waiting parameters
+     * @returns Promise which resolves to the matched response
+     * @example
+     * ```js
+     * const firstResponse = await page.waitForResponse(
+     * 'https://example.com/resource'
+     * );
+     * const finalResponse = await page.waitForResponse(
+     * (response) =>
+     * response.url() === 'https://example.com' && response.status() === 200
+     * );
+     * const finalResponse = await page.waitForResponse(async (response) => {
+     * return (await response.text()).includes('<html>');
+     * });
+     * return finalResponse.ok();
+     * ```
+     * @remarks
+     * Optional Waiting Parameters have:
+     *
+     * - `timeout`: Maximum wait time in milliseconds, defaults to `30` seconds, pass
+     * `0` to disable the timeout. The default value can be changed by using the
+     * {@link Page.setDefaultTimeout} method.
+     */
     waitForRequest(urlOrPredicate: string | ((req: HTTPRequest) => boolean | Promise<boolean>), options?: {
         timeout?: number;
     }): Promise<HTTPRequest>;
+    /**
+     * @param urlOrPredicate - A URL or predicate to wait for.
+     * @param options - Optional waiting parameters
+     * @returns Promise which resolves to the matched response.
+     * @example
+     * ```js
+     * const firstResponse = await page.waitForResponse(
+     * 'https://example.com/resource'
+     * );
+     * const finalResponse = await page.waitForResponse(
+     * (response) =>
+     * response.url() === 'https://example.com' && response.status() === 200
+     * );
+     * const finalResponse = await page.waitForResponse(async (response) => {
+     * return (await response.text()).includes('<html>');
+     * });
+     * return finalResponse.ok();
+     * ```
+     * @remarks
+     * Optional Parameter have:
+     *
+     * - `timeout`: Maximum wait time in milliseconds, defaults to `30` seconds,
+     * pass `0` to disable the timeout. The default value can be changed by using
+     * the {@link Page.setDefaultTimeout} method.
+     */
     waitForResponse(urlOrPredicate: string | ((res: HTTPResponse) => boolean | Promise<boolean>), options?: {
         timeout?: number;
     }): Promise<HTTPResponse>;
+    /**
+     * @param options - Optional waiting parameters
+     * @returns Promise which resolves when network is idle
+     */
+    waitForNetworkIdle(options?: {
+        idleTime?: number;
+        timeout?: number;
+    }): Promise<void>;
+    /**
+     * This method navigate to the previous page in history.
+     * @param options - Navigation parameters
+     * @returns Promise which resolves to the main resource response. In case of
+     * multiple redirects, the navigation will resolve with the response of the
+     * last redirect. If can not go back, resolves to `null`.
+     * @remarks
+     * The argument `options` might have the following properties:
+     *
+     * - `timeout` : Maximum navigation time in milliseconds, defaults to 30
+     *   seconds, pass 0 to disable timeout. The default value can be changed by
+     *   using the
+     *   {@link Page.setDefaultNavigationTimeout
+     *   | page.setDefaultNavigationTimeout(timeout)}
+     *   or {@link Page.setDefaultTimeout | page.setDefaultTimeout(timeout)}
+     *   methods.
+     *
+     * - `waitUntil` : When to consider navigation succeeded, defaults to `load`.
+     *    Given an array of event strings, navigation is considered to be
+     *    successful after all events have been fired. Events can be either:<br/>
+     *  - `load` : consider navigation to be finished when the load event is fired.<br/>
+     *  - `domcontentloaded` : consider navigation to be finished when the
+     *   DOMContentLoaded event is fired.<br/>
+     *  - `networkidle0` : consider navigation to be finished when there are no
+     *   more than 0 network connections for at least `500` ms.<br/>
+     *  - `networkidle2` : consider navigation to be finished when there are no
+     *   more than 2 network connections for at least `500` ms.
+     */
     goBack(options?: WaitForOptions): Promise<HTTPResponse | null>;
+    /**
+     * This method navigate to the next page in history.
+     * @param options - Navigation Parameter
+     * @returns Promise which resolves to the main resource response. In case of
+     * multiple redirects, the navigation will resolve with the response of the
+     * last redirect. If can not go forward, resolves to `null`.
+     * @remarks
+     * The argument `options` might have the following properties:
+     *
+     * - `timeout` : Maximum navigation time in milliseconds, defaults to 30
+     *   seconds, pass 0 to disable timeout. The default value can be changed by
+     *   using the
+     *   {@link Page.setDefaultNavigationTimeout
+     *   | page.setDefaultNavigationTimeout(timeout)}
+     *   or {@link Page.setDefaultTimeout | page.setDefaultTimeout(timeout)}
+     *   methods.
+     *
+     * - `waitUntil`: When to consider navigation succeeded, defaults to `load`.
+     *    Given an array of event strings, navigation is considered to be
+     *    successful after all events have been fired. Events can be either:<br/>
+     *  - `load` : consider navigation to be finished when the load event is fired.<br/>
+     *  - `domcontentloaded` : consider navigation to be finished when the
+     *   DOMContentLoaded event is fired.<br/>
+     *  - `networkidle0` : consider navigation to be finished when there are no
+     *   more than 0 network connections for at least `500` ms.<br/>
+     *  - `networkidle2` : consider navigation to be finished when there are no
+     *   more than 2 network connections for at least `500` ms.
+     */
     goForward(options?: WaitForOptions): Promise<HTTPResponse | null>;
     private _go;
+    /**
+     * Brings page to front (activates tab).
+     */
     bringToFront(): Promise<void>;
+    /**
+     * Emulates given device metrics and user agent. This method is a shortcut for
+     * calling two methods: {@link Page.setUserAgent} and {@link Page.setViewport}
+     * To aid emulation, Puppeteer provides a list of device descriptors that can
+     * be obtained via the {@link Puppeteer.devices} `page.emulate` will resize
+     * the page. A lot of websites don't expect phones to change size, so you
+     * should emulate before navigating to the page.
+     * @example
+     * ```js
+     * const puppeteer = require('puppeteer');
+     * const iPhone = puppeteer.devices['iPhone 6'];
+     * (async () => {
+     * const browser = await puppeteer.launch();
+     * const page = await browser.newPage();
+     * await page.emulate(iPhone);
+     * await page.goto('https://www.google.com');
+     * // other actions...
+     * await browser.close();
+     * })();
+     * ```
+     * @remarks List of all available devices is available in the source code:
+     * {@link https://github.com/puppeteer/puppeteer/blob/main/src/common/DeviceDescriptors.ts | src/common/DeviceDescriptors.ts}.
+     */
     emulate(options: {
         viewport: Viewport;
         userAgent: string;
     }): Promise<void>;
+    /**
+     * @param enabled - Whether or not to enable JavaScript on the page.
+     * @returns
+     * @remarks
+     * NOTE: changing this value won't affect scripts that have already been run.
+     * It will take full effect on the next navigation.
+     */
     setJavaScriptEnabled(enabled: boolean): Promise<void>;
+    /**
+     * Toggles bypassing page's Content-Security-Policy.
+     * @param enabled - sets bypassing of page's Content-Security-Policy.
+     * @remarks
+     * NOTE: CSP bypassing happens at the moment of CSP initialization rather than
+     * evaluation. Usually, this means that `page.setBypassCSP` should be called
+     * before navigating to the domain.
+     */
     setBypassCSP(enabled: boolean): Promise<void>;
+    /**
+     * @param type - Changes the CSS media type of the page. The only allowed
+     * values are `screen`, `print` and `null`. Passing `null` disables CSS media
+     * emulation.
+     * @example
+     * ```
+     * await page.evaluate(() => matchMedia('screen').matches);
+     * // → true
+     * await page.evaluate(() => matchMedia('print').matches);
+     * // → false
+     *
+     * await page.emulateMediaType('print');
+     * await page.evaluate(() => matchMedia('screen').matches);
+     * // → false
+     * await page.evaluate(() => matchMedia('print').matches);
+     * // → true
+     *
+     * await page.emulateMediaType(null);
+     * await page.evaluate(() => matchMedia('screen').matches);
+     * // → true
+     * await page.evaluate(() => matchMedia('print').matches);
+     * // → false
+     * ```
+     */
     emulateMediaType(type?: string): Promise<void>;
+    emulateCPUThrottling(factor: number | null): Promise<void>;
+    /**
+     * @param features - `<?Array<Object>>` Given an array of media feature
+     * objects, emulates CSS media features on the page. Each media feature object
+     * must have the following properties:
+     * @example
+     * ```js
+     * await page.emulateMediaFeatures([
+     * { name: 'prefers-color-scheme', value: 'dark' },
+     * ]);
+     * await page.evaluate(() => matchMedia('(prefers-color-scheme: dark)').matches);
+     * // → true
+     * await page.evaluate(() => matchMedia('(prefers-color-scheme: light)').matches);
+     * // → false
+     *
+     * await page.emulateMediaFeatures([
+     * { name: 'prefers-reduced-motion', value: 'reduce' },
+     * ]);
+     * await page.evaluate(
+     * () => matchMedia('(prefers-reduced-motion: reduce)').matches
+     * );
+     * // → true
+     * await page.evaluate(
+     * () => matchMedia('(prefers-reduced-motion: no-preference)').matches
+     * );
+     * // → false
+     *
+     * await page.emulateMediaFeatures([
+     * { name: 'prefers-color-scheme', value: 'dark' },
+     * { name: 'prefers-reduced-motion', value: 'reduce' },
+     * ]);
+     * await page.evaluate(() => matchMedia('(prefers-color-scheme: dark)').matches);
+     * // → true
+     * await page.evaluate(() => matchMedia('(prefers-color-scheme: light)').matches);
+     * // → false
+     * await page.evaluate(
+     * () => matchMedia('(prefers-reduced-motion: reduce)').matches
+     * );
+     * // → true
+     * await page.evaluate(
+     * () => matchMedia('(prefers-reduced-motion: no-preference)').matches
+     * );
+     * // → false
+     *
+     * await page.emulateMediaFeatures([{ name: 'color-gamut', value: 'p3' }]);
+     * await page.evaluate(() => matchMedia('(color-gamut: srgb)').matches);
+     * // → true
+     * await page.evaluate(() => matchMedia('(color-gamut: p3)').matches);
+     * // → true
+     * await page.evaluate(() => matchMedia('(color-gamut: rec2020)').matches);
+     * // → false
+     * ```
+     */
     emulateMediaFeatures(features?: MediaFeature[]): Promise<void>;
+    /**
+     * @param timezoneId - Changes the timezone of the page. See
+     * {@link https://source.chromium.org/chromium/chromium/deps/icu.git/+/faee8bc70570192d82d2978a71e2a615788597d1:source/data/misc/metaZones.txt | ICU’s metaZones.txt}
+     * for a list of supported timezone IDs. Passing
+     * `null` disables timezone emulation.
+     */
     emulateTimezone(timezoneId?: string): Promise<void>;
     /**
      * Emulates the idle state.
@@ -807,8 +1419,6 @@ export declare class Page extends EventEmitter {
      * ```
      *
      * @param overrides - Mock idle state. If not set, clears idle overrides
-     * @param isUserActive - Mock isUserActive
-     * @param isScreenUnlocked - Mock isScreenUnlocked
      */
     emulateIdleState(overrides?: {
         isUserActive: boolean;
@@ -842,7 +1452,65 @@ export declare class Page extends EventEmitter {
      * @param type - the type of deficiency to simulate, or `'none'` to reset.
      */
     emulateVisionDeficiency(type?: Protocol.Emulation.SetEmulatedVisionDeficiencyRequest['type']): Promise<void>;
+    /**
+     * `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.
+     * @example
+     * ```js
+     * const page = await browser.newPage();
+     * await page.setViewport({
+     * width: 640,
+     * height: 480,
+     * deviceScaleFactor: 1,
+     * });
+     * await page.goto('https://example.com');
+     * ```
+     *
+     * @param viewport -
+     * @remarks
+     * Argument viewport have following properties:
+     *
+     * - `width`: page width in pixels. required
+     *
+     * - `height`: page height in pixels. required
+     *
+     * - `deviceScaleFactor`: Specify device scale factor (can be thought of as
+     *   DPR). Defaults to `1`.
+     *
+     * - `isMobile`: Whether the meta viewport tag is taken into account. Defaults
+     *   to `false`.
+     *
+     * - `hasTouch`: Specifies if viewport supports touch events. Defaults to `false`
+     *
+     * - `isLandScape`: Specifies if viewport is in landscape mode. Defaults to false.
+     *
+     * NOTE: in certain cases, setting viewport will reload the page in order to
+     * set the isMobile or hasTouch properties.
+     */
     setViewport(viewport: Viewport): Promise<void>;
+    /**
+     * @returns
+     *
+     * - `width`: page's width in pixels
+     *
+     * - `height`: page's height in pixels
+     *
+     * - `deviceScalarFactor`: Specify device scale factor (can be though of as
+     *   dpr). Defaults to `1`.
+     *
+     * - `isMobile`: Whether the meta viewport tag is taken into account. Defaults
+     *   to `false`.
+     *
+     * - `hasTouch`: Specifies if viewport supports touch events. Defaults to
+     *   `false`.
+     *
+     * - `isLandScape`: Specifies if viewport is in landscape mode. Defaults to
+     *   `false`.
+     */
     viewport(): Viewport | null;
     /**
      * @remarks
@@ -893,15 +1561,90 @@ export declare class Page extends EventEmitter {
      * @returns the return value of `pageFunction`.
      */
     evaluate<T extends EvaluateFn>(pageFunction: T, ...args: SerializableOrJSHandle[]): Promise<UnwrapPromiseLike<EvaluateFnReturnType<T>>>;
+    /**
+     * 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`.
+     * @param pageFunction - Function to be evaluated in browser context
+     * @param args - Arguments to pass to `pageFunction`
+     * @example
+     * An example of overriding the navigator.languages property before the page loads:
+     * ```js
+     * // preload.js
+     *
+     * // overwrite the `languages` property to use a custom getter
+     * Object.defineProperty(navigator, 'languages', {
+     * get: function () {
+     * return ['en-US', 'en', 'bn'];
+     * },
+     * });
+     *
+     * // In your puppeteer script, assuming the preload.js file is
+     * in same folder of our script
+     * const preloadFile = fs.readFileSync('./preload.js', 'utf8');
+     * await page.evaluateOnNewDocument(preloadFile);
+     * ```
+     */
     evaluateOnNewDocument(pageFunction: Function | string, ...args: unknown[]): Promise<void>;
+    /**
+     * Toggles ignoring cache for each request based on the enabled state. By
+     * default, caching is enabled.
+     * @param enabled - sets the `enabled` state of cache
+     */
     setCacheEnabled(enabled?: boolean): Promise<void>;
+    /**
+     * @remarks
+     * Options object which might have the following properties:
+     *
+     * - `path` : The file path to save the image to. The screenshot type
+     *   will be inferred from file extension. If `path` is a relative path, then
+     *   it is resolved relative to
+     *   {@link https://nodejs.org/api/process.html#process_process_cwd
+     *   | current working directory}.
+     *   If no path is provided, the image won't be saved to the disk.
+     *
+     * - `type` : Specify screenshot type, can be either `jpeg` or `png`.
+     *   Defaults to 'png'.
+     *
+     * - `quality` : The quality of the image, between 0-100. Not
+     *   applicable to `png` images.
+     *
+     * - `fullPage` : When true, takes a screenshot of the full
+     *   scrollable page. Defaults to `false`
+     *
+     * - `clip` : An object which specifies clipping region of the page.
+     *   Should have the following fields:<br/>
+     *  - `x` : x-coordinate of top-left corner of clip area.<br/>
+     *  - `y` :  y-coordinate of top-left corner of clip area.<br/>
+     *  - `width` : width of clipping area.<br/>
+     *  - `height` : height of clipping area.
+     *
+     * - `omitBackground` : Hides default white background and allows
+     *   capturing screenshots with transparency. Defaults to `false`
+     *
+     * - `encoding` : The encoding of the image, can be either base64 or
+     *   binary. Defaults to `binary`.
+     *
+     *
+     * 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.
+     */
     screenshot(options?: ScreenshotOptions): Promise<Buffer | string | void>;
     private _screenshotTask;
     /**
      * Generatees a PDF of the page with the `print` CSS media type.
      * @remarks
      *
-     * IMPORTANT: PDF generation is only supported in Chrome headless mode.
+     * NOTE: PDF generation is only supported in Chrome headless mode.
      *
      * To generate a PDF with the `screen` media type, call
      * {@link Page.emulateMediaType | `page.emulateMediaType('screen')`} before
@@ -915,22 +1658,141 @@ export declare class Page extends EventEmitter {
      *
      * @param options - options for generating the PDF.
      */
+    createPDFStream(options?: PDFOptions): Promise<Readable>;
+    /**
+     * @param options -
+     * @returns
+     */
     pdf(options?: PDFOptions): Promise<Buffer>;
+    /**
+     * @returns The page's title
+     * @remarks
+     * Shortcut for {@link Frame.title | page.mainFrame().title()}.
+     */
     title(): Promise<string>;
     close(options?: {
         runBeforeUnload?: boolean;
     }): Promise<void>;
+    /**
+     * Indicates that the page has been closed.
+     * @returns
+     */
     isClosed(): boolean;
     get mouse(): Mouse;
+    /**
+     * This method fetches an element with `selector`, scrolls it into view if
+     * needed, and then uses {@link Page.mouse} to click in the center of the
+     * element. If there's no element matching `selector`, the method throws an
+     * error.
+     * @remarks Bear in mind that if `click()` triggers a navigation event and
+     * there's a separate `page.waitForNavigation()` promise to be resolved, you
+     * may end up with a race condition that yields unexpected results. The
+     * correct pattern for click and wait for navigation is the following:
+     * ```js
+     * const [response] = await Promise.all([
+     * page.waitForNavigation(waitOptions),
+     * page.click(selector, clickOptions),
+     * ]);
+     * ```
+     * Shortcut for {@link Frame.click | page.mainFrame().click(selector[, options]) }.
+     * @param selector - A `selector` to search for element to click. If there are
+     * multiple elements satisfying the `selector`, the first will be clicked
+     * @param options - `Object`
+     * @returns Promise which resolves when the element matching `selector` is
+     * successfully clicked. The Promise will be rejected if there is no element
+     * matching `selector`.
+     */
     click(selector: string, options?: {
         delay?: number;
         button?: MouseButton;
         clickCount?: number;
     }): Promise<void>;
+    /**
+     * This method fetches an element with `selector` and focuses it. If there's no
+     * element matching `selector`, the method throws an error.
+     * @param selector - A
+     * {@link https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Selectors | selector }
+     * of an element to focus. If there are multiple elements satisfying the
+     * selector, the first will be focused.
+     * @returns  Promise which resolves when the element matching selector is
+     * successfully focused. The promise will be rejected if there is no element
+     * matching selector.
+     * @remarks
+     * Shortcut for {@link Frame.focus | page.mainFrame().focus(selector)}.
+     */
     focus(selector: string): Promise<void>;
+    /**
+     * This method fetches an element with `selector`, scrolls it into view if
+     * needed, and then uses {@link Page.mouse} to hover over the center of the element.
+     * If there's no element matching `selector`, the method throws an error.
+     * @param selector - A
+     * {@link https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Selectors | selector}
+     * to search for element to hover. If there are multiple elements satisfying
+     * the selector, the first will be hovered.
+     * @returns Promise which resolves when the element matching `selector` is
+     * successfully hovered. Promise gets rejected if there's no element matching
+     * `selector`.
+     * @remarks
+     * Shortcut for {@link Page.hover | page.mainFrame().hover(selector)}.
+     */
     hover(selector: string): Promise<void>;
+    /**
+     * 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.
+     *
+     * @example
+     * ```js
+     * page.select('select#colors', 'blue'); // single selection
+     * page.select('select#colors', 'red', 'green', 'blue'); // multiple selections
+     * ```
+     * @param selector - A
+     * {@link https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Selectors | Selector}
+     * to query the page for
+     * @param values - Values of options to select. If the `<select>` has the
+     * `multiple` attribute, all values are considered, otherwise only the first one
+     * is taken into account.
+     * @returns
+     *
+     * @remarks
+     * Shortcut for {@link Frame.select | page.mainFrame().select()}
+     */
     select(selector: string, ...values: string[]): Promise<string[]>;
+    /**
+     * This method fetches an element with `selector`, scrolls it into view if
+     * needed, and then uses {@link Page.touchscreen} to tap in the center of the element.
+     * If there's no element matching `selector`, the method throws an error.
+     * @param selector - A
+     * {@link https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Selectors | Selector}
+     * to search for element to tap. If there are multiple elements satisfying the
+     * selector, the first will be tapped.
+     * @returns
+     * @remarks
+     * Shortcut for {@link Frame.tap | page.mainFrame().tap(selector)}.
+     */
     tap(selector: string): Promise<void>;
+    /**
+     * Sends a `keydown`, `keypress/input`, and `keyup` event for each character
+     * in the text.
+     *
+     * To press a special key, like `Control` or `ArrowDown`, use {@link Keyboard.press}.
+     * @example
+     * ```
+     * await page.type('#mytextarea', 'Hello');
+     * // Types instantly
+     * await page.type('#mytextarea', 'World', { delay: 100 });
+     * // Types slower, like a user
+     * ```
+     * @param selector - A
+     * {@link https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Selectors | selector}
+     * of an element to type into. If there are multiple elements satisfying the
+     * selector, the first will be used.
+     * @param text - A text to type into a focused element.
+     * @param options - have property `delay` which is the Time to wait between
+     * key presses in milliseconds. Defaults to `0`.
+     * @returns
+     * @remarks
+     */
     type(selector: string, text: string, options?: {
         delay: number;
     }): Promise<void>;
@@ -985,16 +1847,178 @@ export declare class Page extends EventEmitter {
      * @param milliseconds - the number of milliseconds to wait.
      */
     waitForTimeout(milliseconds: number): Promise<void>;
+    /**
+     * 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.
+     *
+     * This method works across navigations:
+     * ```js
+     * const puppeteer = require('puppeteer');
+     * (async () => {
+     * const browser = await puppeteer.launch();
+     * const page = await browser.newPage();
+     * let currentURL;
+     * page
+     * .waitForSelector('img')
+     * .then(() => console.log('First URL with image: ' + currentURL));
+     * for (currentURL of [
+     * 'https://example.com',
+     * 'https://google.com',
+     * 'https://bbc.com',
+     * ]) {
+     * await page.goto(currentURL);
+     * }
+     * await browser.close();
+     * })();
+     * ```
+     * @param selector - A
+     * {@link https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Selectors | selector}
+     * of an element to wait for
+     * @param options - Optional waiting parameters
+     * @returns Promise which resolves when element specified by selector string
+     * is added to DOM. Resolves to `null` if waiting for hidden: `true` and
+     * selector is not found in DOM.
+     * @remarks
+     * The optional Parameter in Arguments `options` are :
+     *
+     * - `Visible`: A boolean wait for element to be present in DOM and to be
+     * visible, i.e. to not have `display: none` or `visibility: hidden` CSS
+     * properties. Defaults to `false`.
+     *
+     * - `hidden`: ait for element to not be found in the DOM or to be hidden,
+     * i.e. have `display: none` or `visibility: hidden` CSS properties. Defaults to
+     * `false`.
+     *
+     * - `timeout`: maximum time to wait for in milliseconds. Defaults to `30000`
+     * (30 seconds). Pass `0` to disable timeout. The default value can be changed
+     * by using the {@link Page.setDefaultTimeout} method.
+     */
     waitForSelector(selector: string, options?: {
         visible?: boolean;
         hidden?: boolean;
         timeout?: number;
     }): Promise<ElementHandle | null>;
+    /**
+     * 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.
+     *
+     * This method works across navigation
+     * ```js
+     * const puppeteer = require('puppeteer');
+     * (async () => {
+     * const browser = await puppeteer.launch();
+     * const page = await browser.newPage();
+     * let currentURL;
+     * page
+     * .waitForXPath('//img')
+     * .then(() => console.log('First URL with image: ' + currentURL));
+     * for (currentURL of [
+     * 'https://example.com',
+     * 'https://google.com',
+     * 'https://bbc.com',
+     * ]) {
+     * await page.goto(currentURL);
+     * }
+     * await browser.close();
+     * })();
+     * ```
+     * @param xpath - A
+     * {@link https://developer.mozilla.org/en-US/docs/Web/XPath | xpath} of an
+     * element to wait for
+     * @param options - Optional waiting parameters
+     * @returns Promise which resolves when element specified by xpath string is
+     * added to DOM. Resolves to `null` if waiting for `hidden: true` and xpath is
+     * not found in DOM.
+     * @remarks
+     * The optional Argument `options` have properties:
+     *
+     * - `visible`: A boolean to wait for element to be present in DOM and to be
+     * visible, i.e. to not have `display: none` or `visibility: hidden` CSS
+     * properties. Defaults to `false`.
+     *
+     * - `hidden`: A boolean wait for element to not be found in the DOM or to be
+     * hidden, i.e. have `display: none` or `visibility: hidden` CSS properties.
+     * Defaults to `false`.
+     *
+     * - `timeout`: A number which is maximum time to wait for in milliseconds.
+     * Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default
+     * value can be changed by using the {@link Page.setDefaultTimeout} method.
+     */
     waitForXPath(xpath: string, options?: {
         visible?: boolean;
         hidden?: boolean;
         timeout?: number;
     }): Promise<ElementHandle | null>;
+    /**
+     * The `waitForFunction` can be used to observe viewport size change:
+     *
+     * ```
+     * const puppeteer = require('puppeteer');
+     * (async () => {
+     * const browser = await puppeteer.launch();
+     * const page = await browser.newPage();
+     * const watchDog = page.waitForFunction('window.innerWidth < 100');
+     * await page.setViewport({ width: 50, height: 50 });
+     * await watchDog;
+     * await browser.close();
+     * })();
+     * ```
+     * To pass arguments from node.js to the predicate of `page.waitForFunction` function:
+     * ```
+     * const selector = '.foo';
+     * await page.waitForFunction(
+     * (selector) => !!document.querySelector(selector),
+     * {},
+     * selector
+     * );
+     * ```
+     * The predicate of `page.waitForFunction` can be asynchronous too:
+     * ```
+     * const username = 'github-username';
+     * await page.waitForFunction(
+     * async (username) => {
+     * const githubResponse = await fetch(
+     *  `https://api.github.com/users/${username}`
+     * );
+     * const githubUser = await githubResponse.json();
+     * // show the avatar
+     * const img = document.createElement('img');
+     * img.src = githubUser.avatar_url;
+     * // wait 3 seconds
+     * await new Promise((resolve, reject) => setTimeout(resolve, 3000));
+     * img.remove();
+     * },
+     * {},
+     * username
+     * );
+     * ```
+     * @param pageFunction - Function to be evaluated in browser context
+     * @param options - Optional waiting parameters
+     * @param args -  Arguments to pass to `pageFunction`
+     * @returns Promise which resolves when the `pageFunction` returns a truthy
+     * value. It resolves to a JSHandle of the truthy value.
+     *
+     * The optional waiting parameter can be:
+     *
+     * - `Polling`: An interval at which the `pageFunction` is executed, defaults to
+     *   `raf`. If `polling` is a number, then it is treated as an interval in
+     *   milliseconds at which the function would be executed. If polling is a
+     *   string, then it can be one of the following values:<br/>
+     *    - `raf`: to constantly execute `pageFunction` in `requestAnimationFrame`
+     *      callback. This is the tightest polling mode which is suitable to
+     *      observe styling changes.<br/>
+     *    - `mutation`: to execute pageFunction on every DOM mutation.
+     *
+     * - `timeout`: maximum time to wait for in milliseconds. Defaults to `30000`
+     * (30 seconds). Pass `0` to disable timeout. The default value can be changed
+     * by using the
+     * {@link Page.setDefaultTimeout | page.setDefaultTimeout(timeout)} method.
+     *
+     */
     waitForFunction(pageFunction: Function | string, options?: {
         timeout?: number;
         polling?: string | number;