2590 lines
81 KiB
TypeScript
2590 lines
81 KiB
TypeScript
/**
|
||
* Copyright 2017 Google Inc. All rights reserved.
|
||
*
|
||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||
* you may not use this file except in compliance with the License.
|
||
* You may obtain a copy of the License at
|
||
*
|
||
* http://www.apache.org/licenses/LICENSE-2.0
|
||
*
|
||
* Unless required by applicable law or agreed to in writing, software
|
||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||
* See the License for the specific language governing permissions and
|
||
* limitations under the License.
|
||
*/
|
||
|
||
import {Protocol} from 'devtools-protocol';
|
||
import type {Readable} from 'stream';
|
||
import type {Accessibility} from '../common/Accessibility.js';
|
||
import type {ConsoleMessage} from '../common/ConsoleMessage.js';
|
||
import type {Coverage} from '../common/Coverage.js';
|
||
import {Device} from '../common/Device.js';
|
||
import type {Dialog} from '../common/Dialog.js';
|
||
import type {ElementHandle} from '../common/ElementHandle.js';
|
||
import {EventEmitter, Handler} from '../common/EventEmitter.js';
|
||
import type {FileChooser} from '../common/FileChooser.js';
|
||
import type {
|
||
Frame,
|
||
FrameAddScriptTagOptions,
|
||
FrameAddStyleTagOptions,
|
||
FrameWaitForFunctionOptions,
|
||
} from '../common/Frame.js';
|
||
import type {HTTPRequest} from '../common/HTTPRequest.js';
|
||
import type {HTTPResponse} from '../common/HTTPResponse.js';
|
||
import type {
|
||
Keyboard,
|
||
Mouse,
|
||
MouseButton,
|
||
Touchscreen,
|
||
} from '../common/Input.js';
|
||
import type {WaitForSelectorOptions} from '../common/IsolatedWorld.js';
|
||
import type {JSHandle} from '../common/JSHandle.js';
|
||
import type {PuppeteerLifeCycleEvent} from '../common/LifecycleWatcher.js';
|
||
import type {Credentials, NetworkConditions} from '../common/NetworkManager.js';
|
||
import type {PDFOptions} from '../common/PDFOptions.js';
|
||
import type {Viewport} from '../common/PuppeteerViewport.js';
|
||
import type {Target} from '../common/Target.js';
|
||
import type {Tracing} from '../common/Tracing.js';
|
||
import type {EvaluateFunc, HandleFor, NodeFor} from '../common/types.js';
|
||
import type {WebWorker} from '../common/WebWorker.js';
|
||
import type {Browser} from './Browser.js';
|
||
import type {BrowserContext} from './BrowserContext.js';
|
||
|
||
/**
|
||
* @public
|
||
*/
|
||
export interface Metrics {
|
||
Timestamp?: number;
|
||
Documents?: number;
|
||
Frames?: number;
|
||
JSEventListeners?: number;
|
||
Nodes?: number;
|
||
LayoutCount?: number;
|
||
RecalcStyleCount?: number;
|
||
LayoutDuration?: number;
|
||
RecalcStyleDuration?: number;
|
||
ScriptDuration?: number;
|
||
TaskDuration?: number;
|
||
JSHeapUsedSize?: number;
|
||
JSHeapTotalSize?: number;
|
||
}
|
||
|
||
/**
|
||
* @public
|
||
*/
|
||
export interface WaitTimeoutOptions {
|
||
/**
|
||
* Maximum wait time in milliseconds. Pass 0 to disable the timeout.
|
||
*
|
||
* The default value can be changed by using the
|
||
* {@link Page.setDefaultTimeout} method.
|
||
*
|
||
* @defaultValue `30000`
|
||
*/
|
||
timeout?: number;
|
||
}
|
||
|
||
/**
|
||
* @public
|
||
*/
|
||
export interface WaitForOptions {
|
||
/**
|
||
* Maximum wait time in milliseconds. Pass 0 to disable the timeout.
|
||
*
|
||
* The default value can be changed by using the
|
||
* {@link Page.setDefaultTimeout} or {@link Page.setDefaultNavigationTimeout}
|
||
* methods.
|
||
*
|
||
* @defaultValue `30000`
|
||
*/
|
||
timeout?: number;
|
||
waitUntil?: PuppeteerLifeCycleEvent | PuppeteerLifeCycleEvent[];
|
||
}
|
||
|
||
/**
|
||
* @public
|
||
*/
|
||
export interface GeolocationOptions {
|
||
/**
|
||
* Latitude between `-90` and `90`.
|
||
*/
|
||
longitude: number;
|
||
/**
|
||
* Longitude between `-180` and `180`.
|
||
*/
|
||
latitude: number;
|
||
/**
|
||
* Optional non-negative accuracy value.
|
||
*/
|
||
accuracy?: number;
|
||
}
|
||
|
||
/**
|
||
* @public
|
||
*/
|
||
export interface MediaFeature {
|
||
name: string;
|
||
value: string;
|
||
}
|
||
|
||
/**
|
||
* @public
|
||
*/
|
||
export interface ScreenshotClip {
|
||
x: number;
|
||
y: number;
|
||
width: number;
|
||
height: number;
|
||
/**
|
||
* @defaultValue 1
|
||
*/
|
||
scale?: number;
|
||
}
|
||
|
||
/**
|
||
* @public
|
||
*/
|
||
export interface ScreenshotOptions {
|
||
/**
|
||
* @defaultValue `png`
|
||
*/
|
||
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
|
||
* relative to current working directory. If no path is provided, the image
|
||
* won't be saved to the disk.
|
||
*/
|
||
path?: string;
|
||
/**
|
||
* When `true`, takes a screenshot of the full page.
|
||
* @defaultValue `false`
|
||
*/
|
||
fullPage?: boolean;
|
||
/**
|
||
* An object which specifies the clipping region of the page.
|
||
*/
|
||
clip?: ScreenshotClip;
|
||
/**
|
||
* Quality of the image, between 0-100. Not applicable to `png` images.
|
||
*/
|
||
quality?: number;
|
||
/**
|
||
* Hides default white background and allows capturing screenshots with transparency.
|
||
* @defaultValue `false`
|
||
*/
|
||
omitBackground?: boolean;
|
||
/**
|
||
* Encoding of the image.
|
||
* @defaultValue `binary`
|
||
*/
|
||
encoding?: 'base64' | 'binary';
|
||
/**
|
||
* Capture the screenshot beyond the viewport.
|
||
* @defaultValue `true`
|
||
*/
|
||
captureBeyondViewport?: boolean;
|
||
/**
|
||
* Capture the screenshot from the surface, rather than the view.
|
||
* @defaultValue `true`
|
||
*/
|
||
fromSurface?: boolean;
|
||
}
|
||
|
||
/**
|
||
* All the events that a page instance may emit.
|
||
*
|
||
* @public
|
||
*/
|
||
export const enum PageEmittedEvents {
|
||
/**
|
||
* Emitted when the page closes.
|
||
* @eventProperty
|
||
*/
|
||
Close = 'close',
|
||
/**
|
||
* Emitted when JavaScript within the page calls one of console API methods,
|
||
* e.g. `console.log` or `console.dir`. Also emitted if the page throws an
|
||
* error or a warning.
|
||
*
|
||
* @remarks
|
||
* A `console` event provides a {@link ConsoleMessage} representing the
|
||
* console message that was logged.
|
||
*
|
||
* @example
|
||
* An example of handling `console` event:
|
||
*
|
||
* ```ts
|
||
* page.on('console', msg => {
|
||
* for (let i = 0; i < msg.args().length; ++i)
|
||
* console.log(`${i}: ${msg.args()[i]}`);
|
||
* });
|
||
* page.evaluate(() => console.log('hello', 5, {foo: 'bar'}));
|
||
* ```
|
||
*/
|
||
Console = 'console',
|
||
/**
|
||
* Emitted when a JavaScript dialog appears, such as `alert`, `prompt`,
|
||
* `confirm` or `beforeunload`. Puppeteer can respond to the dialog via
|
||
* {@link Dialog.accept} or {@link Dialog.dismiss}.
|
||
*/
|
||
Dialog = 'dialog',
|
||
/**
|
||
* Emitted when the JavaScript
|
||
* {@link https://developer.mozilla.org/en-US/docs/Web/Events/DOMContentLoaded | DOMContentLoaded }
|
||
* event is dispatched.
|
||
*/
|
||
DOMContentLoaded = 'domcontentloaded',
|
||
/**
|
||
* Emitted when the page crashes. Will contain an `Error`.
|
||
*/
|
||
Error = 'error',
|
||
/** Emitted when a frame is attached. Will contain a {@link Frame}. */
|
||
FrameAttached = 'frameattached',
|
||
/** Emitted when a frame is detached. Will contain a {@link Frame}. */
|
||
FrameDetached = 'framedetached',
|
||
/**
|
||
* Emitted when a frame is navigated to a new URL. Will contain a
|
||
* {@link Frame}.
|
||
*/
|
||
FrameNavigated = 'framenavigated',
|
||
/**
|
||
* Emitted when the JavaScript
|
||
* {@link https://developer.mozilla.org/en-US/docs/Web/Events/load | load}
|
||
* event is dispatched.
|
||
*/
|
||
Load = 'load',
|
||
/**
|
||
* Emitted when the JavaScript code makes a call to `console.timeStamp`. For
|
||
* the list of metrics see {@link Page.metrics | page.metrics}.
|
||
*
|
||
* @remarks
|
||
* Contains an object with two properties:
|
||
*
|
||
* - `title`: the title passed to `console.timeStamp`
|
||
* - `metrics`: objec containing metrics as key/value pairs. The values will
|
||
* be `number`s.
|
||
*/
|
||
Metrics = 'metrics',
|
||
/**
|
||
* Emitted when an uncaught exception happens within the page. Contains an
|
||
* `Error`.
|
||
*/
|
||
PageError = 'pageerror',
|
||
/**
|
||
* Emitted when the page opens a new tab or window.
|
||
*
|
||
* Contains a {@link Page} corresponding to the popup window.
|
||
*
|
||
* @example
|
||
*
|
||
* ```ts
|
||
* const [popup] = await Promise.all([
|
||
* new Promise(resolve => page.once('popup', resolve)),
|
||
* page.click('a[target=_blank]'),
|
||
* ]);
|
||
* ```
|
||
*
|
||
* ```ts
|
||
* const [popup] = await Promise.all([
|
||
* new Promise(resolve => page.once('popup', resolve)),
|
||
* page.evaluate(() => window.open('https://example.com')),
|
||
* ]);
|
||
* ```
|
||
*/
|
||
Popup = 'popup',
|
||
/**
|
||
* Emitted when a page issues a request and contains a {@link HTTPRequest}.
|
||
*
|
||
* @remarks
|
||
* The object is readonly. See {@link Page.setRequestInterception} for
|
||
* intercepting and mutating requests.
|
||
*/
|
||
Request = 'request',
|
||
/**
|
||
* Emitted when a request ended up loading from cache. Contains a
|
||
* {@link HTTPRequest}.
|
||
*
|
||
* @remarks
|
||
* For certain requests, might contain undefined.
|
||
* {@link https://crbug.com/750469}
|
||
*/
|
||
RequestServedFromCache = 'requestservedfromcache',
|
||
/**
|
||
* Emitted when a request fails, for example by timing out.
|
||
*
|
||
* Contains a {@link HTTPRequest}.
|
||
*
|
||
* @remarks
|
||
* HTTP Error responses, such as 404 or 503, are still successful responses
|
||
* from HTTP standpoint, so request will complete with `requestfinished` event
|
||
* and not with `requestfailed`.
|
||
*/
|
||
RequestFailed = 'requestfailed',
|
||
/**
|
||
* Emitted when a request finishes successfully. Contains a
|
||
* {@link HTTPRequest}.
|
||
*/
|
||
RequestFinished = 'requestfinished',
|
||
/**
|
||
* Emitted when a response is received. Contains a {@link HTTPResponse}.
|
||
*/
|
||
Response = 'response',
|
||
/**
|
||
* Emitted when a dedicated
|
||
* {@link https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API | WebWorker}
|
||
* is spawned by the page.
|
||
*/
|
||
WorkerCreated = 'workercreated',
|
||
/**
|
||
* Emitted when a dedicated
|
||
* {@link https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API | WebWorker}
|
||
* is destroyed by the page.
|
||
*/
|
||
WorkerDestroyed = 'workerdestroyed',
|
||
}
|
||
|
||
/**
|
||
* Denotes the objects received by callback functions for page events.
|
||
*
|
||
* See {@link PageEmittedEvents} for more detail on the events and when they are
|
||
* emitted.
|
||
*
|
||
* @public
|
||
*/
|
||
export interface PageEventObject {
|
||
close: never;
|
||
console: ConsoleMessage;
|
||
dialog: Dialog;
|
||
domcontentloaded: never;
|
||
error: Error;
|
||
frameattached: Frame;
|
||
framedetached: Frame;
|
||
framenavigated: Frame;
|
||
load: never;
|
||
metrics: {title: string; metrics: Metrics};
|
||
pageerror: Error;
|
||
popup: Page;
|
||
request: HTTPRequest;
|
||
response: HTTPResponse;
|
||
requestfailed: HTTPRequest;
|
||
requestfinished: HTTPRequest;
|
||
requestservedfromcache: HTTPRequest;
|
||
workercreated: WebWorker;
|
||
workerdestroyed: WebWorker;
|
||
}
|
||
|
||
/**
|
||
* Page provides methods to interact with a single tab or
|
||
* {@link https://developer.chrome.com/extensions/background_pages | extension background page}
|
||
* in Chromium.
|
||
*
|
||
* :::note
|
||
*
|
||
* One Browser instance might have multiple Page instances.
|
||
*
|
||
* :::
|
||
*
|
||
* @example
|
||
* This example creates a page, navigates it to a URL, and then saves a screenshot:
|
||
*
|
||
* ```ts
|
||
* const puppeteer = require('puppeteer');
|
||
*
|
||
* (async () => {
|
||
* const browser = await puppeteer.launch();
|
||
* const page = await browser.newPage();
|
||
* await page.goto('https://example.com');
|
||
* await page.screenshot({path: 'screenshot.png'});
|
||
* await browser.close();
|
||
* })();
|
||
* ```
|
||
*
|
||
* The Page class extends from Puppeteer's {@link EventEmitter} class and will
|
||
* emit various events which are documented in the {@link PageEmittedEvents} enum.
|
||
*
|
||
* @example
|
||
* This example logs a message for a single page `load` event:
|
||
*
|
||
* ```ts
|
||
* page.once('load', () => console.log('Page loaded!'));
|
||
* ```
|
||
*
|
||
* To unsubscribe from events use the {@link Page.off} method:
|
||
*
|
||
* ```ts
|
||
* function logRequest(interceptedRequest) {
|
||
* console.log('A request was made:', interceptedRequest.url());
|
||
* }
|
||
* page.on('request', logRequest);
|
||
* // Sometime later...
|
||
* page.off('request', logRequest);
|
||
* ```
|
||
*
|
||
* @public
|
||
*/
|
||
export class Page extends EventEmitter {
|
||
#handlerMap = new WeakMap<Handler, Handler>();
|
||
|
||
/**
|
||
* @internal
|
||
*/
|
||
constructor() {
|
||
super();
|
||
}
|
||
|
||
/**
|
||
* @returns `true` if drag events are being intercepted, `false` otherwise.
|
||
*/
|
||
isDragInterceptionEnabled(): boolean {
|
||
throw new Error('Not implemented');
|
||
}
|
||
|
||
/**
|
||
* @returns `true` if the page has JavaScript enabled, `false` otherwise.
|
||
*/
|
||
isJavaScriptEnabled(): boolean {
|
||
throw new Error('Not implemented');
|
||
}
|
||
|
||
/**
|
||
* Listen to page events.
|
||
*
|
||
* :::note
|
||
*
|
||
* This method exists to define event typings and handle proper wireup of
|
||
* cooperative request interception. Actual event listening and dispatching is
|
||
* delegated to {@link EventEmitter}.
|
||
*
|
||
* :::
|
||
*/
|
||
override on<K extends keyof PageEventObject>(
|
||
eventName: K,
|
||
handler: (event: PageEventObject[K]) => void
|
||
): EventEmitter {
|
||
if (eventName === 'request') {
|
||
const wrap =
|
||
this.#handlerMap.get(handler) ||
|
||
((event: HTTPRequest) => {
|
||
event.enqueueInterceptAction(() => {
|
||
return handler(event as PageEventObject[K]);
|
||
});
|
||
});
|
||
|
||
this.#handlerMap.set(handler, wrap);
|
||
|
||
return super.on(eventName, wrap);
|
||
}
|
||
return super.on(eventName, handler);
|
||
}
|
||
|
||
override once<K extends keyof PageEventObject>(
|
||
eventName: K,
|
||
handler: (event: PageEventObject[K]) => void
|
||
): EventEmitter {
|
||
// Note: this method only exists to define the types; we delegate the impl
|
||
// to EventEmitter.
|
||
return super.once(eventName, handler);
|
||
}
|
||
|
||
override off<K extends keyof PageEventObject>(
|
||
eventName: K,
|
||
handler: (event: PageEventObject[K]) => void
|
||
): EventEmitter {
|
||
if (eventName === 'request') {
|
||
handler = this.#handlerMap.get(handler) || handler;
|
||
}
|
||
|
||
return super.off(eventName, handler);
|
||
}
|
||
|
||
/**
|
||
* This method is typically coupled with an action that triggers file
|
||
* choosing.
|
||
*
|
||
* :::caution
|
||
*
|
||
* This must be called before the file chooser is launched. It will not return
|
||
* a currently active file chooser.
|
||
*
|
||
* :::
|
||
*
|
||
* @remarks
|
||
* In non-headless Chromium, this method results in the native file picker
|
||
* dialog `not showing up` for the user.
|
||
*
|
||
* @example
|
||
* 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.
|
||
*
|
||
* ```ts
|
||
* const [fileChooser] = await Promise.all([
|
||
* page.waitForFileChooser(),
|
||
* page.click('#upload-file-button'),
|
||
* // some button that triggers file selection
|
||
* ]);
|
||
* await fileChooser.accept(['/tmp/myfile.pdf']);
|
||
* ```
|
||
*/
|
||
waitForFileChooser(options?: WaitTimeoutOptions): Promise<FileChooser>;
|
||
waitForFileChooser(): Promise<FileChooser> {
|
||
throw new Error('Not implemented');
|
||
}
|
||
|
||
/**
|
||
* Sets the page's geolocation.
|
||
*
|
||
* @remarks
|
||
* Consider using {@link BrowserContext.overridePermissions} to grant
|
||
* permissions for the page to read its geolocation.
|
||
*
|
||
* @example
|
||
*
|
||
* ```ts
|
||
* await page.setGeolocation({latitude: 59.95, longitude: 30.31667});
|
||
* ```
|
||
*/
|
||
async setGeolocation(options: GeolocationOptions): Promise<void>;
|
||
async setGeolocation(): Promise<void> {
|
||
throw new Error('Not implemented');
|
||
}
|
||
|
||
/**
|
||
* @returns A target this page was created from.
|
||
*/
|
||
target(): Target {
|
||
throw new Error('Not implemented');
|
||
}
|
||
|
||
/**
|
||
* Get the browser the page belongs to.
|
||
*/
|
||
browser(): Browser {
|
||
throw new Error('Not implemented');
|
||
}
|
||
|
||
/**
|
||
* Get the browser context that the page belongs to.
|
||
*/
|
||
browserContext(): BrowserContext {
|
||
throw new Error('Not implemented');
|
||
}
|
||
|
||
/**
|
||
* @returns The page's main frame.
|
||
*
|
||
* @remarks
|
||
* Page is guaranteed to have a main frame which persists during navigations.
|
||
*/
|
||
mainFrame(): Frame {
|
||
throw new Error('Not implemented');
|
||
}
|
||
|
||
get keyboard(): Keyboard {
|
||
throw new Error('Not implemented');
|
||
}
|
||
|
||
get touchscreen(): Touchscreen {
|
||
throw new Error('Not implemented');
|
||
}
|
||
|
||
get coverage(): Coverage {
|
||
throw new Error('Not implemented');
|
||
}
|
||
|
||
get tracing(): Tracing {
|
||
throw new Error('Not implemented');
|
||
}
|
||
|
||
get accessibility(): Accessibility {
|
||
throw new Error('Not implemented');
|
||
}
|
||
|
||
/**
|
||
* @returns An array of all frames attached to the page.
|
||
*/
|
||
frames(): Frame[] {
|
||
throw new Error('Not implemented');
|
||
}
|
||
|
||
/**
|
||
* @returns all of the dedicated {@link
|
||
* https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API |
|
||
* WebWorkers} associated with the page.
|
||
*
|
||
* @remarks
|
||
* This does not contain ServiceWorkers
|
||
*/
|
||
workers(): WebWorker[] {
|
||
throw new Error('Not implemented');
|
||
}
|
||
|
||
/**
|
||
* Activating request interception enables {@link HTTPRequest.abort},
|
||
* {@link HTTPRequest.continue} and {@link HTTPRequest.respond} methods. This
|
||
* provides the capability to modify network requests that are made by a page.
|
||
*
|
||
* Once request interception is enabled, every request will stall unless it's
|
||
* continued, responded or aborted; or completed using the browser cache.
|
||
*
|
||
* Enabling request interception disables page caching.
|
||
*
|
||
* See the
|
||
* {@link https://pptr.dev/next/guides/request-interception|Request interception guide}
|
||
* for more details.
|
||
*
|
||
* @example
|
||
* An example of a naïve request interceptor that aborts all image requests:
|
||
*
|
||
* ```ts
|
||
* const puppeteer = require('puppeteer');
|
||
* (async () => {
|
||
* const browser = await puppeteer.launch();
|
||
* const page = await browser.newPage();
|
||
* await page.setRequestInterception(true);
|
||
* page.on('request', interceptedRequest => {
|
||
* if (
|
||
* interceptedRequest.url().endsWith('.png') ||
|
||
* interceptedRequest.url().endsWith('.jpg')
|
||
* )
|
||
* interceptedRequest.abort();
|
||
* else interceptedRequest.continue();
|
||
* });
|
||
* await page.goto('https://example.com');
|
||
* await browser.close();
|
||
* })();
|
||
* ```
|
||
*
|
||
* @param value - Whether to enable request interception.
|
||
*/
|
||
async setRequestInterception(value: boolean): Promise<void>;
|
||
async setRequestInterception(): Promise<void> {
|
||
throw new Error('Not implemented');
|
||
}
|
||
|
||
/**
|
||
* @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.
|
||
*/
|
||
async setDragInterception(enabled: boolean): Promise<void>;
|
||
async setDragInterception(): Promise<void> {
|
||
throw new Error('Not implemented');
|
||
}
|
||
|
||
/**
|
||
* Sets the network connection to offline.
|
||
*
|
||
* It does not change the parameters used in {@link Page.emulateNetworkConditions}
|
||
*
|
||
* @param enabled - When `true`, enables offline mode for the page.
|
||
*/
|
||
setOfflineMode(enabled: boolean): Promise<void>;
|
||
setOfflineMode(): Promise<void> {
|
||
throw new Error('Not implemented');
|
||
}
|
||
|
||
/**
|
||
* This does not affect WebSockets and WebRTC PeerConnections (see
|
||
* https://crbug.com/563644). To set the page offline, you can use
|
||
* {@link Page.setOfflineMode}.
|
||
*
|
||
* A list of predefined network conditions can be used by importing
|
||
* {@link PredefinedNetworkConditions}.
|
||
*
|
||
* @example
|
||
*
|
||
* ```ts
|
||
* import {PredefinedNetworkConditions} from 'puppeteer';
|
||
* const slow3G = PredefinedNetworkConditions['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();
|
||
* })();
|
||
* ```
|
||
*
|
||
* @param networkConditions - Passing `null` disables network condition
|
||
* emulation.
|
||
*/
|
||
emulateNetworkConditions(
|
||
networkConditions: NetworkConditions | null
|
||
): Promise<void>;
|
||
emulateNetworkConditions(): Promise<void> {
|
||
throw new Error('Not implemented');
|
||
}
|
||
|
||
/**
|
||
* 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;
|
||
setDefaultNavigationTimeout(): void {
|
||
throw new Error('Not implemented');
|
||
}
|
||
|
||
/**
|
||
* @param timeout - Maximum time in milliseconds.
|
||
*/
|
||
setDefaultTimeout(timeout: number): void;
|
||
setDefaultTimeout(): void {
|
||
throw new Error('Not implemented');
|
||
}
|
||
|
||
/**
|
||
* @returns Maximum time in milliseconds.
|
||
*/
|
||
getDefaultTimeout(): number {
|
||
throw new Error('Not implemented');
|
||
}
|
||
|
||
/**
|
||
* Runs `document.querySelector` within the page. If no element matches the
|
||
* selector, the return value resolves to `null`.
|
||
*
|
||
* @param selector - A `selector` to query page for
|
||
* {@link https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Selectors | selector}
|
||
* to query page for.
|
||
*/
|
||
async $<Selector extends string>(
|
||
selector: Selector
|
||
): Promise<ElementHandle<NodeFor<Selector>> | null>;
|
||
async $<Selector extends string>(): Promise<ElementHandle<
|
||
NodeFor<Selector>
|
||
> | null> {
|
||
throw new Error('Not implemented');
|
||
}
|
||
|
||
/**
|
||
* 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
|
||
*/
|
||
async $$<Selector extends string>(
|
||
selector: Selector
|
||
): Promise<Array<ElementHandle<NodeFor<Selector>>>>;
|
||
async $$<Selector extends string>(): Promise<
|
||
Array<ElementHandle<NodeFor<Selector>>>
|
||
> {
|
||
throw new Error('Not implemented');
|
||
}
|
||
|
||
/**
|
||
* @remarks
|
||
*
|
||
* The only difference between {@link Page.evaluate | page.evaluate} and
|
||
* `page.evaluateHandle` is that `evaluateHandle` will return the value
|
||
* wrapped in an in-page object.
|
||
*
|
||
* If the function passed to `page.evaluteHandle` returns a Promise, the
|
||
* function will wait for the promise to resolve and return its value.
|
||
*
|
||
* You can pass a string instead of a function (although functions are
|
||
* recommended as they are easier to debug and use with TypeScript):
|
||
*
|
||
* @example
|
||
*
|
||
* ```ts
|
||
* const aHandle = await page.evaluateHandle('document');
|
||
* ```
|
||
*
|
||
* @example
|
||
* {@link JSHandle} instances can be passed as arguments to the `pageFunction`:
|
||
*
|
||
* ```ts
|
||
* const aHandle = await page.evaluateHandle(() => document.body);
|
||
* const resultHandle = await page.evaluateHandle(
|
||
* body => body.innerHTML,
|
||
* aHandle
|
||
* );
|
||
* console.log(await resultHandle.jsonValue());
|
||
* await resultHandle.dispose();
|
||
* ```
|
||
*
|
||
* Most of the time this function returns a {@link JSHandle},
|
||
* but if `pageFunction` returns a reference to an element,
|
||
* you instead get an {@link ElementHandle} back:
|
||
*
|
||
* @example
|
||
*
|
||
* ```ts
|
||
* const button = await page.evaluateHandle(() =>
|
||
* document.querySelector('button')
|
||
* );
|
||
* // can call `click` because `button` is an `ElementHandle`
|
||
* await button.click();
|
||
* ```
|
||
*
|
||
* The TypeScript definitions assume that `evaluateHandle` returns
|
||
* a `JSHandle`, but if you know it's going to return an
|
||
* `ElementHandle`, pass it as the generic argument:
|
||
*
|
||
* ```ts
|
||
* const button = await page.evaluateHandle<ElementHandle>(...);
|
||
* ```
|
||
*
|
||
* @param pageFunction - a function that is run within the page
|
||
* @param args - arguments to be passed to the pageFunction
|
||
*/
|
||
async evaluateHandle<
|
||
Params extends unknown[],
|
||
Func extends EvaluateFunc<Params> = EvaluateFunc<Params>
|
||
>(
|
||
pageFunction: Func | string,
|
||
...args: Params
|
||
): Promise<HandleFor<Awaited<ReturnType<Func>>>>;
|
||
async evaluateHandle<
|
||
Params extends unknown[],
|
||
Func extends EvaluateFunc<Params> = EvaluateFunc<Params>
|
||
>(): Promise<HandleFor<Awaited<ReturnType<Func>>>> {
|
||
throw new Error('Not implemented');
|
||
}
|
||
|
||
/**
|
||
* This method iterates the JavaScript heap and finds all objects with the
|
||
* given prototype.
|
||
*
|
||
* @example
|
||
*
|
||
* ```ts
|
||
* // Create a Map object
|
||
* await page.evaluate(() => (window.map = new Map()));
|
||
* // Get a handle to the Map object prototype
|
||
* const mapPrototype = await page.evaluateHandle(() => Map.prototype);
|
||
* // Query all map instances into an array
|
||
* const mapInstances = await page.queryObjects(mapPrototype);
|
||
* // Count amount of map objects in heap
|
||
* const count = await page.evaluate(maps => maps.length, mapInstances);
|
||
* await mapInstances.dispose();
|
||
* 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.
|
||
*/
|
||
async queryObjects<Prototype>(
|
||
prototypeHandle: JSHandle<Prototype>
|
||
): Promise<JSHandle<Prototype[]>>;
|
||
async queryObjects<Prototype>(): Promise<JSHandle<Prototype[]>> {
|
||
throw new Error('Not implemented');
|
||
}
|
||
|
||
/**
|
||
* This method runs `document.querySelector` within the page and passes the
|
||
* result as the first argument to the `pageFunction`.
|
||
*
|
||
* @remarks
|
||
*
|
||
* If no element is found matching `selector`, the method will throw an error.
|
||
*
|
||
* If `pageFunction` returns a promise `$eval` will wait for the promise to
|
||
* resolve and then return its value.
|
||
*
|
||
* @example
|
||
*
|
||
* ```ts
|
||
* const searchValue = await page.$eval('#search', el => el.value);
|
||
* const preloadHref = await page.$eval('link[rel=preload]', el => el.href);
|
||
* const html = await page.$eval('.main-container', el => el.outerHTML);
|
||
* ```
|
||
*
|
||
* If you are using TypeScript, you may have to provide an explicit type to the
|
||
* first argument of the `pageFunction`.
|
||
* By default it is typed as `Element`, but you may need to provide a more
|
||
* specific sub-type:
|
||
*
|
||
* @example
|
||
*
|
||
* ```ts
|
||
* // if you don't provide HTMLInputElement here, TS will error
|
||
* // as `value` is not on `Element`
|
||
* const searchValue = await page.$eval(
|
||
* '#search',
|
||
* (el: HTMLInputElement) => el.value
|
||
* );
|
||
* ```
|
||
*
|
||
* The compiler should be able to infer the return type
|
||
* from the `pageFunction` you provide. If it is unable to, you can use the generic
|
||
* type to tell the compiler what return type you expect from `$eval`:
|
||
*
|
||
* @example
|
||
*
|
||
* ```ts
|
||
* // The compiler can infer the return type in this case, but if it can't
|
||
* // or if you want to be more explicit, provide it as the generic type.
|
||
* const searchValue = await page.$eval<string>(
|
||
* '#search',
|
||
* (el: HTMLInputElement) => el.value
|
||
* );
|
||
* ```
|
||
*
|
||
* @param selector - the
|
||
* {@link https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Selectors | selector}
|
||
* to query for
|
||
* @param pageFunction - the function to be evaluated in the page context.
|
||
* Will be passed the result of `document.querySelector(selector)` as its
|
||
* first argument.
|
||
* @param args - any additional arguments to pass through to `pageFunction`.
|
||
*
|
||
* @returns The result of calling `pageFunction`. If it returns an element it
|
||
* is wrapped in an {@link ElementHandle}, else the raw value itself is
|
||
* returned.
|
||
*/
|
||
async $eval<
|
||
Selector extends string,
|
||
Params extends unknown[],
|
||
Func extends EvaluateFunc<
|
||
[ElementHandle<NodeFor<Selector>>, ...Params]
|
||
> = EvaluateFunc<[ElementHandle<NodeFor<Selector>>, ...Params]>
|
||
>(
|
||
selector: Selector,
|
||
pageFunction: Func | string,
|
||
...args: Params
|
||
): Promise<Awaited<ReturnType<Func>>>;
|
||
async $eval<
|
||
Selector extends string,
|
||
Params extends unknown[],
|
||
Func extends EvaluateFunc<
|
||
[ElementHandle<NodeFor<Selector>>, ...Params]
|
||
> = EvaluateFunc<[ElementHandle<NodeFor<Selector>>, ...Params]>
|
||
>(): Promise<Awaited<ReturnType<Func>>> {
|
||
throw new Error('Not implemented');
|
||
}
|
||
|
||
/**
|
||
* This method runs `Array.from(document.querySelectorAll(selector))` within
|
||
* the page and passes the result as the first argument to the `pageFunction`.
|
||
*
|
||
* @remarks
|
||
* If `pageFunction` returns a promise `$$eval` will wait for the promise to
|
||
* resolve and then return its value.
|
||
*
|
||
* @example
|
||
*
|
||
* ```ts
|
||
* // get the amount of divs on the page
|
||
* const divCount = await page.$$eval('div', divs => divs.length);
|
||
*
|
||
* // get the text content of all the `.options` elements:
|
||
* const options = await page.$$eval('div > span.options', options => {
|
||
* return options.map(option => option.textContent);
|
||
* });
|
||
* ```
|
||
*
|
||
* If you are using TypeScript, you may have to provide an explicit type to the
|
||
* first argument of the `pageFunction`.
|
||
* By default it is typed as `Element[]`, but you may need to provide a more
|
||
* specific sub-type:
|
||
*
|
||
* @example
|
||
*
|
||
* ```ts
|
||
* // if you don't provide HTMLInputElement here, TS will error
|
||
* // as `value` is not on `Element`
|
||
* await page.$$eval('input', (elements: HTMLInputElement[]) => {
|
||
* return elements.map(e => e.value);
|
||
* });
|
||
* ```
|
||
*
|
||
* The compiler should be able to infer the return type
|
||
* from the `pageFunction` you provide. If it is unable to, you can use the generic
|
||
* type to tell the compiler what return type you expect from `$$eval`:
|
||
*
|
||
* @example
|
||
*
|
||
* ```ts
|
||
* // The compiler can infer the return type in this case, but if it can't
|
||
* // or if you want to be more explicit, provide it as the generic type.
|
||
* const allInputValues = await page.$$eval<string[]>(
|
||
* 'input',
|
||
* (elements: HTMLInputElement[]) => elements.map(e => e.textContent)
|
||
* );
|
||
* ```
|
||
*
|
||
* @param selector - the
|
||
* {@link https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Selectors | selector}
|
||
* to query for
|
||
* @param pageFunction - the function to be evaluated in the page context.
|
||
* Will be passed the result of
|
||
* `Array.from(document.querySelectorAll(selector))` as its first argument.
|
||
* @param args - any additional arguments to pass through to `pageFunction`.
|
||
*
|
||
* @returns The result of calling `pageFunction`. If it returns an element it
|
||
* is wrapped in an {@link ElementHandle}, else the raw value itself is
|
||
* returned.
|
||
*/
|
||
async $$eval<
|
||
Selector extends string,
|
||
Params extends unknown[],
|
||
Func extends EvaluateFunc<
|
||
[Array<NodeFor<Selector>>, ...Params]
|
||
> = EvaluateFunc<[Array<NodeFor<Selector>>, ...Params]>
|
||
>(
|
||
selector: Selector,
|
||
pageFunction: Func | string,
|
||
...args: Params
|
||
): Promise<Awaited<ReturnType<Func>>>;
|
||
async $$eval<
|
||
Selector extends string,
|
||
Params extends unknown[],
|
||
Func extends EvaluateFunc<
|
||
[Array<NodeFor<Selector>>, ...Params]
|
||
> = EvaluateFunc<[Array<NodeFor<Selector>>, ...Params]>
|
||
>(): Promise<Awaited<ReturnType<Func>>> {
|
||
throw new Error('Not implemented');
|
||
}
|
||
|
||
/**
|
||
* 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
|
||
*/
|
||
async $x(expression: string): Promise<Array<ElementHandle<Node>>>;
|
||
async $x(): Promise<Array<ElementHandle<Node>>> {
|
||
throw new Error('Not implemented');
|
||
}
|
||
|
||
/**
|
||
* If no URLs are specified, this method returns cookies for the current page
|
||
* URL. If URLs are specified, only cookies for those URLs are returned.
|
||
*/
|
||
async cookies(...urls: string[]): Promise<Protocol.Network.Cookie[]>;
|
||
async cookies(): Promise<Protocol.Network.Cookie[]> {
|
||
throw new Error('Not implemented');
|
||
}
|
||
|
||
async deleteCookie(
|
||
...cookies: Protocol.Network.DeleteCookiesRequest[]
|
||
): Promise<void>;
|
||
async deleteCookie(): Promise<void> {
|
||
throw new Error('Not implemented');
|
||
}
|
||
|
||
/**
|
||
* @example
|
||
*
|
||
* ```ts
|
||
* await page.setCookie(cookieObject1, cookieObject2);
|
||
* ```
|
||
*/
|
||
async setCookie(...cookies: Protocol.Network.CookieParam[]): Promise<void>;
|
||
async setCookie(): Promise<void> {
|
||
throw new Error('Not implemented');
|
||
}
|
||
|
||
/**
|
||
* Adds a `<script>` tag into the page with the desired URL or content.
|
||
*
|
||
* @remarks
|
||
* Shortcut for
|
||
* {@link Frame.addScriptTag | page.mainFrame().addScriptTag(options)}.
|
||
*
|
||
* @param options - Options for the script.
|
||
* @returns An {@link ElementHandle | element handle} to the injected
|
||
* `<script>` element.
|
||
*/
|
||
async addScriptTag(
|
||
options: FrameAddScriptTagOptions
|
||
): Promise<ElementHandle<HTMLScriptElement>>;
|
||
async addScriptTag(): Promise<ElementHandle<HTMLScriptElement>> {
|
||
throw new Error('Not implemented');
|
||
}
|
||
|
||
/**
|
||
* Adds a `<link rel="stylesheet">` tag into the page with the desired URL or
|
||
* a `<style type="text/css">` tag with the content.
|
||
*
|
||
* Shortcut for
|
||
* {@link Frame.addStyleTag | page.mainFrame().addStyleTag(options)}.
|
||
*
|
||
* @returns An {@link ElementHandle | element handle} to the injected `<link>`
|
||
* or `<style>` element.
|
||
*/
|
||
async addStyleTag(
|
||
options: Omit<FrameAddStyleTagOptions, 'url'>
|
||
): Promise<ElementHandle<HTMLStyleElement>>;
|
||
async addStyleTag(
|
||
options: FrameAddStyleTagOptions
|
||
): Promise<ElementHandle<HTMLLinkElement>>;
|
||
async addStyleTag(
|
||
options: FrameAddStyleTagOptions
|
||
): Promise<ElementHandle<HTMLStyleElement | HTMLLinkElement>>;
|
||
async addStyleTag(): Promise<
|
||
ElementHandle<HTMLStyleElement | HTMLLinkElement>
|
||
> {
|
||
throw new Error('Not implemented');
|
||
}
|
||
|
||
/**
|
||
* The method adds a function called `name` on the page's `window` object.
|
||
* When called, the function executes `puppeteerFunction` in node.js and
|
||
* returns a `Promise` which resolves to the return value of
|
||
* `puppeteerFunction`.
|
||
*
|
||
* If the puppeteerFunction returns a `Promise`, it will be awaited.
|
||
*
|
||
* :::note
|
||
*
|
||
* Functions installed via `page.exposeFunction` survive navigations.
|
||
*
|
||
* :::note
|
||
*
|
||
* @example
|
||
* An example of adding an `md5` function into the page:
|
||
*
|
||
* ```ts
|
||
* 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();
|
||
* })();
|
||
* ```
|
||
*
|
||
* @example
|
||
* An example of adding a `window.readfile` function into the page:
|
||
*
|
||
* ```ts
|
||
* 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();
|
||
* })();
|
||
* ```
|
||
*
|
||
* @param name - Name of the function on the window object
|
||
* @param pptrFunction - Callback function which will be called in Puppeteer's
|
||
* context.
|
||
*/
|
||
async exposeFunction(
|
||
name: string,
|
||
pptrFunction: Function | {default: Function}
|
||
): Promise<void>;
|
||
async exposeFunction(): Promise<void> {
|
||
throw new Error('Not implemented');
|
||
}
|
||
|
||
/**
|
||
* Provide credentials for `HTTP authentication`.
|
||
*
|
||
* @remarks
|
||
* To disable authentication, pass `null`.
|
||
*/
|
||
async authenticate(credentials: Credentials): Promise<void>;
|
||
async authenticate(): Promise<void> {
|
||
throw new Error('Not implemented');
|
||
}
|
||
|
||
/**
|
||
* The extra HTTP headers will be sent with every request the page initiates.
|
||
*
|
||
* :::tip
|
||
*
|
||
* 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.
|
||
*/
|
||
async setExtraHTTPHeaders(headers: Record<string, string>): Promise<void>;
|
||
async setExtraHTTPHeaders(): Promise<void> {
|
||
throw new Error('Not implemented');
|
||
}
|
||
|
||
/**
|
||
* @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.
|
||
*/
|
||
async setUserAgent(
|
||
userAgent: string,
|
||
userAgentMetadata?: Protocol.Emulation.UserAgentMetadata
|
||
): Promise<void>;
|
||
async setUserAgent(): Promise<void> {
|
||
throw new Error('Not implemented');
|
||
}
|
||
|
||
/**
|
||
* @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
|
||
* All timestamps are in monotonic time: monotonically increasing time
|
||
* in seconds since an arbitrary point in the past.
|
||
*/
|
||
async metrics(): Promise<Metrics> {
|
||
throw new Error('Not implemented');
|
||
}
|
||
|
||
/**
|
||
*
|
||
* @returns
|
||
* @remarks Shortcut for
|
||
* {@link Frame.url | page.mainFrame().url()}.
|
||
*/
|
||
url(): string {
|
||
throw new Error('Not implemented');
|
||
}
|
||
|
||
async content(): Promise<string> {
|
||
throw new Error('Not implemented');
|
||
}
|
||
|
||
/**
|
||
* @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} or
|
||
* {@link Page.setDefaultTimeout} 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.
|
||
*/
|
||
async setContent(html: string, options?: WaitForOptions): Promise<void>;
|
||
async setContent(): Promise<void> {
|
||
throw new Error('Not implemented');
|
||
}
|
||
|
||
/**
|
||
* @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} or
|
||
* {@link Page.setDefaultTimeout} 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)}.
|
||
*/
|
||
async goto(
|
||
url: string,
|
||
options?: WaitForOptions & {referer?: string}
|
||
): Promise<HTTPResponse | null>;
|
||
async goto(): Promise<HTTPResponse | null> {
|
||
throw new Error('Not implemented');
|
||
}
|
||
|
||
/**
|
||
* @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} or
|
||
* {@link Page.setDefaultTimeout} 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.
|
||
*/
|
||
async reload(options?: WaitForOptions): Promise<HTTPResponse | null>;
|
||
async reload(): Promise<HTTPResponse | null> {
|
||
throw new Error('Not implemented');
|
||
}
|
||
|
||
/**
|
||
* Waits for the page to navigate to a new URL or to reload. It is useful when
|
||
* you run code that will indirectly cause the page to navigate.
|
||
*
|
||
* @example
|
||
*
|
||
* ```ts
|
||
* 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
|
||
* ]);
|
||
* ```
|
||
*
|
||
* @remarks
|
||
* 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.
|
||
*
|
||
* @param options - Navigation parameters which might have the following
|
||
* properties:
|
||
* @returns A `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`.
|
||
*/
|
||
async waitForNavigation(
|
||
options?: WaitForOptions
|
||
): Promise<HTTPResponse | null>;
|
||
async waitForNavigation(): Promise<HTTPResponse | null> {
|
||
throw new Error('Not implemented');
|
||
}
|
||
|
||
/**
|
||
* @param urlOrPredicate - A URL or predicate to wait for
|
||
* @param options - Optional waiting parameters
|
||
* @returns Promise which resolves to the matched request
|
||
* @example
|
||
*
|
||
* ```ts
|
||
* const firstRequest = await page.waitForRequest(
|
||
* 'https://example.com/resource'
|
||
* );
|
||
* const finalRequest = await page.waitForRequest(
|
||
* request => request.url() === 'https://example.com'
|
||
* );
|
||
* return finalRequest.response()?.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.
|
||
*/
|
||
async waitForRequest(
|
||
urlOrPredicate: string | ((req: HTTPRequest) => boolean | Promise<boolean>),
|
||
options?: {timeout?: number}
|
||
): Promise<HTTPRequest>;
|
||
async waitForRequest(): Promise<HTTPRequest> {
|
||
throw new Error('Not implemented');
|
||
}
|
||
|
||
/**
|
||
* @param urlOrPredicate - A URL or predicate to wait for.
|
||
* @param options - Optional waiting parameters
|
||
* @returns Promise which resolves to the matched response.
|
||
* @example
|
||
*
|
||
* ```ts
|
||
* 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.
|
||
*/
|
||
async waitForResponse(
|
||
urlOrPredicate:
|
||
| string
|
||
| ((res: HTTPResponse) => boolean | Promise<boolean>),
|
||
options?: {timeout?: number}
|
||
): Promise<HTTPResponse>;
|
||
async waitForResponse(): Promise<HTTPResponse> {
|
||
throw new Error('Not implemented');
|
||
}
|
||
|
||
/**
|
||
* @param options - Optional waiting parameters
|
||
* @returns Promise which resolves when network is idle
|
||
*/
|
||
async waitForNetworkIdle(options?: {
|
||
idleTime?: number;
|
||
timeout?: number;
|
||
}): Promise<void>;
|
||
async waitForNetworkIdle(): Promise<void> {
|
||
throw new Error('Not implemented');
|
||
}
|
||
|
||
/**
|
||
* @param urlOrPredicate - A URL or predicate to wait for.
|
||
* @param options - Optional waiting parameters
|
||
* @returns Promise which resolves to the matched frame.
|
||
* @example
|
||
*
|
||
* ```ts
|
||
* const frame = await page.waitForFrame(async frame => {
|
||
* return frame.name() === 'Test';
|
||
* });
|
||
* ```
|
||
*
|
||
* @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.
|
||
*/
|
||
async waitForFrame(
|
||
urlOrPredicate: string | ((frame: Frame) => boolean | Promise<boolean>),
|
||
options?: {timeout?: number}
|
||
): Promise<Frame>;
|
||
async waitForFrame(): Promise<Frame> {
|
||
throw new Error('Not implemented');
|
||
}
|
||
|
||
/**
|
||
* 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} or
|
||
* {@link Page.setDefaultTimeout} 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.
|
||
*/
|
||
async goBack(options?: WaitForOptions): Promise<HTTPResponse | null>;
|
||
async goBack(): Promise<HTTPResponse | null> {
|
||
throw new Error('Not implemented');
|
||
}
|
||
|
||
/**
|
||
* 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} or
|
||
* {@link Page.setDefaultTimeout} 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.
|
||
*/
|
||
async goForward(options?: WaitForOptions): Promise<HTTPResponse | null>;
|
||
async goForward(): Promise<HTTPResponse | null> {
|
||
throw new Error('Not implemented');
|
||
}
|
||
|
||
/**
|
||
* Brings page to front (activates tab).
|
||
*/
|
||
async bringToFront(): Promise<void> {
|
||
throw new Error('Not implemented');
|
||
}
|
||
|
||
/**
|
||
* Emulates a given device's metrics and user agent.
|
||
*
|
||
* To aid emulation, Puppeteer provides a list of known devices that can be
|
||
* via {@link KnownDevices}.
|
||
*
|
||
* @remarks
|
||
* This method is a shortcut for calling two methods:
|
||
* {@link Page.setUserAgent} and {@link Page.setViewport}.
|
||
*
|
||
* @remarks
|
||
* This method 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
|
||
*
|
||
* ```ts
|
||
* import {KnownDevices} from 'puppeteer';
|
||
* const iPhone = KnownDevices['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();
|
||
* })();
|
||
* ```
|
||
*/
|
||
async emulate(device: Device): Promise<void> {
|
||
await Promise.all([
|
||
this.setUserAgent(device.userAgent),
|
||
this.setViewport(device.viewport),
|
||
]);
|
||
}
|
||
|
||
/**
|
||
* @param enabled - Whether or not to enable JavaScript on the page.
|
||
* @remarks
|
||
* NOTE: changing this value won't affect scripts that have already been run.
|
||
* It will take full effect on the next navigation.
|
||
*/
|
||
async setJavaScriptEnabled(enabled: boolean): Promise<void>;
|
||
async setJavaScriptEnabled(): Promise<void> {
|
||
throw new Error('Not implemented');
|
||
}
|
||
|
||
/**
|
||
* 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.
|
||
*/
|
||
async setBypassCSP(enabled: boolean): Promise<void>;
|
||
async setBypassCSP(): Promise<void> {
|
||
throw new Error('Not implemented');
|
||
}
|
||
|
||
/**
|
||
* @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
|
||
*
|
||
* ```ts
|
||
* 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
|
||
* ```
|
||
*/
|
||
async emulateMediaType(type?: string): Promise<void>;
|
||
async emulateMediaType(): Promise<void> {
|
||
throw new Error('Not implemented');
|
||
}
|
||
|
||
/**
|
||
* Enables CPU throttling to emulate slow CPUs.
|
||
* @param factor - slowdown factor (1 is no throttle, 2 is 2x slowdown, etc).
|
||
*/
|
||
async emulateCPUThrottling(factor: number | null): Promise<void>;
|
||
async emulateCPUThrottling(): Promise<void> {
|
||
throw new Error('Not implemented');
|
||
}
|
||
|
||
/**
|
||
* @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
|
||
*
|
||
* ```ts
|
||
* 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
|
||
* ```
|
||
*/
|
||
async emulateMediaFeatures(features?: MediaFeature[]): Promise<void>;
|
||
async emulateMediaFeatures(): Promise<void> {
|
||
throw new Error('Not implemented');
|
||
}
|
||
|
||
/**
|
||
* @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.
|
||
*/
|
||
async emulateTimezone(timezoneId?: string): Promise<void>;
|
||
async emulateTimezone(): Promise<void> {
|
||
throw new Error('Not implemented');
|
||
}
|
||
|
||
/**
|
||
* Emulates the idle state.
|
||
* If no arguments set, clears idle state emulation.
|
||
*
|
||
* @example
|
||
*
|
||
* ```ts
|
||
* // set idle emulation
|
||
* await page.emulateIdleState({isUserActive: true, isScreenUnlocked: false});
|
||
*
|
||
* // do some checks here
|
||
* ...
|
||
*
|
||
* // clear idle emulation
|
||
* await page.emulateIdleState();
|
||
* ```
|
||
*
|
||
* @param overrides - Mock idle state. If not set, clears idle overrides
|
||
*/
|
||
async emulateIdleState(overrides?: {
|
||
isUserActive: boolean;
|
||
isScreenUnlocked: boolean;
|
||
}): Promise<void>;
|
||
async emulateIdleState(): Promise<void> {
|
||
throw new Error('Not implemented');
|
||
}
|
||
|
||
/**
|
||
* Simulates the given vision deficiency on the page.
|
||
*
|
||
* @example
|
||
*
|
||
* ```ts
|
||
* const puppeteer = require('puppeteer');
|
||
*
|
||
* (async () => {
|
||
* const browser = await puppeteer.launch();
|
||
* const page = await browser.newPage();
|
||
* await page.goto('https://v8.dev/blog/10-years');
|
||
*
|
||
* await page.emulateVisionDeficiency('achromatopsia');
|
||
* await page.screenshot({path: 'achromatopsia.png'});
|
||
*
|
||
* await page.emulateVisionDeficiency('deuteranopia');
|
||
* await page.screenshot({path: 'deuteranopia.png'});
|
||
*
|
||
* await page.emulateVisionDeficiency('blurredVision');
|
||
* await page.screenshot({path: 'blurred-vision.png'});
|
||
*
|
||
* await browser.close();
|
||
* })();
|
||
* ```
|
||
*
|
||
* @param type - the type of deficiency to simulate, or `'none'` to reset.
|
||
*/
|
||
async emulateVisionDeficiency(
|
||
type?: Protocol.Emulation.SetEmulatedVisionDeficiencyRequest['type']
|
||
): Promise<void>;
|
||
async emulateVisionDeficiency(): Promise<void> {
|
||
throw new Error('Not implemented');
|
||
}
|
||
|
||
/**
|
||
* `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
|
||
*
|
||
* ```ts
|
||
* 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.
|
||
*/
|
||
async setViewport(viewport: Viewport): Promise<void>;
|
||
async setViewport(): Promise<void> {
|
||
throw new Error('Not implemented');
|
||
}
|
||
|
||
/**
|
||
* @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 {
|
||
throw new Error('Not implemented');
|
||
}
|
||
|
||
/**
|
||
* Evaluates a function in the page's context and returns the result.
|
||
*
|
||
* If the function passed to `page.evaluteHandle` returns a Promise, the
|
||
* function will wait for the promise to resolve and return its value.
|
||
*
|
||
* @example
|
||
*
|
||
* ```ts
|
||
* const result = await frame.evaluate(() => {
|
||
* return Promise.resolve(8 * 7);
|
||
* });
|
||
* console.log(result); // prints "56"
|
||
* ```
|
||
*
|
||
* You can pass a string instead of a function (although functions are
|
||
* recommended as they are easier to debug and use with TypeScript):
|
||
*
|
||
* @example
|
||
*
|
||
* ```ts
|
||
* const aHandle = await page.evaluate('1 + 2');
|
||
* ```
|
||
*
|
||
* To get the best TypeScript experience, you should pass in as the
|
||
* generic the type of `pageFunction`:
|
||
*
|
||
* ```ts
|
||
* const aHandle = await page.evaluate(() => 2);
|
||
* ```
|
||
*
|
||
* @example
|
||
*
|
||
* {@link ElementHandle} instances (including {@link JSHandle}s) can be passed
|
||
* as arguments to the `pageFunction`:
|
||
*
|
||
* ```ts
|
||
* const bodyHandle = await page.$('body');
|
||
* const html = await page.evaluate(body => body.innerHTML, bodyHandle);
|
||
* await bodyHandle.dispose();
|
||
* ```
|
||
*
|
||
* @param pageFunction - a function that is run within the page
|
||
* @param args - arguments to be passed to the pageFunction
|
||
*
|
||
* @returns the return value of `pageFunction`.
|
||
*/
|
||
async evaluate<
|
||
Params extends unknown[],
|
||
Func extends EvaluateFunc<Params> = EvaluateFunc<Params>
|
||
>(
|
||
pageFunction: Func | string,
|
||
...args: Params
|
||
): Promise<Awaited<ReturnType<Func>>>;
|
||
async evaluate<
|
||
Params extends unknown[],
|
||
Func extends EvaluateFunc<Params> = EvaluateFunc<Params>
|
||
>(): Promise<Awaited<ReturnType<Func>>> {
|
||
throw new Error('Not implemented');
|
||
}
|
||
|
||
/**
|
||
* 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:
|
||
*
|
||
* ```ts
|
||
* // 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);
|
||
* ```
|
||
*/
|
||
async evaluateOnNewDocument<
|
||
Params extends unknown[],
|
||
Func extends (...args: Params) => unknown = (...args: Params) => unknown
|
||
>(pageFunction: Func | string, ...args: Params): Promise<void>;
|
||
async evaluateOnNewDocument(): Promise<void> {
|
||
throw new Error('Not implemented');
|
||
}
|
||
|
||
/**
|
||
* Toggles ignoring cache for each request based on the enabled state. By
|
||
* default, caching is enabled.
|
||
* @param enabled - sets the `enabled` state of cache
|
||
* @defaultValue true
|
||
*/
|
||
async setCacheEnabled(enabled?: boolean): Promise<void>;
|
||
async setCacheEnabled(): Promise<void> {
|
||
throw new Error('Not implemented');
|
||
}
|
||
|
||
/**
|
||
* @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`.
|
||
*
|
||
* - `captureBeyondViewport` : When true, captures screenshot
|
||
* {@link https://chromedevtools.github.io/devtools-protocol/tot/Page/#method-captureScreenshot
|
||
* | beyond the viewport}. When false, falls back to old behaviour,
|
||
* and cuts the screenshot by the viewport size. Defaults to `true`.
|
||
*
|
||
* - `fromSurface` : When true, captures screenshot
|
||
* {@link https://chromedevtools.github.io/devtools-protocol/tot/Page/#method-captureScreenshot
|
||
* | from the surface rather than the view}. When false, works only in
|
||
* headful mode and ignores page viewport (but not browser window's
|
||
* bounds). Defaults to `true`.
|
||
*
|
||
* NOTE: Screenshots take at least 1/6 second on OS X. See
|
||
* {@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.
|
||
*/
|
||
async screenshot(options?: ScreenshotOptions): Promise<Buffer | string>;
|
||
async screenshot(): Promise<Buffer | string> {
|
||
throw new Error('Not implemented');
|
||
}
|
||
|
||
/**
|
||
* Generates a PDF of the page with the `print` CSS media type.
|
||
* @remarks
|
||
*
|
||
* 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
|
||
* calling `page.pdf()`.
|
||
*
|
||
* By default, `page.pdf()` generates a pdf with modified colors for printing.
|
||
* Use the
|
||
* {@link https://developer.mozilla.org/en-US/docs/Web/CSS/-webkit-print-color-adjust | `-webkit-print-color-adjust`}
|
||
* property to force rendering of exact colors.
|
||
*
|
||
* @param options - options for generating the PDF.
|
||
*/
|
||
async createPDFStream(options?: PDFOptions): Promise<Readable>;
|
||
async createPDFStream(): Promise<Readable> {
|
||
throw new Error('Not implemented');
|
||
}
|
||
|
||
/**
|
||
* @param options -
|
||
* @returns
|
||
*/
|
||
async pdf(options?: PDFOptions): Promise<Buffer>;
|
||
async pdf(): Promise<Buffer> {
|
||
throw new Error('Not implemented');
|
||
}
|
||
|
||
/**
|
||
* @returns The page's title
|
||
* @remarks
|
||
* Shortcut for {@link Frame.title | page.mainFrame().title()}.
|
||
*/
|
||
async title(): Promise<string> {
|
||
throw new Error('Not implemented');
|
||
}
|
||
|
||
async close(options?: {runBeforeUnload?: boolean}): Promise<void>;
|
||
async close(): Promise<void> {
|
||
throw new Error('Not implemented');
|
||
}
|
||
|
||
/**
|
||
* Indicates that the page has been closed.
|
||
* @returns
|
||
*/
|
||
isClosed(): boolean {
|
||
throw new Error('Not implemented');
|
||
}
|
||
|
||
get mouse(): Mouse {
|
||
throw new Error('Not implemented');
|
||
}
|
||
|
||
/**
|
||
* 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:
|
||
*
|
||
* ```ts
|
||
* 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>;
|
||
click(): Promise<void> {
|
||
throw new Error('Not implemented');
|
||
}
|
||
|
||
/**
|
||
* 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>;
|
||
focus(): Promise<void> {
|
||
throw new Error('Not implemented');
|
||
}
|
||
|
||
/**
|
||
* 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>;
|
||
hover(): Promise<void> {
|
||
throw new Error('Not implemented');
|
||
}
|
||
|
||
/**
|
||
* 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
|
||
*
|
||
* ```ts
|
||
* 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[]>;
|
||
select(): Promise<string[]> {
|
||
throw new Error('Not implemented');
|
||
}
|
||
|
||
/**
|
||
* 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>;
|
||
tap(): Promise<void> {
|
||
throw new Error('Not implemented');
|
||
}
|
||
|
||
/**
|
||
* 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
|
||
*
|
||
* ```ts
|
||
* 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>;
|
||
type(): Promise<void> {
|
||
throw new Error('Not implemented');
|
||
}
|
||
|
||
/**
|
||
* @deprecated Replace with `new Promise(r => setTimeout(r, milliseconds));`.
|
||
*
|
||
* Causes your script to wait for the given number of milliseconds.
|
||
*
|
||
* @remarks
|
||
* It's generally recommended to not wait for a number of seconds, but instead
|
||
* use {@link Frame.waitForSelector}, {@link Frame.waitForXPath} or
|
||
* {@link Frame.waitForFunction} to wait for exactly the conditions you want.
|
||
*
|
||
* @example
|
||
*
|
||
* Wait for 1 second:
|
||
*
|
||
* ```ts
|
||
* await page.waitForTimeout(1000);
|
||
* ```
|
||
*
|
||
* @param milliseconds - the number of milliseconds to wait.
|
||
*/
|
||
waitForTimeout(milliseconds: number): Promise<void>;
|
||
waitForTimeout(): Promise<void> {
|
||
throw new Error('Not implemented');
|
||
}
|
||
|
||
/**
|
||
* 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:
|
||
*
|
||
* ```ts
|
||
* 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`: 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`: 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.
|
||
*/
|
||
async waitForSelector<Selector extends string>(
|
||
selector: Selector,
|
||
options?: WaitForSelectorOptions
|
||
): Promise<ElementHandle<NodeFor<Selector>> | null>;
|
||
async waitForSelector<Selector extends string>(): Promise<ElementHandle<
|
||
NodeFor<Selector>
|
||
> | null> {
|
||
throw new Error('Not implemented');
|
||
}
|
||
|
||
/**
|
||
* 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
|
||
*
|
||
* ```ts
|
||
* 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<Node> | null>;
|
||
waitForXPath(): Promise<ElementHandle<Node> | null> {
|
||
throw new Error('Not implemented');
|
||
}
|
||
|
||
/**
|
||
* Waits for a function to finish evaluating in the page's context.
|
||
*
|
||
* @example
|
||
* The {@link Page.waitForFunction} can be used to observe viewport size change:
|
||
*
|
||
* ```ts
|
||
* 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();
|
||
* })();
|
||
* ```
|
||
*
|
||
* @example
|
||
* To pass arguments from node.js to the predicate of
|
||
* {@link Page.waitForFunction} function:
|
||
*
|
||
* ```ts
|
||
* const selector = '.foo';
|
||
* await page.waitForFunction(
|
||
* selector => !!document.querySelector(selector),
|
||
* {},
|
||
* selector
|
||
* );
|
||
* ```
|
||
*
|
||
* @example
|
||
* The predicate of {@link Page.waitForFunction} can be asynchronous too:
|
||
*
|
||
* ```ts
|
||
* 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 - Options for configuring waiting behavior.
|
||
*/
|
||
waitForFunction<
|
||
Params extends unknown[],
|
||
Func extends EvaluateFunc<Params> = EvaluateFunc<Params>
|
||
>(
|
||
pageFunction: Func | string,
|
||
options?: FrameWaitForFunctionOptions,
|
||
...args: Params
|
||
): Promise<HandleFor<Awaited<ReturnType<Func>>>>;
|
||
waitForFunction<
|
||
Params extends unknown[],
|
||
Func extends EvaluateFunc<Params> = EvaluateFunc<Params>
|
||
>(): Promise<HandleFor<Awaited<ReturnType<Func>>>> {
|
||
throw new Error('Not implemented');
|
||
}
|
||
}
|
||
|
||
/**
|
||
* @internal
|
||
*/
|
||
export const supportedMetrics = new Set<string>([
|
||
'Timestamp',
|
||
'Documents',
|
||
'Frames',
|
||
'JSEventListeners',
|
||
'Nodes',
|
||
'LayoutCount',
|
||
'RecalcStyleCount',
|
||
'LayoutDuration',
|
||
'RecalcStyleDuration',
|
||
'ScriptDuration',
|
||
'TaskDuration',
|
||
'JSHeapUsedSize',
|
||
'JSHeapTotalSize',
|
||
]);
|
||
|
||
/**
|
||
* @internal
|
||
*/
|
||
export const unitToPixels = {
|
||
px: 1,
|
||
in: 96,
|
||
cm: 37.8,
|
||
mm: 3.78,
|
||
};
|