UNPKG

puppeteer-core

Version:

A high-level API to control headless Chrome over the DevTools Protocol

79 lines 2.54 kB
import { _connectToCDPBrowser, } from './BrowserConnector.js'; import { clearCustomQueryHandlers, customQueryHandlerNames, registerCustomQueryHandler, unregisterCustomQueryHandler, } from './QueryHandler.js'; /** * The main Puppeteer class. * * IMPORTANT: if you are using Puppeteer in a Node environment, you will get an * instance of {@link PuppeteerNode} when you import or require `puppeteer`. * That class extends `Puppeteer`, so has all the methods documented below as * well as all that are defined on {@link PuppeteerNode}. * @public */ export class Puppeteer { /** * Registers a {@link CustomQueryHandler | custom query handler}. * * @remarks * After registration, the handler can be used everywhere where a selector is * expected by prepending the selection string with `<name>/`. The name is only * allowed to consist of lower- and upper case latin letters. * * @example * * ``` * puppeteer.registerCustomQueryHandler('text', { … }); * const aHandle = await page.$('text/…'); * ``` * * @param name - The name that the custom query handler will be registered * under. * @param queryHandler - The {@link CustomQueryHandler | custom query handler} * to register. * * @public */ static registerCustomQueryHandler(name, queryHandler) { return registerCustomQueryHandler(name, queryHandler); } /** * Unregisters a custom query handler for a given name. */ static unregisterCustomQueryHandler(name) { return unregisterCustomQueryHandler(name); } /** * Gets the names of all custom query handlers. */ static customQueryHandlerNames() { return customQueryHandlerNames(); } /** * Unregisters all custom query handlers. */ static clearCustomQueryHandlers() { return clearCustomQueryHandlers(); } /** * @internal */ constructor(settings) { /** * @internal */ this._changedProduct = false; this._isPuppeteerCore = settings.isPuppeteerCore; this.connect = this.connect.bind(this); } /** * This method attaches Puppeteer to an existing browser instance. * * @remarks * * @param options - Set of configurable options to set on the browser. * @returns Promise which resolves to browser instance. */ connect(options) { return _connectToCDPBrowser(options); } } //# sourceMappingURL=Puppeteer.js.map