diff --git a/package.json b/package.json index f81ea6f6..954a5cd9 100644 --- a/package.json +++ b/package.json @@ -47,13 +47,13 @@ "install": "node install.js", "generate:types": "npm run clean:docs && api-extractor run --local --verbose", "generate:esm-package-json": "echo '{\"type\": \"module\"}' > lib/esm/package.json", - "generate:docs": "npm run generate:types && api-documenter markdown -i docs-api-json -o website/docs && node utils/remove-tag.js", + "generate:docs": "npm run generate:types && node utils/remove-tag.js", "generate:docs:testing": "commonmark docs/api.md > docs/api.html", "format": "prettier --write .", "doc": "node utils/doclint/cli.js", "commitlint": "commitlint --from=HEAD~1", "clean:lib": "rimraf lib", - "clean:docs": "rimraf website/docs && rimraf docs-api-json", + "clean:docs": "rimraf docs-api-json", "build": "npm run build:tsc && npm run generate:types && npm run generate:esm-package-json", "build:tsc": "npm run clean:lib && tsc --version && (npm run build:tsc:cjs && npm run build:tsc:esm) && (npm run build:tsc:cjs:compat && npm run build:tsc:esm:compat)", "build:tsc:esm": "tsc -b src/tsconfig.esm.json", diff --git a/website/.gitignore b/website/.gitignore deleted file mode 100644 index b2d6de30..00000000 --- a/website/.gitignore +++ /dev/null @@ -1,20 +0,0 @@ -# Dependencies -/node_modules - -# Production -/build - -# Generated files -.docusaurus -.cache-loader - -# Misc -.DS_Store -.env.local -.env.development.local -.env.test.local -.env.production.local - -npm-debug.log* -yarn-debug.log* -yarn-error.log* diff --git a/website/README.md b/website/README.md deleted file mode 100644 index 1c9cdcb1..00000000 --- a/website/README.md +++ /dev/null @@ -1,31 +0,0 @@ -# Website - -This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator. - -Its dependencies are purposefully kept separate from the main Puppeteer codebase's in order to avoid having all our end users install them when installing Puppeteer. In the future we may move this website into its own repository. - -## Installation - -```console -npm install -``` - -## Local Development - -```console -npm start -``` - -This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server. - -## Build - -```console -npm build -``` - -This command generates static content into the `build` directory and can be served using any static contents hosting service. - -## Deployment - -Deploys are automatically handled by the `deploy-docs.yml` workflow. diff --git a/website/babel.config.js b/website/babel.config.js deleted file mode 100644 index cea7e04a..00000000 --- a/website/babel.config.js +++ /dev/null @@ -1,18 +0,0 @@ -/** - * Copyright 2021 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. - */ -module.exports = { - presets: [require.resolve('@docusaurus/core/lib/babel/preset')], -}; diff --git a/website/blog/CONTRIBUTING.md b/website/blog/CONTRIBUTING.md deleted file mode 100644 index ba0b0936..00000000 --- a/website/blog/CONTRIBUTING.md +++ /dev/null @@ -1,3 +0,0 @@ - - -Head to GitHub to view our CONTRIBUTING.md document diff --git a/website/docusaurus.config.js b/website/docusaurus.config.js deleted file mode 100644 index 94cdc36a..00000000 --- a/website/docusaurus.config.js +++ /dev/null @@ -1,95 +0,0 @@ -/** - * Copyright 2021 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. - */ -const lightCodeTheme = require('prism-react-renderer/themes/github'); -const darkCodeTheme = require('prism-react-renderer/themes/dracula'); - -/** @type {import('@docusaurus/types').DocusaurusConfig} */ -module.exports = { - title: 'Puppeteer documentation', - tagline: 'Note: this documentation is WIP. Please use https://pptr.dev.', - url: 'https://puppeteer.github.io/', - baseUrl: '/puppeteer/', - onBrokenLinks: 'warn', - onBrokenMarkdownLinks: 'ignore', - favicon: 'img/favicon.ico', - organizationName: 'puppeteer', // Usually your GitHub org/user name. - projectName: 'puppeteer', // Usually your repo name. - themeConfig: { - hideableSidebar: true, - navbar: { - style: "primary", - title: 'Puppeteer', - logo: { - alt: 'My Site Logo', - src: 'img/logo.svg', - }, - hideOnScroll: true, - items: [ - { - to: 'docs/puppeteer.puppeteer', - label: 'APIs', - position: 'left', - }, - { - to: 'blog/contributing', - label: 'Contribute', - position: 'left', - }, - { - type: 'docsVersionDropdown', - }, - { - label: 'Github', - href: 'https://github.com/puppeteer/puppeteer', - position: 'right', - }, - { - label: 'Stack', - href: 'https://stackoverflow.com/questions/tagged/puppeteer', - position: 'right' - }, - { - label: 'Version 1.0', - href: 'https://github.com/puppeteer/puppeteer/blob/main/docs/troubleshooting.md', - position: 'right' - } - ], - }, - footer: { - style: 'dark', - links: [], - }, - prism: { - theme: lightCodeTheme, - darkTheme: darkCodeTheme, - }, - }, - presets: [ - [ - '@docusaurus/preset-classic', - { - docs: { - sidebarPath: require.resolve('./sidebars.js'), - // Please change this to your repo. - editUrl: 'https://github.com/facebook/puppeteer/edit/main/website/', - }, - theme: { - customCss: require.resolve("./src/css/custom.css"), - }, - }, - ], - ], -}; diff --git a/website/package.json b/website/package.json deleted file mode 100644 index e1e0542f..00000000 --- a/website/package.json +++ /dev/null @@ -1,39 +0,0 @@ -{ - "name": "website", - "version": "0.0.0", - "private": true, - "scripts": { - "docusaurus": "docusaurus", - "start": "docusaurus start", - "build": "docusaurus build --out-dir=../docs-dist/", - "swizzle": "docusaurus swizzle", - "clear": "docusaurus clear", - "serve": "docusaurus serve --out-dir=../docs-dist/", - "write-translations": "docusaurus write-translations", - "write-heading-ids": "docusaurus write-heading-ids" - }, - "dependencies": { - "@docusaurus/core": "^2.0.0-beta.6", - "@docusaurus/preset-classic": "^2.0.0-beta.6", - "@mdx-js/react": "^1.6.21", - "@svgr/webpack": "^5.5.0", - "clsx": "^1.1.1", - "file-loader": "^6.2.0", - "prism-react-renderer": "^1.2.1", - "react": "^17.0.1", - "react-dom": "^17.0.1", - "url-loader": "^4.1.1" - }, - "browserslist": { - "production": [ - ">0.5%", - "not dead", - "not op_mini all" - ], - "development": [ - "last 1 chrome version", - "last 1 firefox version", - "last 1 safari version" - ] - } -} diff --git a/website/sidebars.js b/website/sidebars.js deleted file mode 100644 index ee061505..00000000 --- a/website/sidebars.js +++ /dev/null @@ -1,1714 +0,0 @@ -module.exports = { - docs: { - Puppeteer: [ - { - type: 'doc', - id: 'puppeteer.puppeteer', - label: 'Puppeteer', - }, - { - Methods: [ - { - type: 'doc', - id: 'puppeteer.puppeteer.clearcustomqueryhandlers', - label: 'clearcustomqueryhandlers', - }, - { - type: 'doc', - id: 'puppeteer.puppeteer.connect', - label: 'connect', - }, - { - type: 'doc', - id: 'puppeteer.puppeteer.customqueryhandlernames', - label: 'customqueryhandlersnames', - }, - { - type: 'doc', - id: 'puppeteer.puppeteer.devices', - label: 'devices', - }, - { - type: 'doc', - id: 'puppeteer.puppeteer.errors', - label: 'errors', - }, - { - type: 'doc', - id: 'puppeteer.puppeteer.networkconditions', - label: 'networkconditions', - }, - { - type: 'doc', - id: 'puppeteer.puppeteer.registercustomqueryhandler', - label: 'registercustomqueryhandler', - }, - { - type: 'doc', - id: 'puppeteer.puppeteer.unregistercustomqueryhandler', - label: 'unregistercustomqueryhandler', - }, - ] - } - ], - "BrowserFetcher": [ - { - type: 'doc', - id: 'puppeteer.browserfetcher', - label: 'BrowserFetcher', - }, - { - Methods: [ - { - type: 'doc', - id: 'puppeteer.browserfetcher.candownload', - label: 'candownload', - }, - { - type: 'doc', - id: 'puppeteer.browserfetcher.download', - label: 'download', - }, - { - type: 'doc', - id: 'puppeteer.browserfetcher.host', - label: 'host', - }, - { - type: 'doc', - id: 'puppeteer.browserfetcher.localrevisions', - label: 'localrevisions', - }, - { - type: 'doc', - id: 'puppeteer.browserfetcher.platform', - label: 'platform', - }, - { - type: 'doc', - id: 'puppeteer.browserfetcher.product', - label: 'product', - }, - { - type: 'doc', - id: 'puppeteer.browserfetcher.remove', - label: 'remove', - }, - { - type: 'doc', - id: 'puppeteer.browserfetcher.revisioninfo', - label: 'revisioninfo', - }, - ] - }, - ], - "Browser": [ - { - type: 'doc', - id: 'puppeteer.browser', - label: 'Browser', - }, - { - Methods: [ - { - type: 'doc', - id: 'puppeteer.browser.browsercontexts', - label: 'browsercontexts', - }, - { - type: 'doc', - id: 'puppeteer.browser.close', - label: 'close', - }, - { - type: 'doc', - id: 'puppeteer.browser.createincognitobrowsercontext', - label: 'createincognitobrowsercontext', - }, - { - type: 'doc', - id: 'puppeteer.browser.defaultbrowsercontext', - label: 'defaultbrowsercontext', - }, - { - type: 'doc', - id: 'puppeteer.browser.disconnect', - label: 'disconnect', - }, - { - type: 'doc', - id: 'puppeteer.browser.isconnected', - label: 'isconnected', - }, - { - type: 'doc', - id: 'puppeteer.browser.newpage', - label: 'newpage', - }, - { - type: 'doc', - id: 'puppeteer.browser.pages', - label: 'pages', - }, - { - type: 'doc', - id: 'puppeteer.browser.process', - label: 'process', - }, - { - type: 'doc', - id: 'puppeteer.browser.target', - label: 'target', - }, - { - type: 'doc', - id: 'puppeteer.browser.useragent', - label: 'useragent', - }, - { - type: 'doc', - id: 'puppeteer.browser.waitfortarget', - label: 'waitfortarget', - }, - { - type: 'doc', - id: 'puppeteer.browser.wsendpoint', - label: 'wsendpoint', - }, - ] - }, - ], - "BrowserContext": [ - { - type: 'doc', - id: 'puppeteer.browsercontext', - label: 'BrowserContext', - }, - { - Methods: [ - { - type: 'doc', - id: 'puppeteer.browsercontext.browser', - label: 'browser', - }, - { - type: 'doc', - id: 'puppeteer.browsercontext.overridepermissions', - label: 'overridepermissions', - }, - { - type: 'doc', - id: 'puppeteer.browsercontext.close', - label: 'close', - }, - { - type: 'doc', - id: 'puppeteer.browsercontext.isincognito', - label: 'isincognito', - }, - { - type: 'doc', - id: 'puppeteer.browsercontext.newpage', - label: 'newpage', - }, - { - type: 'doc', - id: 'puppeteer.browsercontext.overridepermissions', - label: 'overridepermissions', - }, - { - type: 'doc', - id: 'puppeteer.browsercontext.pages', - label: 'pages', - }, - { - type: 'doc', - id: 'puppeteer.browsercontext.targets', - label: 'targets', - }, - { - type: 'doc', - id: 'puppeteer.browsercontext.waitfortarget', - label: 'waitfortarget', - }, - ] - }, - ], - "Page": [ - { - type: 'doc', - id: 'puppeteer.page', - label: 'Page', - }, - { - Namespaces: [ - { - type: 'doc', - id: 'puppeteer.page.accessibility', - label: 'accessibility', - }, - { - type: 'doc', - id: 'puppeteer.page.coverage', - label: 'coverage', - }, - { - type: 'doc', - id: 'puppeteer.page.isdraginterceptionenabled', - label: 'isDragInterceptionEnabled', - }, - { - type: 'doc', - id: 'puppeteer.page.keyboard', - label: 'keyboard', - }, - { - type: 'doc', - id: 'puppeteer.page.mouse', - label: 'mouse', - }, - { - type: 'doc', - id: 'puppeteer.page.touchscreen', - label: 'touchScreen', - }, - { - type: 'doc', - id: 'puppeteer.page.tracing', - label: 'tracing', - }, - ] - }, - { - Methods: [ - { - type: 'doc', - id: 'puppeteer.page._', - label: '$', - }, - { - type: 'doc', - id: 'puppeteer.page.__', - label: '$$', - }, - { - type: 'doc', - id: 'puppeteer.page.__eval', - label: '$$eval', - }, - { - type: 'doc', - id: 'puppeteer.page._eval', - label: '$eval', - }, - { - type: 'doc', - id: 'puppeteer.page._x', - label: '$x', - }, - { - type: 'doc', - id: 'puppeteer.page.addscripttag', - label: 'addScriptTag', - }, - { - type: 'doc', - id: 'puppeteer.page.addstyletag', - label: 'addStyleTag', - }, - { - type: 'doc', - id: 'puppeteer.page.authenticate', - label: 'authenticate', - }, - { - type: 'doc', - id: 'puppeteer.page.bringtofront', - label: 'bringToFront', - }, - { - type: 'doc', - id: 'puppeteer.page.browser', - label: 'browser', - }, - { - type: 'doc', - id: 'puppeteer.page.browsercontext', - label: 'browserContext', - }, - { - type: 'doc', - id: 'puppeteer.page.click', - label: 'click', - }, - { - type: 'doc', - id: 'puppeteer.page.close', - label: 'close', - }, - { - type: 'doc', - id: 'puppeteer.page.content', - label: 'content()', - }, - { - type: 'doc', - id: 'puppeteer.page.cookies', - label: 'cookies', - }, - { - type: 'doc', - id: 'puppeteer.page.createpdfstream', - label: 'createPDFStream', - }, - { - type: 'doc', - id: 'puppeteer.page.deletecookie', - label: 'deleteCookie', - }, - { - type: 'doc', - id: 'puppeteer.page.emulate', - label: 'emulate', - }, - { - type: 'doc', - id: 'puppeteer.page.emulatecputhrottling', - label: 'emulateCPUThrottling', - }, - { - type: 'doc', - id: 'puppeteer.page.emulateidlestate', - label: 'emulateIdleState', - }, - { - type: 'doc', - id: 'puppeteer.page.emulatemediafeatures', - label: 'emulateMediaFeatures', - }, - { - type: 'doc', - id: 'puppeteer.page.emulatenetworkconditions', - label: 'emulateNetworkConditions', - }, - { - type: 'doc', - id: 'puppeteer.page.emulatetimezone', - label: 'emulateTimeZone', - }, - { - type: 'doc', - id: 'puppeteer.page.emulatevisiondeficiency', - label: 'emulateVisionDefinciency', - }, - { - type: 'doc', - id: 'puppeteer.page.evaluate', - label: 'evaluate', - }, - { - type: 'doc', - id: 'puppeteer.page.evaluatehandle', - label: 'evaluateHandle', - }, - { - type: 'doc', - id: 'puppeteer.page.evaluateonnewdocument', - label: 'evaluateOnNewDocument', - }, - { - type: 'doc', - id: 'puppeteer.page.exposefunction', - label: 'exposeFunction', - }, - { - type: 'doc', - id: 'puppeteer.page.focus', - label: 'focus', - }, - { - type: 'doc', - id: 'puppeteer.page.frames', - label: 'frames', - }, - { - type: 'doc', - id: 'puppeteer.page.goback', - label: 'goBack', - }, - { - type: 'doc', - id: 'puppeteer.page.goforward', - label: 'goForward', - }, - { - type: 'doc', - id: 'puppeteer.page.goto', - label: 'goTo', - }, - { - type: 'doc', - id: 'puppeteer.page.hover', - label: 'hover', - }, - { - type: 'doc', - id: 'puppeteer.page.isclosed', - label: 'isClosed', - }, - { - type: 'doc', - id: 'puppeteer.page.isjavascriptenabled', - label: 'isJavaScriptEnbled', - }, - { - type: 'doc', - id: 'puppeteer.page.mainframe', - label: 'mainFrame', - }, - { - type: 'doc', - id: 'puppeteer.page.metrics', - label: 'metrics', - }, - { - type: 'doc', - id: 'puppeteer.page.once', - label: 'once', - }, - { - type: 'doc', - id: 'puppeteer.page.pdf', - label: 'PDF', - }, - { - type: 'doc', - id: 'puppeteer.page.queryobjects', - label: 'queryObjects', - }, - { - type: 'doc', - id: 'puppeteer.page.reload', - label: 'reload', - }, - { - type: 'doc', - id: 'puppeteer.page.screenshot', - label: 'screenshot', - }, - { - type: 'doc', - id: 'puppeteer.page.select', - label: 'select', - }, - { - type: 'doc', - id: 'puppeteer.page.setbypasscsp', - label: 'setByPassCSP', - }, - { - type: 'doc', - id: 'puppeteer.page.setcacheenabled', - label: 'setCacheEnaled', - }, - { - type: 'doc', - id: 'puppeteer.page.setcontent', - label: 'setContent', - }, - { - type: 'doc', - id: 'puppeteer.page.setcookie', - label: 'setCookie', - }, - { - type: 'doc', - id: 'puppeteer.page.setdefaultnavigationtimeout', - label: 'setDefaultNavigationTimeOut', - }, - { - type: 'doc', - id: 'puppeteer.page.setdefaulttimeout', - label: 'setDefaultTimeOut', - }, - { - type: 'doc', - id: 'puppeteer.page.setdraginterception', - label: 'setDragInterception', - }, - { - type: 'doc', - id: 'puppeteer.page.setextrahttpheaders', - label: 'setExtraHTTPHeader', - }, - { - type: 'doc', - id: 'puppeteer.page.setgeolocation', - label: 'setGeoLocation', - }, - { - type: 'doc', - id: 'puppeteer.page.setjavascriptenabled', - label: 'setJavaScriptEnabled', - }, - { - type: 'doc', - id: 'puppeteer.page.setofflinemode', - label: 'setOfflineMode', - }, - { - type: 'doc', - id: 'puppeteer.page.setrequestinterception', - label: 'setRequestInterception', - }, - { - type: 'doc', - id: 'puppeteer.page.setuseragent', - label: 'setUserAgent', - }, - { - type: 'doc', - id: 'puppeteer.page.setviewport', - label: 'setViewPort', - }, - { - type: 'doc', - id: 'puppeteer.page.tap', - label: 'tap', - }, - { - type: 'doc', - id: 'puppeteer.page.target', - label: 'target', - }, - { - type: 'doc', - id: 'puppeteer.page.title', - label: 'title', - }, - { - type: 'doc', - id: 'puppeteer.page.type', - label: 'type', - }, - { - type: 'doc', - id: 'puppeteer.page.url', - label: 'url', - }, - { - type: 'doc', - id: 'puppeteer.page.viewport', - label: 'viewport', - }, - { - type: 'doc', - id: 'puppeteer.page.waitfor', - label: 'waitFor', - }, - { - type: 'doc', - id: 'puppeteer.page.waitforfilechooser', - label: 'waitForFileChooser', - }, - { - type: 'doc', - id: 'puppeteer.page.waitforfunction', - label: 'waitForFunction', - }, - { - type: 'doc', - id: 'puppeteer.page.waitfornavigation', - label: 'waitForNavigation', - }, - { - type: 'doc', - id: 'puppeteer.page.waitforrequest', - label: 'waitForRequest', - }, - { - type: 'doc', - id: 'puppeteer.page.waitforresponse', - label: 'waitForResponse', - }, - { - type: 'doc', - id: 'puppeteer.page.waitforselector', - label: 'waitForSelector', - }, - { - type: 'doc', - id: 'puppeteer.page.waitfortimeout', - label: 'waittimeout', - }, - { - type: 'doc', - id: 'puppeteer.page.waitforxpath', - label: 'waitForXPath', - }, - { - type: 'doc', - id: 'puppeteer.page.workers', - label: 'workers', - }, - ] - }, - ], - "WebWorker": [ - { - type: 'doc', - id: 'puppeteer.webworker', - label: 'WebWorker', - }, - { - Methods: [ - { - type: 'doc', - id: 'puppeteer.webworker.evaluate', - label: 'evaluate', - }, - { - type: 'doc', - id: 'puppeteer.webworker.evaluatehandle', - label: 'evaluatehandle', - }, - { - type: 'doc', - id: 'puppeteer.webworker.executioncontext', - label: 'executioncontext', - }, - { - type: 'doc', - id: 'puppeteer.webworker.url', - label: 'url', - }, - ] - }, - ], - "Accessibility": [ - { - type: 'doc', - id: 'puppeteer.accessibility', - label: 'Accessibility', - }, - { - Methods: [ - { - type: 'doc', - id: 'puppeteer.accessibility.snapshot', - label: 'snapshot', - }, - ] - }, - ], - "Keyboard": [ - { - type: 'doc', - id: 'puppeteer.keyboard', - label: 'keyboard', - }, - { - Methods: [ - { - type: 'doc', - id: 'puppeteer.keyboard.down', - label: 'down', - }, - { - type: 'doc', - id: 'puppeteer.keyboard.press', - label: 'press', - }, - { - type: 'doc', - id: 'puppeteer.keyboard.sendcharacter', - label: 'sendCharacter', - }, - { - type: 'doc', - id: 'puppeteer.keyboard.type', - label: 'type', - }, - { - type: 'doc', - id: 'puppeteer.keyboard.up', - label: 'up', - }, - ] - }, - ], - "Mouse": [ - { - type: 'doc', - id: 'puppeteer.mouse', - label: 'mouse', - }, - { - Methods: [ - { - type: 'doc', - id: 'puppeteer.mouse.click', - label: 'click', - }, - { - type: 'doc', - id: 'puppeteer.mouse.down', - label: 'down', - }, - { - type: 'doc', - id: 'puppeteer.mouse.drag', - label: 'drag', - }, - { - type: 'doc', - id: 'puppeteer.mouse.draganddrop', - label: 'dragAndDrop', - }, - { - type: 'doc', - id: 'puppeteer.mouse.dragenter', - label: 'dragEnter', - }, - { - type: 'doc', - id: 'puppeteer.mouse.dragover', - label: 'dragOver', - }, - { - type: 'doc', - id: 'puppeteer.mouse.drop', - label: 'drop', - }, - { - type: 'doc', - id: 'puppeteer.mouse.move', - label: 'move', - }, - { - type: 'doc', - id: 'puppeteer.mouse.up', - label: 'up', - }, - { - type: 'doc', - id: 'puppeteer.mouse.wheel', - label: 'wheel', - }, - ] - }, - ], - "TouchScreen": [ - { - type: 'doc', - id: 'puppeteer.touchscreen', - label: 'touchScreen', - }, - { - Methods: [ - { - type: 'doc', - id: 'puppeteer.touchscreen.tap', - label: 'tap' - } - ] - }, - ], - "Tracing": [ - { - type: 'doc', - id: 'puppeteer.tracing', - label: 'Tracing', - }, - { - Methods: [ - { - type: 'doc', - id: 'puppeteer.tracing._client', - label: 'client', - }, - { - type: 'doc', - id: 'puppeteer.tracing._path', - label: 'path', - }, - { - type: 'doc', - id: 'puppeteer.tracing._recording', - label: 'recording', - }, - { - type: 'doc', - id: 'puppeteer.tracing.start', - label: 'start', - }, - { - type: 'doc', - id: 'puppeteer.tracing.stop', - label: 'stop', - }, - ] - }, - ], - "Dialog": [ - { - type: 'doc', - id: 'puppeteer.dialog', - label: 'dialog', - }, - { - Methods: [ - { - type: 'doc', - id: 'puppeteer.dialog.accept', - label: 'accept', - }, - { - type: 'doc', - id: 'puppeteer.dialog.defaultvalue', - label: 'defaultValue', - }, - { - type: 'doc', - id: 'puppeteer.dialog.dismiss', - label: 'dismiss', - }, - { - type: 'doc', - id: 'puppeteer.dialog.message', - label: 'message', - }, - { - type: 'doc', - id: 'puppeteer.dialog.type', - label: 'type', - }, - ] - }, - ], - "ConsoleMessage": [ - { - type: 'doc', - id: 'puppeteer.consolemessage', - label: 'consoleMessage', - }, - { - Methods: [ - { - type: 'doc', - id: 'puppeteer.consolemessage.args', - label: 'args', - }, - { - type: 'doc', - id: 'puppeteer.consolemessage.location', - label: 'location', - }, - { - type: 'doc', - id: 'puppeteer.consolemessage.stacktrace', - label: 'stackTrace', - }, - { - type: 'doc', - id: 'puppeteer.consolemessage.text', - label: 'text', - }, - { - type: 'doc', - id: 'puppeteer.consolemessage.type', - label: 'type', - }, - ] - }, - ], - "Frame": [ - { - type: 'doc', - id: 'puppeteer.frame', - label: 'frame', - }, - { - Methods: [ - { - type: 'doc', - id: 'puppeteer.frame._', - label: '$', - }, - { - type: 'doc', - id: 'puppeteer.frame.__', - label: '$$', - }, - { - type: 'doc', - id: 'puppeteer.frame.__eval', - label: '$$eval', - }, - { - type: 'doc', - id: 'puppeteer.frame._eval', - label: '$eval', - }, - { - type: 'doc', - id: 'puppeteer.frame._x', - label: '$x', - }, - { - type: 'doc', - id: 'puppeteer.frame.addscripttag', - label: 'addScriptTag', - }, - { - type: 'doc', - id: 'puppeteer.frame.addstyletag', - label: 'addStyleTag', - }, - { - type: 'doc', - id: 'puppeteer.frame.childframes', - label: 'childFrames', - }, - { - type: 'doc', - id: 'puppeteer.frame.click', - label: 'click', - }, - { - type: 'doc', - id: 'puppeteer.frame.content', - label: 'content', - }, - { - type: 'doc', - id: 'puppeteer.frame.evaluate', - label: 'evaluate', - }, - { - type: 'doc', - id: 'puppeteer.frame.evaluatehandle', - label: 'evaluateHandle', - }, - { - type: 'doc', - id: 'puppeteer.frame.executioncontext', - label: 'executionContext', - }, - { - type: 'doc', - id: 'puppeteer.frame.focus', - label: 'focus', - }, - { - type: 'doc', - id: 'puppeteer.frame.goto', - label: 'goTo', - }, - { - type: 'doc', - id: 'puppeteer.frame.hover', - label: 'hover', - }, - { - type: 'doc', - id: 'puppeteer.frame.isdetached', - label: 'isDetached', - }, - { - type: 'doc', - id: 'puppeteer.frame.name', - label: 'name', - }, - { - type: 'doc', - id: 'puppeteer.frame.parentframe', - label: 'parentFrame', - }, - { - type: 'doc', - id: 'puppeteer.frame.select', - label: 'select', - }, - { - type: 'doc', - id: 'puppeteer.frame.setcontent', - label: 'setContent', - }, - { - type: 'doc', - id: 'puppeteer.frame.tap', - label: 'tap', - }, - { - type: 'doc', - id: 'puppeteer.frame.title', - label: 'title', - }, - { - type: 'doc', - id: 'puppeteer.frame.type', - label: 'type', - }, - { - type: 'doc', - id: 'puppeteer.frame.url', - label: 'url', - }, - { - type: 'doc', - id: 'puppeteer.frame.waitfor', - label: 'waitFor', - }, - { - type: 'doc', - id: 'puppeteer.frame.waitforfunction', - label: 'waitForFunction', - }, - { - type: 'doc', - id: 'puppeteer.frame.waitfornavigation', - label: 'waitForNavigation', - }, - { - type: 'doc', - id: 'puppeteer.frame.waitforselector', - label: 'waitForSelector', - }, - { - type: 'doc', - id: 'puppeteer.frame.waitfortimeout', - label: 'waitForTimeOut', - }, - { - type: 'doc', - id: 'puppeteer.frame.waitforxpath', - label: 'waitForXPath', - }, - ] - } - ], - "FileChooser": [ - { - type: 'doc', - id: 'puppeteer.filechooser', - label: 'FileChooser', - }, - { - Methods: [ - { - type: 'doc', - id: 'puppeteer.filechooser.accept', - label: 'accept', - }, - { - type: 'doc', - id: 'puppeteer.filechooser.cancel', - label: 'cancel', - }, - { - type: 'doc', - id: 'puppeteer.filechooser.ismultiple', - label: 'ismultiple', - }, - ] - }, - ], - "ExecutionContext": [ - { - type: 'doc', - id: 'puppeteer.executioncontext', - label: 'executionContext', - }, - { - Methods: [ - { - type: 'doc', - id: 'puppeteer.executioncontext.evaluate', - label: 'evaluate', - }, - { - type: 'doc', - id: 'puppeteer.executioncontext.evaluatehandle', - label: 'evaluateHandle', - }, - { - type: 'doc', - id: 'puppeteer.executioncontext.frame', - label: 'frame', - }, - { - type: 'doc', - id: 'puppeteer.executioncontext.queryobjects', - label: 'queryobjects', - }, - ] - }, - ], - "JSHandle": [ - { - type: 'doc', - id: 'puppeteer.jshandle', - label: 'JSHandle', - }, - { - Methods: [ - { - type: 'doc', - id: 'puppeteer.jshandle.aselement', - label: 'asElement', - }, - { - type: 'doc', - id: 'puppeteer.jshandle.dispose', - label: 'dispose', - }, - { - type: 'doc', - id: 'puppeteer.jshandle.evaluate', - label: 'evaluate', - }, - { - type: 'doc', - id: 'puppeteer.jshandle.evaluatehandle', - label: 'evaluateHandle', - }, - { - type: 'doc', - id: 'puppeteer.jshandle.executioncontext', - label: 'executionContext', - }, - { - type: 'doc', - id: 'puppeteer.jshandle.getproperties', - label: 'getProperties', - }, - { - type: 'doc', - id: 'puppeteer.jshandle.getproperty', - label: 'getProperty', - }, - { - type: 'doc', - id: 'puppeteer.jshandle.jsonvalue', - label: 'JSONValue', - }, - ] - }, - ], - "ElementHandle": [ - { - type: 'doc', - id: 'puppeteer.elementhandle', - label: 'elementHandle', - }, - { - Methods: [ - { - type: 'doc', - id: 'puppeteer.elementhandle._', - label: '$', - }, - { - type: 'doc', - id: 'puppeteer.elementhandle.__', - label: '$$', - }, - { - type: 'doc', - id: 'puppeteer.elementhandle.__eval', - label: '$$eval', - }, - { - type: 'doc', - id: 'puppeteer.elementhandle._eval', - label: '$eval', - }, - { - type: 'doc', - id: 'puppeteer.elementhandle._x', - label: '$x', - }, - { - type: 'doc', - id: 'puppeteer.elementhandle.aselement', - label: 'asElement', - }, - { - type: 'doc', - id: 'puppeteer.elementhandle.boundingbox', - label: 'boundingBox', - }, - { - type: 'doc', - id: 'puppeteer.elementhandle.boxmodel', - label: 'boxModel', - }, - { - type: 'doc', - id: 'puppeteer.elementhandle.click', - label: 'click', - }, - { - type: 'doc', - id: 'puppeteer.elementhandle.contentframe', - label: 'contentFrame', - }, - { - type: 'doc', - id: 'puppeteer.elementhandle.focus', - label: 'focus', - }, - { - type: 'doc', - id: 'puppeteer.elementhandle.hover', - label: 'hover', - }, - { - type: 'doc', - id: 'puppeteer.elementhandle.clickablepoint', - label: 'clickablePoint', - }, - { - type: 'doc', - id: 'puppeteer.elementhandle.drag', - label: 'drag', - }, - { - type: 'doc', - id: 'puppeteer.elementhandle.draganddrop', - label: 'dragAndDrop', - }, - { - type: 'doc', - id: 'puppeteer.elementhandle.dragenter', - label: 'dragEnter', - }, - { - type: 'doc', - id: 'puppeteer.elementhandle.dragover', - label: 'dragOver', - }, - { - type: 'doc', - id: 'puppeteer.elementhandle.drop', - label: 'drop', - }, - { - type: 'doc', - id: 'puppeteer.elementhandle.isintersectingviewport', - label: 'isIntersectingViewPort', - }, - { - type: 'doc', - id: 'puppeteer.elementhandle.press', - label: 'press', - }, - { - type: 'doc', - id: 'puppeteer.elementhandle.screenshot', - label: 'screenshot', - }, - { - type: 'doc', - id: 'puppeteer.elementhandle.select', - label: 'select', - }, - { - type: 'doc', - id: 'puppeteer.elementhandle.tap', - label: 'tap', - }, - { - type: 'doc', - id: 'puppeteer.elementhandle.type', - label: 'type', - }, - { - type: 'doc', - id: 'puppeteer.elementhandle.uploadfile', - label: 'uploadFile', - }, - ] - }, - ], - "HTTPRequest": [ - { - type: 'doc', - id: 'puppeteer.httprequest', - label: 'httpRequest', - }, - { - Methods: [ - { - type: 'doc', - id: 'puppeteer.httprequest.abort', - label: 'abort', - }, - { - type: 'doc', - id: 'puppeteer.httprequest.aborterrorreason', - label: 'abortErrorReason', - }, - { - type: 'doc', - id: 'puppeteer.httprequest.enqueueinterceptaction', - label: 'enqueueInterCeptaction', - }, - { - type: 'doc', - id: 'puppeteer.httprequest.failure', - label: 'failure', - }, - { - type: 'doc', - id: 'puppeteer.httprequest.finalizeinterceptions', - label: 'finalizeInterception', - }, - { - type: 'doc', - id: 'puppeteer.httprequest.frame', - label: 'frame', - }, - { - type: 'doc', - id: 'puppeteer.httprequest.headers', - label: 'headers', - }, - { - type: 'doc', - id: 'puppeteer.httprequest.isnavigationrequest', - label: 'isNavigationRequest', - }, - { - type: 'doc', - id: 'puppeteer.httprequest.method', - label: 'method', - }, - { - type: 'doc', - id: 'puppeteer.httprequest.postdata', - label: 'postData', - }, - { - type: 'doc', - id: 'puppeteer.httprequest.redirectchain', - label: 'redirectChain', - }, - { - type: 'doc', - id: 'puppeteer.httprequest.resourcetype', - label: 'resourceType', - }, - { - type: 'doc', - id: 'puppeteer.httprequest.respond', - label: 'respond', - }, - { - type: 'doc', - id: 'puppeteer.httprequest.response', - label: 'response', - }, - { - type: 'doc', - id: 'puppeteer.httprequest.responseforrequest', - label: 'responseForRequest', - }, - { - type: 'doc', - id: 'puppeteer.httprequest.url', - label: 'hurl', - }, - ] - }, - ], - "HTTPRespose": [ - { - type: 'doc', - id: 'puppeteer.httpresponse', - label: 'httpResponse', - }, - { - Methods: [ - { - type: 'doc', - id: 'puppeteer.httpresponse.buffer', - label: 'buffer', - }, - { - type: 'doc', - id: 'puppeteer.httpresponse.frame', - label: 'frame', - }, - { - type: 'doc', - id: 'puppeteer.httpresponse.fromcache', - label: 'fromCache', - }, - { - type: 'doc', - id: 'puppeteer.httpresponse.fromserviceworker', - label: 'fromServiceWorker', - }, - { - type: 'doc', - id: 'puppeteer.httpresponse.headers', - label: 'headers', - }, - { - type: 'doc', - id: 'puppeteer.httpresponse.json', - label: 'JSON', - }, - { - type: 'doc', - id: 'puppeteer.httpresponse.ok', - label: 'OK', - }, - { - type: 'doc', - id: 'puppeteer.httpresponse.remoteaddress', - label: 'remoteAddress', - }, - { - type: 'doc', - id: 'puppeteer.httpresponse.request', - label: 'request', - }, - { - type: 'doc', - id: 'puppeteer.httpresponse.securitydetails', - label: 'securityDetails', - }, - { - type: 'doc', - id: 'puppeteer.httpresponse.status', - label: 'status', - }, - { - type: 'doc', - id: 'puppeteer.httpresponse.statustext', - label: 'statusText', - }, - { - type: 'doc', - id: 'puppeteer.httpresponse.text', - label: 'text', - }, - { - type: 'doc', - id: 'puppeteer.httpresponse.url', - label: 'URL', - }, - ] - }, - ], - "SecurityDetails": [ - { - type: 'doc', - id: 'puppeteer.securitydetails', - label: 'securityDetails', - }, - { - Methods: [ - { - type: 'doc', - id: 'puppeteer.securitydetails.issuer', - label: 'issuer', - }, - { - type: 'doc', - id: 'puppeteer.securitydetails.protocol', - label: 'protocol', - }, - { - type: 'doc', - id: 'puppeteer.securitydetails.subjectalternativenames', - label: 'subjectAlternativeNames', - }, - { - type: 'doc', - id: 'puppeteer.securitydetails.subjectname', - label: 'subjectName', - }, - { - type: 'doc', - id: 'puppeteer.securitydetails.validfrom', - label: 'validFrom', - }, - { - type: 'doc', - id: 'puppeteer.securitydetails.validto', - label: 'validTo', - }, - ] - }, - ], - "Target": [ - { - type: 'doc', - id: 'puppeteer.target', - label: 'target', - }, - { - Methods: [ - { - type: 'doc', - id: 'puppeteer.target.browser', - label: 'browser', - }, - { - type: 'doc', - id: 'puppeteer.target.browsercontext', - label: 'browserContext', - }, - { - type: 'doc', - id: 'puppeteer.target.createcdpsession', - label: 'createCDPSSession', - }, - { - type: 'doc', - id: 'puppeteer.target.opener', - label: 'opener', - }, - { - type: 'doc', - id: 'puppeteer.target.page', - label: 'page', - }, - { - type: 'doc', - id: 'puppeteer.target.type', - label: 'type', - }, - { - type: 'doc', - id: 'puppeteer.target.url', - label: 'url', - }, - { - type: 'doc', - id: 'puppeteer.target.worker', - label: 'worker', - }, - ] - }, - ], - "CDPSession": [ - { - type: 'doc', - id: 'puppeteer.cdpsession', - label: 'CDPSession', - }, - { - Methods: [ - { - type: 'doc', - id: 'puppeteer.cdpsession.connection', - label: 'connection', - }, - { - type: 'doc', - id: 'puppeteer.cdpsession.detach', - label: 'detach', - }, - { - type: 'doc', - id: 'puppeteer.cdpsession.send', - label: 'send', - }, - ] - }, - ], - "Coverage": [ - { - type: 'doc', - id: 'puppeteer.coverage', - label: 'coverage', - }, - { - Methods: [ - { - type: 'doc', - id: 'puppeteer.coverage.startcsscoverage', - label: 'startCSSCoverage', - }, - { - type: 'doc', - id: 'puppeteer.coverage.startjscoverage', - label: 'startJSCoverage', - }, - { - type: 'doc', - id: 'puppeteer.coverage.stopcsscoverage', - label: 'stopCSSCoverage', - }, - { - type: 'doc', - id: 'puppeteer.coverage.stopjscoverage', - label: 'stopJSCoverage', - }, - ] - }, - ], - "TimeOutError": [ - { - type: 'doc', - id: 'puppeteer.timeouterror', - label: 'timeOutError', - }, - ], - "EventEmitter": [ - { - type: 'doc', - id: 'puppeteer.eventemitter', - label: 'eventEmitter', - }, - { - Methods: [ - { - type: 'doc', - id: 'puppeteer.eventemitter.addlistener', - label: 'addListener', - }, - { - type: 'doc', - id: 'puppeteer.eventemitter.emit', - label: 'emit', - }, - { - type: 'doc', - id: 'puppeteer.eventemitter.listenercount', - label: 'listenerCount', - }, - { - type: 'doc', - id: 'puppeteer.eventemitter.off', - label: 'off', - }, - { - type: 'doc', - id: 'puppeteer.eventemitter.on', - label: 'on', - }, - { - type: 'doc', - id: 'puppeteer.eventemitter.once', - label: 'once', - }, - { - type: 'doc', - id: 'puppeteer.eventemitter.removelistener', - label: 'removeListener', - },{ - type: 'doc', - id: 'puppeteer.eventemitter.removealllisteners', - label: 'removeAllListener', - }, - ] - }, - ], - }, -}; diff --git a/website/src/css/custom.css b/website/src/css/custom.css deleted file mode 100644 index ae8906ba..00000000 --- a/website/src/css/custom.css +++ /dev/null @@ -1,45 +0,0 @@ -/** - * Copyright 2021 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. - */ - -/* stylelint-disable docusaurus/copyright-header */ -/** - * Any CSS included here will be global. The classic template - * bundles Infima by default. Infima is a CSS framework designed to - * work well for content-centric websites. - */ - -/* You can override the default Infima variables here. */ -:root { - --ifm-color-primary: rgb(64 181 164); - --ifm-color-primary-dark: rgb(33, 175, 144); - --ifm-color-primary-darker: rgb(31, 165, 136); - --ifm-color-primary-darkest: rgb(26, 136, 112); - --ifm-color-primary-light: rgb(70, 203, 174); - --ifm-color-primary-lighter: rgb(102, 212, 189); - --ifm-color-primary-lightest: rgb(146, 224, 208); - --ifm-code-font-size: 95%; -} - -.docusaurus-highlight-code-line { - background-color: rgba(0, 0, 0, 0.1); - display: block; - margin: 0 calc(-1 * var(--ifm-pre-padding)); - padding: 0 var(--ifm-pre-padding); -} - -html[data-theme='dark'] .docusaurus-highlight-code-line { - background-color: rgba(0, 0, 0, 0.3); -} diff --git a/website/src/pages/index.md b/website/src/pages/index.md deleted file mode 100644 index e3a2ad65..00000000 --- a/website/src/pages/index.md +++ /dev/null @@ -1,462 +0,0 @@ -# Puppeteer - - - -[![Build status](https://github.com/puppeteer/puppeteer/workflows/run-checks/badge.svg)](https://github.com/puppeteer/puppeteer/actions?query=workflow%3Arun-checks) [![npm puppeteer package](https://img.shields.io/npm/v/puppeteer.svg)](https://npmjs.org/package/puppeteer) - - - - - -###### [API](https://github.com/puppeteer/puppeteer/blob/v10.0.0/docs/api.md) | [FAQ](#faq) | [Contributing](https://github.com/puppeteer/puppeteer/blob/main/CONTRIBUTING.md) | [Troubleshooting](https://github.com/puppeteer/puppeteer/blob/main/docs/troubleshooting.md) - -> Puppeteer is a Node library which provides a high-level API to control Chrome or Chromium over the [DevTools Protocol](https://chromedevtools.github.io/devtools-protocol/). Puppeteer runs [headless](https://developers.google.com/web/updates/2017/04/headless-chrome) by default, but can be configured to run full (non-headless) Chrome or Chromium. - - - -###### What can I do? - -Most things that you can do manually in the browser can be done using Puppeteer! Here are a few examples to get you started: - -- Generate screenshots and PDFs of pages. -- Crawl a SPA (Single-Page Application) and generate pre-rendered content (i.e. "SSR" (Server-Side Rendering)). -- Automate form submission, UI testing, keyboard input, etc. -- Create an up-to-date, automated testing environment. Run your tests directly in the latest version of Chrome using the latest JavaScript and browser features. -- Capture a [timeline trace](https://developers.google.com/web/tools/chrome-devtools/evaluate-performance/reference) of your site to help diagnose performance issues. -- Test Chrome Extensions. - - -Give it a spin: https://try-puppeteer.appspot.com/ - - - -## Getting Started - -### Installation - -To use Puppeteer in your project, run: - -```bash -npm i puppeteer -# or "yarn add puppeteer" -``` - -Note: When you install Puppeteer, it downloads a recent version of Chromium (~170MB Mac, ~282MB Linux, ~280MB Win) that is guaranteed to work with the API. To skip the download, or to download a different browser, see [Environment variables](https://github.com/puppeteer/puppeteer/blob/v10.0.0/docs/api.md#environment-variables). - -### puppeteer-core - -Since version 1.7.0 we publish the [`puppeteer-core`](https://www.npmjs.com/package/puppeteer-core) package, -a version of Puppeteer that doesn't download any browser by default. - -```bash -npm i puppeteer-core -# or "yarn add puppeteer-core" -``` - -`puppeteer-core` is intended to be a lightweight version of Puppeteer for launching an existing browser installation or for connecting to a remote one. Be sure that the version of puppeteer-core you install is compatible with the -browser you intend to connect to. - -See [puppeteer vs puppeteer-core](https://github.com/puppeteer/puppeteer/blob/main/docs/api.md#puppeteer-vs-puppeteer-core). - -### Usage - -Puppeteer follows the latest [maintenance LTS](https://github.com/nodejs/Release#release-schedule) version of Node. - -Note: Prior to v1.18.1, Puppeteer required at least Node v6.4.0. Versions from v1.18.1 to v2.1.0 rely on -Node 8.9.0+. Starting from v3.0.0 Puppeteer starts to rely on Node 10.18.1+. All examples below use async/await which is only supported in Node v7.6.0 or greater. - -Puppeteer will be familiar to people using other browser testing frameworks. You create an instance -of `Browser`, open pages, and then manipulate them with [Puppeteer's API](https://github.com/puppeteer/puppeteer/blob/v10.0.0/docs/api.md#). - -**Example** - navigating to https://example.com and saving a screenshot as _example.png_: - -Save file as **example.js** - -```js -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: 'example.png' }); - - await browser.close(); -})(); -``` - -Execute script on the command line - -```bash -node example.js -``` - -Puppeteer sets an initial page size to 800×600px, which defines the screenshot size. The page size can be customized with [`Page.setViewport()`](https://github.com/puppeteer/puppeteer/blob/v10.0.0/docs/api.md#pagesetviewportviewport). - -**Example** - create a PDF. - -Save file as **hn.js** - -```js -const puppeteer = require('puppeteer'); - -(async () => { - const browser = await puppeteer.launch(); - const page = await browser.newPage(); - await page.goto('https://news.ycombinator.com', { - waitUntil: 'networkidle2', - }); - await page.pdf({ path: 'hn.pdf', format: 'a4' }); - - await browser.close(); -})(); -``` - -Execute script on the command line - -```bash -node hn.js -``` - -See [`Page.pdf()`](https://github.com/puppeteer/puppeteer/blob/v10.0.0/docs/api.md#pagepdfoptions) for more information about creating pdfs. - -**Example** - evaluate script in the context of the page - -Save file as **get-dimensions.js** - -```js -const puppeteer = require('puppeteer'); - -(async () => { - const browser = await puppeteer.launch(); - const page = await browser.newPage(); - await page.goto('https://example.com'); - - // Get the "viewport" of the page, as reported by the page. - const dimensions = await page.evaluate(() => { - return { - width: document.documentElement.clientWidth, - height: document.documentElement.clientHeight, - deviceScaleFactor: window.devicePixelRatio, - }; - }); - - console.log('Dimensions:', dimensions); - - await browser.close(); -})(); -``` - -Execute script on the command line - -```bash -node get-dimensions.js -``` - -See [`Page.evaluate()`](https://github.com/puppeteer/puppeteer/blob/v10.0.0/docs/api.md#pageevaluatepagefunction-args) for more information on `evaluate` and related methods like `evaluateOnNewDocument` and `exposeFunction`. - - - - - -## Default runtime settings - -**1. Uses Headless mode** - -Puppeteer launches Chromium in [headless mode](https://developers.google.com/web/updates/2017/04/headless-chrome). To launch a full version of Chromium, set the [`headless` option](https://github.com/puppeteer/puppeteer/blob/v10.0.0/docs/api.md#puppeteerlaunchoptions) when launching a browser: - -```js -const browser = await puppeteer.launch({ headless: false }); // default is true -``` - -**2. Runs a bundled version of Chromium** - -By default, Puppeteer downloads and uses a specific version of Chromium so its API -is guaranteed to work out of the box. To use Puppeteer with a different version of Chrome or Chromium, -pass in the executable's path when creating a `Browser` instance: - -```js -const browser = await puppeteer.launch({ executablePath: '/path/to/Chrome' }); -``` - -You can also use Puppeteer with Firefox Nightly (experimental support). See [`Puppeteer.launch()`](https://github.com/puppeteer/puppeteer/blob/v10.0.0/docs/api.md#puppeteerlaunchoptions) for more information. - -See [`this article`](https://www.howtogeek.com/202825/what%E2%80%99s-the-difference-between-chromium-and-chrome/) for a description of the differences between Chromium and Chrome. [`This article`](https://chromium.googlesource.com/chromium/src/+/master/docs/chromium_browser_vs_google_chrome.md) describes some differences for Linux users. - -**3. Creates a fresh user profile** - -Puppeteer creates its own browser user profile which it **cleans up on every run**. - - - -## Resources - -- [API Documentation](https://github.com/puppeteer/puppeteer/blob/v10.0.0/docs/api.md) -- [Examples](https://github.com/puppeteer/puppeteer/tree/main/examples/) -- [Community list of Puppeteer resources](https://github.com/transitive-bullshit/awesome-puppeteer) - - - -## Debugging tips - -1. Turn off headless mode - sometimes it's useful to see what the browser is - displaying. Instead of launching in headless mode, launch a full version of - the browser using `headless: false`: - - ```js - const browser = await puppeteer.launch({ headless: false }); - ``` - -2. Slow it down - the `slowMo` option slows down Puppeteer operations by the - specified amount of milliseconds. It's another way to help see what's going on. - - ```js - const browser = await puppeteer.launch({ - headless: false, - slowMo: 250, // slow down by 250ms - }); - ``` - -3. Capture console output - You can listen for the `console` event. - This is also handy when debugging code in `page.evaluate()`: - - ```js - page.on('console', (msg) => console.log('PAGE LOG:', msg.text())); - - await page.evaluate(() => console.log(`url is ${location.href}`)); - ``` - -4. Use debugger in application code browser - - There are two execution context: node.js that is running test code, and the browser - running application code being tested. This lets you debug code in the - application code browser; ie code inside `evaluate()`. - - - Use `{devtools: true}` when launching Puppeteer: - - ```js - const browser = await puppeteer.launch({ devtools: true }); - ``` - - - Change default test timeout: - - jest: `jest.setTimeout(100000);` - - jasmine: `jasmine.DEFAULT_TIMEOUT_INTERVAL = 100000;` - - mocha: `this.timeout(100000);` (don't forget to change test to use [function and not '=>'](https://stackoverflow.com/a/23492442)) - - - Add an evaluate statement with `debugger` inside / add `debugger` to an existing evaluate statement: - - ```js - await page.evaluate(() => { - debugger; - }); - ``` - - The test will now stop executing in the above evaluate statement, and chromium will stop in debug mode. - -5. Use debugger in node.js - - This will let you debug test code. For example, you can step over `await page.click()` in the node.js script and see the click happen in the application code browser. - - Note that you won't be able to run `await page.click()` in - DevTools console due to this [Chromium bug](https://bugs.chromium.org/p/chromium/issues/detail?id=833928). So if - you want to try something out, you have to add it to your test file. - - - Add `debugger;` to your test, eg: - - ```js - debugger; - await page.click('a[target=_blank]'); - ``` - - - Set `headless` to `false` - - Run `node --inspect-brk`, eg `node --inspect-brk node_modules/.bin/jest tests` - - In Chrome open `chrome://inspect/#devices` and click `inspect` - - In the newly opened test browser, type `F8` to resume test execution - - Now your `debugger` will be hit and you can debug in the test browser - -6. Enable verbose logging - internal DevTools protocol traffic - will be logged via the [`debug`](https://github.com/visionmedia/debug) module under the `puppeteer` namespace. - - # Basic verbose logging - env DEBUG="puppeteer:*" node script.js - - # Protocol traffic can be rather noisy. This example filters out all Network domain messages - env DEBUG="puppeteer:*" env DEBUG_COLORS=true node script.js 2>&1 | grep -v '"Network' - -7. Debug your Puppeteer (node) code easily, using [ndb](https://github.com/GoogleChromeLabs/ndb) - -- `npm install -g ndb` (or even better, use [npx](https://github.com/zkat/npx)!) - -- add a `debugger` to your Puppeteer (node) code - -- add `ndb` (or `npx ndb`) before your test command. For example: - - `ndb jest` or `ndb mocha` (or `npx ndb jest` / `npx ndb mocha`) - -- debug your test inside chromium like a boss! - - - - - -## Usage with TypeScript - -We have recently completed a migration to move the Puppeteer source code from JavaScript to TypeScript and as of version 7.0.1 we ship our own built-in type definitions. - -If you are on a version older than 7, we recommend installing the Puppeteer type definitions from the [DefinitelyTyped](https://definitelytyped.org/) repository: - -```bash -npm install --save-dev @types/puppeteer -``` - -The types that you'll see appearing in the Puppeteer source code are based off the great work of those who have contributed to the `@types/puppeteer` package. We really appreciate the hard work those people put in to providing high quality TypeScript definitions for Puppeteer's users. - - - -## Contributing to Puppeteer - -Check out [contributing guide](https://github.com/puppeteer/puppeteer/blob/main/CONTRIBUTING.md) to get an overview of Puppeteer development. - - - -# FAQ - -#### Q: Who maintains Puppeteer? - -The Chrome DevTools team maintains the library, but we'd love your help and expertise on the project! -See [Contributing](https://github.com/puppeteer/puppeteer/blob/main/CONTRIBUTING.md). - -#### Q: What is the status of cross-browser support? - -Official Firefox support is currently experimental. The ongoing collaboration with Mozilla aims to support common end-to-end testing use cases, for which developers expect cross-browser coverage. The Puppeteer team needs input from users to stabilize Firefox support and to bring missing APIs to our attention. - -From Puppeteer v2.1.0 onwards you can specify [`puppeteer.launch({product: 'firefox'})`](https://github.com/puppeteer/puppeteer/blob/v10.0.0/docs/api.md#puppeteerlaunchoptions) to run your Puppeteer scripts in Firefox Nightly, without any additional custom patches. While [an older experiment](https://www.npmjs.com/package/puppeteer-firefox) required a patched version of Firefox, [the current approach](https://wiki.mozilla.org/Remote) works with “stock” Firefox. - -We will continue to collaborate with other browser vendors to bring Puppeteer support to browsers such as Safari. -This effort includes exploration of a standard for executing cross-browser commands (instead of relying on the non-standard DevTools Protocol used by Chrome). - -#### Q: What are Puppeteer’s goals and principles? - -The goals of the project are: - -- Provide a slim, canonical library that highlights the capabilities of the [DevTools Protocol](https://chromedevtools.github.io/devtools-protocol/). -- Provide a reference implementation for similar testing libraries. Eventually, these other frameworks could adopt Puppeteer as their foundational layer. -- Grow the adoption of headless/automated browser testing. -- Help dogfood new DevTools Protocol features...and catch bugs! -- Learn more about the pain points of automated browser testing and help fill those gaps. - -We adapt [Chromium principles](https://www.chromium.org/developers/core-principles) to help us drive product decisions: - -- **Speed**: Puppeteer has almost zero performance overhead over an automated page. -- **Security**: Puppeteer operates off-process with respect to Chromium, making it safe to automate potentially malicious pages. -- **Stability**: Puppeteer should not be flaky and should not leak memory. -- **Simplicity**: Puppeteer provides a high-level API that’s easy to use, understand, and debug. - -#### Q: Is Puppeteer replacing Selenium/WebDriver? - -**No**. Both projects are valuable for very different reasons: - -- Selenium/WebDriver focuses on cross-browser automation; its value proposition is a single standard API that works across all major browsers. -- Puppeteer focuses on Chromium; its value proposition is richer functionality and higher reliability. - -That said, you **can** use Puppeteer to run tests against Chromium, e.g. using the community-driven [jest-puppeteer](https://github.com/smooth-code/jest-puppeteer). While this probably shouldn’t be your only testing solution, it does have a few good points compared to WebDriver: - -- Puppeteer requires zero setup and comes bundled with the Chromium version it works best with, making it [very easy to start with](https://github.com/puppeteer/puppeteer/#getting-started). At the end of the day, it’s better to have a few tests running chromium-only, than no tests at all. -- Puppeteer has event-driven architecture, which removes a lot of potential flakiness. There’s no need for evil “sleep(1000)” calls in puppeteer scripts. -- Puppeteer runs headless by default, which makes it fast to run. Puppeteer v1.5.0 also exposes browser contexts, making it possible to efficiently parallelize test execution. -- Puppeteer shines when it comes to debugging: flip the “headless” bit to false, add “slowMo”, and you’ll see what the browser is doing. You can even open Chrome DevTools to inspect the test environment. - -#### Q: Why doesn’t Puppeteer v.XXX work with Chromium v.YYY? - -We see Puppeteer as an **indivisible entity** with Chromium. Each version of Puppeteer bundles a specific version of Chromium – **the only** version it is guaranteed to work with. - -This is not an artificial constraint: A lot of work on Puppeteer is actually taking place in the Chromium repository. Here’s a typical story: - -- A Puppeteer bug is reported: https://github.com/puppeteer/puppeteer/issues/2709 -- It turned out this is an issue with the DevTools protocol, so we’re fixing it in Chromium: https://chromium-review.googlesource.com/c/chromium/src/+/1102154 -- Once the upstream fix is landed, we roll updated Chromium into Puppeteer: https://github.com/puppeteer/puppeteer/pull/2769 - -However, oftentimes it is desirable to use Puppeteer with the official Google Chrome rather than Chromium. For this to work, you should install a `puppeteer-core` version that corresponds to the Chrome version. - -For example, in order to drive Chrome 71 with puppeteer-core, use `chrome-71` npm tag: - -```bash -npm install puppeteer-core@chrome-71 -``` - -#### Q: Which Chromium version does Puppeteer use? - -Look for the `chromium` entry in [revisions.ts](https://github.com/puppeteer/puppeteer/blob/main/src/revisions.ts). To find the corresponding Chromium commit and version number, search for the revision prefixed by an `r` in [OmahaProxy](https://omahaproxy.appspot.com/)'s "Find Releases" section. - -#### Q: Which Firefox version does Puppeteer use? - -Since Firefox support is experimental, Puppeteer downloads the latest [Firefox Nightly](https://wiki.mozilla.org/Nightly) when the `PUPPETEER_PRODUCT` environment variable is set to `firefox`. That's also why the value of `firefox` in [revisions.ts](https://github.com/puppeteer/puppeteer/blob/main/src/revisions.ts) is `latest` -- Puppeteer isn't tied to a particular Firefox version. - -To fetch Firefox Nightly as part of Puppeteer installation: - -```bash -PUPPETEER_PRODUCT=firefox npm i puppeteer -# or "yarn add puppeteer" -``` - -#### Q: What’s considered a “Navigation”? - -From Puppeteer’s standpoint, **“navigation” is anything that changes a page’s URL**. -Aside from regular navigation where the browser hits the network to fetch a new document from the web server, this includes [anchor navigations](https://www.w3.org/TR/html5/single-page.html#scroll-to-fragid) and [History API](https://developer.mozilla.org/en-US/docs/Web/API/History_API) usage. - -With this definition of “navigation,” **Puppeteer works seamlessly with single-page applications.** - -#### Q: What’s the difference between a “trusted" and "untrusted" input event? - -In browsers, input events could be divided into two big groups: trusted vs. untrusted. - -- **Trusted events**: events generated by users interacting with the page, e.g. using a mouse or keyboard. -- **Untrusted event**: events generated by Web APIs, e.g. `document.createEvent` or `element.click()` methods. - -Websites can distinguish between these two groups: - -- using an [`Event.isTrusted`](https://developer.mozilla.org/en-US/docs/Web/API/Event/isTrusted) event flag -- sniffing for accompanying events. For example, every trusted `'click'` event is preceded by `'mousedown'` and `'mouseup'` events. - -For automation purposes it’s important to generate trusted events. **All input events generated with Puppeteer are trusted and fire proper accompanying events.** If, for some reason, one needs an untrusted event, it’s always possible to hop into a page context with `page.evaluate` and generate a fake event: - -```js -await page.evaluate(() => { - document.querySelector('button[type=submit]').click(); -}); -``` - -#### Q: What features does Puppeteer not support? - -You may find that Puppeteer does not behave as expected when controlling pages that incorporate audio and video. (For example, [video playback/screenshots is likely to fail](https://github.com/puppeteer/puppeteer/issues/291).) There are two reasons for this: - -- Puppeteer is bundled with Chromium — not Chrome — and so by default, it inherits all of [Chromium's media-related limitations](https://www.chromium.org/audio-video). This means that Puppeteer does not support licensed formats such as AAC or H.264. (However, it is possible to force Puppeteer to use a separately-installed version Chrome instead of Chromium via the [`executablePath` option to `puppeteer.launch`](https://github.com/puppeteer/puppeteer/blob/v10.0.0/docs/api.md#puppeteerlaunchoptions). You should only use this configuration if you need an official release of Chrome that supports these media formats.) -- Since Puppeteer (in all configurations) controls a desktop version of Chromium/Chrome, features that are only supported by the mobile version of Chrome are not supported. This means that Puppeteer [does not support HTTP Live Streaming (HLS)](https://caniuse.com/#feat=http-live-streaming). - -#### Q: I am having trouble installing / running Puppeteer in my test environment. Where should I look for help? - -We have a [troubleshooting](https://github.com/puppeteer/puppeteer/blob/main/docs/troubleshooting.md) guide for various operating systems that lists the required dependencies. - -#### Q: How do I try/test a prerelease version of Puppeteer? - -You can check out this repo or install the latest prerelease from npm: - -```bash -npm i --save puppeteer@next -``` - -Please note that prerelease may be unstable and contain bugs. - -#### Q: I have more questions! Where do I ask? - -There are many ways to get help on Puppeteer: - -- [bugtracker](https://github.com/puppeteer/puppeteer/issues) -- [Stack Overflow](https://stackoverflow.com/questions/tagged/puppeteer) - -Make sure to search these channels before posting your question. - - diff --git a/website/static/.nojekyll b/website/static/.nojekyll deleted file mode 100644 index e69de29b..00000000 diff --git a/website/static/img/docusaurus.png b/website/static/img/docusaurus.png deleted file mode 100644 index f458149e..00000000 Binary files a/website/static/img/docusaurus.png and /dev/null differ diff --git a/website/static/img/favicon.ico b/website/static/img/favicon.ico deleted file mode 100644 index c01d54bc..00000000 Binary files a/website/static/img/favicon.ico and /dev/null differ diff --git a/website/static/img/logo.svg b/website/static/img/logo.svg deleted file mode 100644 index 9db6d0d0..00000000 --- a/website/static/img/logo.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/website/static/img/tutorial/docsVersionDropdown.png b/website/static/img/tutorial/docsVersionDropdown.png deleted file mode 100644 index ff1cbe68..00000000 Binary files a/website/static/img/tutorial/docsVersionDropdown.png and /dev/null differ diff --git a/website/static/img/tutorial/localeDropdown.png b/website/static/img/tutorial/localeDropdown.png deleted file mode 100644 index d7163f96..00000000 Binary files a/website/static/img/tutorial/localeDropdown.png and /dev/null differ diff --git a/website/static/img/undraw_docusaurus_mountain.svg b/website/static/img/undraw_docusaurus_mountain.svg deleted file mode 100644 index 431cef2f..00000000 --- a/website/static/img/undraw_docusaurus_mountain.svg +++ /dev/null @@ -1,170 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/website/static/img/undraw_docusaurus_react.svg b/website/static/img/undraw_docusaurus_react.svg deleted file mode 100644 index e4170504..00000000 --- a/website/static/img/undraw_docusaurus_react.svg +++ /dev/null @@ -1,169 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/website/static/img/undraw_docusaurus_tree.svg b/website/static/img/undraw_docusaurus_tree.svg deleted file mode 100644 index a05cc03d..00000000 --- a/website/static/img/undraw_docusaurus_tree.svg +++ /dev/null @@ -1 +0,0 @@ -docu_tree \ No newline at end of file diff --git a/website/versioned_docs/version-10.0.0/index.md b/website/versioned_docs/version-10.0.0/index.md deleted file mode 100644 index ee99080b..00000000 --- a/website/versioned_docs/version-10.0.0/index.md +++ /dev/null @@ -1,12 +0,0 @@ - - -[Home](./index.md) - -## API Reference - -## Packages - -| Package | Description | -| --- | --- | -| [puppeteer](./puppeteer.md) | | - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.accessibility.md b/website/versioned_docs/version-10.0.0/puppeteer.accessibility.md deleted file mode 100644 index 45f0550e..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.accessibility.md +++ /dev/null @@ -1,30 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [Accessibility](./puppeteer.accessibility.md) - -## Accessibility class - -The Accessibility class provides methods for inspecting Chromium's accessibility tree. The accessibility tree is used by assistive technology such as [screen readers](https://en.wikipedia.org/wiki/Screen_reader) or [switches](https://en.wikipedia.org/wiki/Switch_access). - -Signature: - -```typescript -export declare class Accessibility -``` - -## Remarks - -Accessibility is a very platform-specific thing. On different platforms, there are different screen readers that might have wildly different output. - -Blink - Chrome's rendering engine - has a concept of "accessibility tree", which is then translated into different platform-specific APIs. Accessibility namespace gives users access to the Blink Accessibility Tree. - -Most of the accessibility tree gets filtered out when converting from Blink AX Tree to Platform-specific AX-Tree or by assistive technologies themselves. By default, Puppeteer tries to approximate this filtering, exposing only the "interesting" nodes of the tree. - -The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `Accessibility` class. - -## Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [snapshot(options)](./puppeteer.accessibility.snapshot.md) | | Captures the current state of the accessibility tree. The returned object represents the root accessible node of the page. | - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.accessibility.snapshot.md b/website/versioned_docs/version-10.0.0/puppeteer.accessibility.snapshot.md deleted file mode 100644 index 5304955f..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.accessibility.snapshot.md +++ /dev/null @@ -1,61 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [Accessibility](./puppeteer.accessibility.md) > [snapshot](./puppeteer.accessibility.snapshot.md) - -## Accessibility.snapshot() method - -Captures the current state of the accessibility tree. The returned object represents the root accessible node of the page. - -Signature: - -```typescript -snapshot(options?: SnapshotOptions): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| options | [SnapshotOptions](./puppeteer.snapshotoptions.md) | | - -Returns: - -Promise<[SerializedAXNode](./puppeteer.serializedaxnode.md)> - -An AXNode object representing the snapshot. - -## Remarks - -\*\*NOTE\*\* The Chromium accessibility tree contains nodes that go unused on most platforms and by most screen readers. Puppeteer will discard them as well for an easier to process tree, unless `interestingOnly` is set to `false`. - -## Example 1 - -An example of dumping the entire accessibility tree: - -```js -const snapshot = await page.accessibility.snapshot(); -console.log(snapshot); - -``` - -## Example 2 - -An example of logging the focused node's name: - -```js -const snapshot = await page.accessibility.snapshot(); -const node = findFocusedNode(snapshot); -console.log(node && node.name); - -function findFocusedNode(node) { - if (node.focused) - return node; - for (const child of node.children || []) { - const foundNode = findFocusedNode(child); - return foundNode; - } - return null; -} - -``` - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.actionresult.md b/website/versioned_docs/version-10.0.0/puppeteer.actionresult.md deleted file mode 100644 index e8e6334d..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.actionresult.md +++ /dev/null @@ -1,12 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [ActionResult](./puppeteer.actionresult.md) - -## ActionResult type - - -Signature: - -```typescript -export declare type ActionResult = 'continue' | 'abort' | 'respond'; -``` diff --git a/website/versioned_docs/version-10.0.0/puppeteer.boundingbox.height.md b/website/versioned_docs/version-10.0.0/puppeteer.boundingbox.height.md deleted file mode 100644 index 9fb33326..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.boundingbox.height.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [BoundingBox](./puppeteer.boundingbox.md) > [height](./puppeteer.boundingbox.height.md) - -## BoundingBox.height property - -the height of the element in pixels. - -Signature: - -```typescript -height: number; -``` diff --git a/website/versioned_docs/version-10.0.0/puppeteer.boundingbox.md b/website/versioned_docs/version-10.0.0/puppeteer.boundingbox.md deleted file mode 100644 index 3ff86372..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.boundingbox.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [BoundingBox](./puppeteer.boundingbox.md) - -## BoundingBox interface - - -Signature: - -```typescript -export interface BoundingBox -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [height](./puppeteer.boundingbox.height.md) | number | the height of the element in pixels. | -| [width](./puppeteer.boundingbox.width.md) | number | the width of the element in pixels. | -| [x](./puppeteer.boundingbox.x.md) | number | the x coordinate of the element in pixels. | -| [y](./puppeteer.boundingbox.y.md) | number | the y coordinate of the element in pixels. | - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.boundingbox.width.md b/website/versioned_docs/version-10.0.0/puppeteer.boundingbox.width.md deleted file mode 100644 index f0fc401e..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.boundingbox.width.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [BoundingBox](./puppeteer.boundingbox.md) > [width](./puppeteer.boundingbox.width.md) - -## BoundingBox.width property - -the width of the element in pixels. - -Signature: - -```typescript -width: number; -``` diff --git a/website/versioned_docs/version-10.0.0/puppeteer.boundingbox.x.md b/website/versioned_docs/version-10.0.0/puppeteer.boundingbox.x.md deleted file mode 100644 index b64a4bdb..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.boundingbox.x.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [BoundingBox](./puppeteer.boundingbox.md) > [x](./puppeteer.boundingbox.x.md) - -## BoundingBox.x property - -the x coordinate of the element in pixels. - -Signature: - -```typescript -x: number; -``` diff --git a/website/versioned_docs/version-10.0.0/puppeteer.boundingbox.y.md b/website/versioned_docs/version-10.0.0/puppeteer.boundingbox.y.md deleted file mode 100644 index 73194ab6..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.boundingbox.y.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [BoundingBox](./puppeteer.boundingbox.md) > [y](./puppeteer.boundingbox.y.md) - -## BoundingBox.y property - -the y coordinate of the element in pixels. - -Signature: - -```typescript -y: number; -``` diff --git a/website/versioned_docs/version-10.0.0/puppeteer.boxmodel.border.md b/website/versioned_docs/version-10.0.0/puppeteer.boxmodel.border.md deleted file mode 100644 index 7c0d7c2b..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.boxmodel.border.md +++ /dev/null @@ -1,14 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [BoxModel](./puppeteer.boxmodel.md) > [border](./puppeteer.boxmodel.border.md) - -## BoxModel.border property - -Signature: - -```typescript -border: Array<{ - x: number; - y: number; - }>; -``` diff --git a/website/versioned_docs/version-10.0.0/puppeteer.boxmodel.content.md b/website/versioned_docs/version-10.0.0/puppeteer.boxmodel.content.md deleted file mode 100644 index 1abc3e85..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.boxmodel.content.md +++ /dev/null @@ -1,14 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [BoxModel](./puppeteer.boxmodel.md) > [content](./puppeteer.boxmodel.content.md) - -## BoxModel.content property - -Signature: - -```typescript -content: Array<{ - x: number; - y: number; - }>; -``` diff --git a/website/versioned_docs/version-10.0.0/puppeteer.boxmodel.height.md b/website/versioned_docs/version-10.0.0/puppeteer.boxmodel.height.md deleted file mode 100644 index c28cb8bf..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.boxmodel.height.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [BoxModel](./puppeteer.boxmodel.md) > [height](./puppeteer.boxmodel.height.md) - -## BoxModel.height property - -Signature: - -```typescript -height: number; -``` diff --git a/website/versioned_docs/version-10.0.0/puppeteer.boxmodel.margin.md b/website/versioned_docs/version-10.0.0/puppeteer.boxmodel.margin.md deleted file mode 100644 index 876a8d08..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.boxmodel.margin.md +++ /dev/null @@ -1,14 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [BoxModel](./puppeteer.boxmodel.md) > [margin](./puppeteer.boxmodel.margin.md) - -## BoxModel.margin property - -Signature: - -```typescript -margin: Array<{ - x: number; - y: number; - }>; -``` diff --git a/website/versioned_docs/version-10.0.0/puppeteer.boxmodel.md b/website/versioned_docs/version-10.0.0/puppeteer.boxmodel.md deleted file mode 100644 index eadbcab8..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.boxmodel.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [BoxModel](./puppeteer.boxmodel.md) - -## BoxModel interface - - -Signature: - -```typescript -export interface BoxModel -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [border](./puppeteer.boxmodel.border.md) | Array<{ x: number; y: number; }> | | -| [content](./puppeteer.boxmodel.content.md) | Array<{ x: number; y: number; }> | | -| [height](./puppeteer.boxmodel.height.md) | number | | -| [margin](./puppeteer.boxmodel.margin.md) | Array<{ x: number; y: number; }> | | -| [padding](./puppeteer.boxmodel.padding.md) | Array<{ x: number; y: number; }> | | -| [width](./puppeteer.boxmodel.width.md) | number | | - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.boxmodel.padding.md b/website/versioned_docs/version-10.0.0/puppeteer.boxmodel.padding.md deleted file mode 100644 index 11761bb4..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.boxmodel.padding.md +++ /dev/null @@ -1,14 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [BoxModel](./puppeteer.boxmodel.md) > [padding](./puppeteer.boxmodel.padding.md) - -## BoxModel.padding property - -Signature: - -```typescript -padding: Array<{ - x: number; - y: number; - }>; -``` diff --git a/website/versioned_docs/version-10.0.0/puppeteer.boxmodel.width.md b/website/versioned_docs/version-10.0.0/puppeteer.boxmodel.width.md deleted file mode 100644 index 4e9cfb32..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.boxmodel.width.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [BoxModel](./puppeteer.boxmodel.md) > [width](./puppeteer.boxmodel.width.md) - -## BoxModel.width property - -Signature: - -```typescript -width: number; -``` diff --git a/website/versioned_docs/version-10.0.0/puppeteer.browser.browsercontexts.md b/website/versioned_docs/version-10.0.0/puppeteer.browser.browsercontexts.md deleted file mode 100644 index 4ec2e04d..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.browser.browsercontexts.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [Browser](./puppeteer.browser.md) > [browserContexts](./puppeteer.browser.browsercontexts.md) - -## Browser.browserContexts() method - -Returns an array of all open browser contexts. In a newly created browser, this will return a single instance of [BrowserContext](./puppeteer.browsercontext.md). - -Signature: - -```typescript -browserContexts(): BrowserContext[]; -``` -Returns: - -[BrowserContext](./puppeteer.browsercontext.md)\[\] - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.browser.close.md b/website/versioned_docs/version-10.0.0/puppeteer.browser.close.md deleted file mode 100644 index 72549271..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.browser.close.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [Browser](./puppeteer.browser.md) > [close](./puppeteer.browser.close.md) - -## Browser.close() method - -Closes Chromium and all of its pages (if any were opened). The [Browser](./puppeteer.browser.md) object itself is considered to be disposed and cannot be used anymore. - -Signature: - -```typescript -close(): Promise; -``` -Returns: - -Promise<void> - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.browser.createincognitobrowsercontext.md b/website/versioned_docs/version-10.0.0/puppeteer.browser.createincognitobrowsercontext.md deleted file mode 100644 index 8bd4f9eb..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.browser.createincognitobrowsercontext.md +++ /dev/null @@ -1,33 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [Browser](./puppeteer.browser.md) > [createIncognitoBrowserContext](./puppeteer.browser.createincognitobrowsercontext.md) - -## Browser.createIncognitoBrowserContext() method - -Creates a new incognito browser context. This won't share cookies/cache with other browser contexts. - -Signature: - -```typescript -createIncognitoBrowserContext(): Promise; -``` -Returns: - -Promise<[BrowserContext](./puppeteer.browsercontext.md)> - -## Example - - -```js -(async () => { - const browser = await puppeteer.launch(); - // Create a new incognito browser context. - const context = await browser.createIncognitoBrowserContext(); - // Create a new page in a pristine context. - const page = await context.newPage(); - // Do stuff - await page.goto('https://example.com'); -})(); - -``` - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.browser.defaultbrowsercontext.md b/website/versioned_docs/version-10.0.0/puppeteer.browser.defaultbrowsercontext.md deleted file mode 100644 index 92fd82c8..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.browser.defaultbrowsercontext.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [Browser](./puppeteer.browser.md) > [defaultBrowserContext](./puppeteer.browser.defaultbrowsercontext.md) - -## Browser.defaultBrowserContext() method - -Returns the default browser context. The default browser context cannot be closed. - -Signature: - -```typescript -defaultBrowserContext(): BrowserContext; -``` -Returns: - -[BrowserContext](./puppeteer.browsercontext.md) - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.browser.disconnect.md b/website/versioned_docs/version-10.0.0/puppeteer.browser.disconnect.md deleted file mode 100644 index 2b4a3f9f..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.browser.disconnect.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [Browser](./puppeteer.browser.md) > [disconnect](./puppeteer.browser.disconnect.md) - -## Browser.disconnect() method - -Disconnects Puppeteer from the browser, but leaves the Chromium process running. After calling `disconnect`, the [Browser](./puppeteer.browser.md) object is considered disposed and cannot be used anymore. - -Signature: - -```typescript -disconnect(): void; -``` -Returns: - -void - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.browser.isconnected.md b/website/versioned_docs/version-10.0.0/puppeteer.browser.isconnected.md deleted file mode 100644 index 75699899..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.browser.isconnected.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [Browser](./puppeteer.browser.md) > [isConnected](./puppeteer.browser.isconnected.md) - -## Browser.isConnected() method - -Indicates that the browser is connected. - -Signature: - -```typescript -isConnected(): boolean; -``` -Returns: - -boolean - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.browser.md b/website/versioned_docs/version-10.0.0/puppeteer.browser.md deleted file mode 100644 index 9d001d20..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.browser.md +++ /dev/null @@ -1,79 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [Browser](./puppeteer.browser.md) - -## Browser class - -A Browser is created when Puppeteer connects to a Chromium instance, either through [PuppeteerNode.launch()](./puppeteer.puppeteernode.launch.md) or [Puppeteer.connect()](./puppeteer.puppeteer.connect.md). - -Signature: - -```typescript -export declare class Browser extends EventEmitter -``` -Extends: [EventEmitter](./puppeteer.eventemitter.md) - -## Remarks - -The Browser class extends from Puppeteer's [EventEmitter](./puppeteer.eventemitter.md) class and will emit various events which are documented in the [BrowserEmittedEvents](./puppeteer.browseremittedevents.md) enum. - -The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `Browser` class. - -## Example 1 - -An example of using a [Browser](./puppeteer.browser.md) to create a [Page](./puppeteer.page.md): - -```js -const puppeteer = require('puppeteer'); - -(async () => { - const browser = await puppeteer.launch(); - const page = await browser.newPage(); - await page.goto('https://example.com'); - await browser.close(); -})(); - -``` - -## Example 2 - -An example of disconnecting from and reconnecting to a [Browser](./puppeteer.browser.md): - -```js -const puppeteer = require('puppeteer'); - -(async () => { - const browser = await puppeteer.launch(); - // Store the endpoint to be able to reconnect to Chromium - const browserWSEndpoint = browser.wsEndpoint(); - // Disconnect puppeteer from Chromium - browser.disconnect(); - - // Use the endpoint to reestablish a connection - const browser2 = await puppeteer.connect({browserWSEndpoint}); - // Close Chromium - await browser2.close(); -})(); - -``` - -## Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [browserContexts()](./puppeteer.browser.browsercontexts.md) | | Returns an array of all open browser contexts. In a newly created browser, this will return a single instance of [BrowserContext](./puppeteer.browsercontext.md). | -| [close()](./puppeteer.browser.close.md) | | Closes Chromium and all of its pages (if any were opened). The [Browser](./puppeteer.browser.md) object itself is considered to be disposed and cannot be used anymore. | -| [createIncognitoBrowserContext()](./puppeteer.browser.createincognitobrowsercontext.md) | | Creates a new incognito browser context. This won't share cookies/cache with other browser contexts. | -| [defaultBrowserContext()](./puppeteer.browser.defaultbrowsercontext.md) | | Returns the default browser context. The default browser context cannot be closed. | -| [disconnect()](./puppeteer.browser.disconnect.md) | | Disconnects Puppeteer from the browser, but leaves the Chromium process running. After calling disconnect, the [Browser](./puppeteer.browser.md) object is considered disposed and cannot be used anymore. | -| [isConnected()](./puppeteer.browser.isconnected.md) | | Indicates that the browser is connected. | -| [newPage()](./puppeteer.browser.newpage.md) | | Promise which resolves to a new [Page](./puppeteer.page.md) object. The Page is created in a default browser context. | -| [pages()](./puppeteer.browser.pages.md) | | An array of all open pages inside the Browser. | -| [process()](./puppeteer.browser.process.md) | | The spawned browser process. Returns null if the browser instance was created with [Puppeteer.connect()](./puppeteer.puppeteer.connect.md). | -| [target()](./puppeteer.browser.target.md) | | The target associated with the browser. | -| [targets()](./puppeteer.browser.targets.md) | | All active targets inside the Browser. In case of multiple browser contexts, returns an array with all the targets in all browser contexts. | -| [userAgent()](./puppeteer.browser.useragent.md) | | The browser's original user agent. Pages can override the browser user agent with [Page.setUserAgent()](./puppeteer.page.setuseragent.md). | -| [version()](./puppeteer.browser.version.md) | | A string representing the browser name and version. | -| [waitForTarget(predicate, options)](./puppeteer.browser.waitfortarget.md) | | Searches for a target in all browser contexts. | -| [wsEndpoint()](./puppeteer.browser.wsendpoint.md) | | The browser websocket endpoint which can be used as an argument to [Puppeteer.connect()](./puppeteer.puppeteer.connect.md). | - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.browser.newpage.md b/website/versioned_docs/version-10.0.0/puppeteer.browser.newpage.md deleted file mode 100644 index 7a4b47ef..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.browser.newpage.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [Browser](./puppeteer.browser.md) > [newPage](./puppeteer.browser.newpage.md) - -## Browser.newPage() method - -Promise which resolves to a new [Page](./puppeteer.page.md) object. The Page is created in a default browser context. - -Signature: - -```typescript -newPage(): Promise; -``` -Returns: - -Promise<[Page](./puppeteer.page.md)> - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.browser.pages.md b/website/versioned_docs/version-10.0.0/puppeteer.browser.pages.md deleted file mode 100644 index f16533c0..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.browser.pages.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [Browser](./puppeteer.browser.md) > [pages](./puppeteer.browser.pages.md) - -## Browser.pages() method - -An array of all open pages inside the Browser. - -Signature: - -```typescript -pages(): Promise; -``` -Returns: - -Promise<[Page](./puppeteer.page.md)\[\]> - -## Remarks - -In case of multiple browser contexts, returns an array with all the pages in all browser contexts. Non-visible pages, such as `"background_page"`, will not be listed here. You can find them using [Target.page()](./puppeteer.target.page.md). - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.browser.process.md b/website/versioned_docs/version-10.0.0/puppeteer.browser.process.md deleted file mode 100644 index 5b34ad71..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.browser.process.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [Browser](./puppeteer.browser.md) > [process](./puppeteer.browser.process.md) - -## Browser.process() method - -The spawned browser process. Returns `null` if the browser instance was created with [Puppeteer.connect()](./puppeteer.puppeteer.connect.md). - -Signature: - -```typescript -process(): ChildProcess | null; -``` -Returns: - -ChildProcess \| null - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.browser.target.md b/website/versioned_docs/version-10.0.0/puppeteer.browser.target.md deleted file mode 100644 index 0546aace..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.browser.target.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [Browser](./puppeteer.browser.md) > [target](./puppeteer.browser.target.md) - -## Browser.target() method - -The target associated with the browser. - -Signature: - -```typescript -target(): Target; -``` -Returns: - -[Target](./puppeteer.target.md) - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.browser.targets.md b/website/versioned_docs/version-10.0.0/puppeteer.browser.targets.md deleted file mode 100644 index 14eb2d4a..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.browser.targets.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [Browser](./puppeteer.browser.md) > [targets](./puppeteer.browser.targets.md) - -## Browser.targets() method - -All active targets inside the Browser. In case of multiple browser contexts, returns an array with all the targets in all browser contexts. - -Signature: - -```typescript -targets(): Target[]; -``` -Returns: - -[Target](./puppeteer.target.md)\[\] - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.browser.useragent.md b/website/versioned_docs/version-10.0.0/puppeteer.browser.useragent.md deleted file mode 100644 index ae1f1f59..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.browser.useragent.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [Browser](./puppeteer.browser.md) > [userAgent](./puppeteer.browser.useragent.md) - -## Browser.userAgent() method - -The browser's original user agent. Pages can override the browser user agent with [Page.setUserAgent()](./puppeteer.page.setuseragent.md). - -Signature: - -```typescript -userAgent(): Promise; -``` -Returns: - -Promise<string> - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.browser.version.md b/website/versioned_docs/version-10.0.0/puppeteer.browser.version.md deleted file mode 100644 index 8e2f3e5b..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.browser.version.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [Browser](./puppeteer.browser.md) > [version](./puppeteer.browser.version.md) - -## Browser.version() method - -A string representing the browser name and version. - -Signature: - -```typescript -version(): Promise; -``` -Returns: - -Promise<string> - -## Remarks - -For headless Chromium, this is similar to `HeadlessChrome/61.0.3153.0`. For non-headless, this is similar to `Chrome/61.0.3153.0`. - -The format of browser.version() might change with future releases of Chromium. - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.browser.waitfortarget.md b/website/versioned_docs/version-10.0.0/puppeteer.browser.waitfortarget.md deleted file mode 100644 index a607dcbc..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.browser.waitfortarget.md +++ /dev/null @@ -1,37 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [Browser](./puppeteer.browser.md) > [waitForTarget](./puppeteer.browser.waitfortarget.md) - -## Browser.waitForTarget() method - -Searches for a target in all browser contexts. - -Signature: - -```typescript -waitForTarget(predicate: (x: Target) => boolean, options?: WaitForTargetOptions): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| predicate | (x: [Target](./puppeteer.target.md)) => boolean | A function to be run for every target. | -| options | [WaitForTargetOptions](./puppeteer.waitfortargetoptions.md) | | - -Returns: - -Promise<[Target](./puppeteer.target.md)> - -The first target found that matches the `predicate` function. - -## Example - -An example of finding a target for a page opened via `window.open`: - -```js -await page.evaluate(() => window.open('https://www.example.com/')); -const newWindowTarget = await browser.waitForTarget(target => target.url() === 'https://www.example.com/'); - -``` - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.browser.wsendpoint.md b/website/versioned_docs/version-10.0.0/puppeteer.browser.wsendpoint.md deleted file mode 100644 index 751cad5c..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.browser.wsendpoint.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [Browser](./puppeteer.browser.md) > [wsEndpoint](./puppeteer.browser.wsendpoint.md) - -## Browser.wsEndpoint() method - -The browser websocket endpoint which can be used as an argument to [Puppeteer.connect()](./puppeteer.puppeteer.connect.md). - -Signature: - -```typescript -wsEndpoint(): string; -``` -Returns: - -string - -The Browser websocket url. - -## Remarks - -The format is `ws://${host}:${port}/devtools/browser/`. - -You can find the `webSocketDebuggerUrl` from `http://${host}:${port}/json/version`. Learn more about the [devtools protocol](https://chromedevtools.github.io/devtools-protocol) and the [browser endpoint](https://chromedevtools.github.io/devtools-protocol/#how-do-i-access-the-browser-target). - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.browserconnectoptions.defaultviewport.md b/website/versioned_docs/version-10.0.0/puppeteer.browserconnectoptions.defaultviewport.md deleted file mode 100644 index d610fd65..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.browserconnectoptions.defaultviewport.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserConnectOptions](./puppeteer.browserconnectoptions.md) > [defaultViewport](./puppeteer.browserconnectoptions.defaultviewport.md) - -## BrowserConnectOptions.defaultViewport property - -Sets the viewport for each page. - -Signature: - -```typescript -defaultViewport?: Viewport | null; -``` diff --git a/website/versioned_docs/version-10.0.0/puppeteer.browserconnectoptions.ignorehttpserrors.md b/website/versioned_docs/version-10.0.0/puppeteer.browserconnectoptions.ignorehttpserrors.md deleted file mode 100644 index 627cbe2c..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.browserconnectoptions.ignorehttpserrors.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserConnectOptions](./puppeteer.browserconnectoptions.md) > [ignoreHTTPSErrors](./puppeteer.browserconnectoptions.ignorehttpserrors.md) - -## BrowserConnectOptions.ignoreHTTPSErrors property - -Whether to ignore HTTPS errors during navigation. - -Signature: - -```typescript -ignoreHTTPSErrors?: boolean; -``` diff --git a/website/versioned_docs/version-10.0.0/puppeteer.browserconnectoptions.md b/website/versioned_docs/version-10.0.0/puppeteer.browserconnectoptions.md deleted file mode 100644 index c473f69d..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.browserconnectoptions.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserConnectOptions](./puppeteer.browserconnectoptions.md) - -## BrowserConnectOptions interface - -Generic browser options that can be passed when launching any browser or when connecting to an existing browser instance. - -Signature: - -```typescript -export interface BrowserConnectOptions -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [defaultViewport?](./puppeteer.browserconnectoptions.defaultviewport.md) | [Viewport](./puppeteer.viewport.md) \| null | (Optional) Sets the viewport for each page. | -| [ignoreHTTPSErrors?](./puppeteer.browserconnectoptions.ignorehttpserrors.md) | boolean | (Optional) Whether to ignore HTTPS errors during navigation. | -| [slowMo?](./puppeteer.browserconnectoptions.slowmo.md) | number | (Optional) Slows down Puppeteer operations by the specified amount of milliseconds to aid debugging. | -| [targetFilter?](./puppeteer.browserconnectoptions.targetfilter.md) | [TargetFilterCallback](./puppeteer.targetfiltercallback.md) | (Optional) Callback to decide if Puppeteer should connect to a given target or not. | - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.browserconnectoptions.slowmo.md b/website/versioned_docs/version-10.0.0/puppeteer.browserconnectoptions.slowmo.md deleted file mode 100644 index f0eacae0..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.browserconnectoptions.slowmo.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserConnectOptions](./puppeteer.browserconnectoptions.md) > [slowMo](./puppeteer.browserconnectoptions.slowmo.md) - -## BrowserConnectOptions.slowMo property - -Slows down Puppeteer operations by the specified amount of milliseconds to aid debugging. - -Signature: - -```typescript -slowMo?: number; -``` diff --git a/website/versioned_docs/version-10.0.0/puppeteer.browserconnectoptions.targetfilter.md b/website/versioned_docs/version-10.0.0/puppeteer.browserconnectoptions.targetfilter.md deleted file mode 100644 index 6c58b075..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.browserconnectoptions.targetfilter.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserConnectOptions](./puppeteer.browserconnectoptions.md) > [targetFilter](./puppeteer.browserconnectoptions.targetfilter.md) - -## BrowserConnectOptions.targetFilter property - -Callback to decide if Puppeteer should connect to a given target or not. - -Signature: - -```typescript -targetFilter?: TargetFilterCallback; -``` diff --git a/website/versioned_docs/version-10.0.0/puppeteer.browsercontext.browser.md b/website/versioned_docs/version-10.0.0/puppeteer.browsercontext.browser.md deleted file mode 100644 index 85dadca1..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.browsercontext.browser.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserContext](./puppeteer.browsercontext.md) > [browser](./puppeteer.browsercontext.browser.md) - -## BrowserContext.browser() method - -The browser this browser context belongs to. - -Signature: - -```typescript -browser(): Browser; -``` -Returns: - -[Browser](./puppeteer.browser.md) - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.browsercontext.clearpermissionoverrides.md b/website/versioned_docs/version-10.0.0/puppeteer.browsercontext.clearpermissionoverrides.md deleted file mode 100644 index 85872769..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.browsercontext.clearpermissionoverrides.md +++ /dev/null @@ -1,28 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserContext](./puppeteer.browsercontext.md) > [clearPermissionOverrides](./puppeteer.browsercontext.clearpermissionoverrides.md) - -## BrowserContext.clearPermissionOverrides() method - -Clears all permission overrides for the browser context. - -Signature: - -```typescript -clearPermissionOverrides(): Promise; -``` -Returns: - -Promise<void> - -## Example - - -```js -const context = browser.defaultBrowserContext(); -context.overridePermissions('https://example.com', ['clipboard-read']); -// do stuff .. -context.clearPermissionOverrides(); - -``` - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.browsercontext.close.md b/website/versioned_docs/version-10.0.0/puppeteer.browsercontext.close.md deleted file mode 100644 index 7b6a9c75..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.browsercontext.close.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserContext](./puppeteer.browsercontext.md) > [close](./puppeteer.browsercontext.close.md) - -## BrowserContext.close() method - -Closes the browser context. All the targets that belong to the browser context will be closed. - -Signature: - -```typescript -close(): Promise; -``` -Returns: - -Promise<void> - -## Remarks - -Only incognito browser contexts can be closed. - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.browsercontext.isincognito.md b/website/versioned_docs/version-10.0.0/puppeteer.browsercontext.isincognito.md deleted file mode 100644 index 412665d0..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.browsercontext.isincognito.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserContext](./puppeteer.browsercontext.md) > [isIncognito](./puppeteer.browsercontext.isincognito.md) - -## BrowserContext.isIncognito() method - -Returns whether BrowserContext is incognito. The default browser context is the only non-incognito browser context. - -Signature: - -```typescript -isIncognito(): boolean; -``` -Returns: - -boolean - -## Remarks - -The default browser context cannot be closed. - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.browsercontext.md b/website/versioned_docs/version-10.0.0/puppeteer.browsercontext.md deleted file mode 100644 index 3379d33d..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.browsercontext.md +++ /dev/null @@ -1,54 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserContext](./puppeteer.browsercontext.md) - -## BrowserContext class - -BrowserContexts provide a way to operate multiple independent browser sessions. When a browser is launched, it has a single BrowserContext used by default. The method [Browser.newPage](./puppeteer.browser.newpage.md) creates a page in the default browser context. - -Signature: - -```typescript -export declare class BrowserContext extends EventEmitter -``` -Extends: [EventEmitter](./puppeteer.eventemitter.md) - -## Remarks - -The Browser class extends from Puppeteer's [EventEmitter](./puppeteer.eventemitter.md) class and will emit various events which are documented in the [BrowserContextEmittedEvents](./puppeteer.browsercontextemittedevents.md) enum. - -If a page opens another page, e.g. with a `window.open` call, the popup will belong to the parent page's browser context. - -Puppeteer allows creation of "incognito" browser contexts with [Browser.createIncognitoBrowserContext](./puppeteer.browser.createincognitobrowsercontext.md) method. "Incognito" browser contexts don't write any browsing data to disk. - -The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `BrowserContext` class. - -## Example - - -```js -// Create a new incognito browser context -const context = await browser.createIncognitoBrowserContext(); -// Create a new page inside context. -const page = await context.newPage(); -// ... do stuff with page ... -await page.goto('https://example.com'); -// Dispose context once it's no longer needed. -await context.close(); - -``` - -## Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [browser()](./puppeteer.browsercontext.browser.md) | | The browser this browser context belongs to. | -| [clearPermissionOverrides()](./puppeteer.browsercontext.clearpermissionoverrides.md) | | Clears all permission overrides for the browser context. | -| [close()](./puppeteer.browsercontext.close.md) | | Closes the browser context. All the targets that belong to the browser context will be closed. | -| [isIncognito()](./puppeteer.browsercontext.isincognito.md) | | Returns whether BrowserContext is incognito. The default browser context is the only non-incognito browser context. | -| [newPage()](./puppeteer.browsercontext.newpage.md) | | Creates a new page in the browser context. | -| [overridePermissions(origin, permissions)](./puppeteer.browsercontext.overridepermissions.md) | | | -| [pages()](./puppeteer.browsercontext.pages.md) | | An array of all pages inside the browser context. | -| [targets()](./puppeteer.browsercontext.targets.md) | | An array of all active targets inside the browser context. | -| [waitForTarget(predicate, options)](./puppeteer.browsercontext.waitfortarget.md) | | This searches for a target in this specific browser context. | - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.browsercontext.newpage.md b/website/versioned_docs/version-10.0.0/puppeteer.browsercontext.newpage.md deleted file mode 100644 index 440e0e01..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.browsercontext.newpage.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserContext](./puppeteer.browsercontext.md) > [newPage](./puppeteer.browsercontext.newpage.md) - -## BrowserContext.newPage() method - -Creates a new page in the browser context. - -Signature: - -```typescript -newPage(): Promise; -``` -Returns: - -Promise<[Page](./puppeteer.page.md)> - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.browsercontext.overridepermissions.md b/website/versioned_docs/version-10.0.0/puppeteer.browsercontext.overridepermissions.md deleted file mode 100644 index a79725be..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.browsercontext.overridepermissions.md +++ /dev/null @@ -1,32 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserContext](./puppeteer.browsercontext.md) > [overridePermissions](./puppeteer.browsercontext.overridepermissions.md) - -## BrowserContext.overridePermissions() method - -Signature: - -```typescript -overridePermissions(origin: string, permissions: Permission[]): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| origin | string | The origin to grant permissions to, e.g. "https://example.com". | -| permissions | [Permission](./puppeteer.permission.md)\[\] | An array of permissions to grant. All permissions that are not listed here will be automatically denied. | - -Returns: - -Promise<void> - -## Example - - -```js -const context = browser.defaultBrowserContext(); -await context.overridePermissions('https://html5demos.com', ['geolocation']); - -``` - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.browsercontext.pages.md b/website/versioned_docs/version-10.0.0/puppeteer.browsercontext.pages.md deleted file mode 100644 index b56ec861..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.browsercontext.pages.md +++ /dev/null @@ -1,19 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserContext](./puppeteer.browsercontext.md) > [pages](./puppeteer.browsercontext.pages.md) - -## BrowserContext.pages() method - -An array of all pages inside the browser context. - -Signature: - -```typescript -pages(): Promise; -``` -Returns: - -Promise<[Page](./puppeteer.page.md)\[\]> - -Promise which resolves to an array of all open pages. Non visible pages, such as `"background_page"`, will not be listed here. You can find them using [the target page](./puppeteer.target.page.md). - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.browsercontext.targets.md b/website/versioned_docs/version-10.0.0/puppeteer.browsercontext.targets.md deleted file mode 100644 index b3bb64d8..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.browsercontext.targets.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserContext](./puppeteer.browsercontext.md) > [targets](./puppeteer.browsercontext.targets.md) - -## BrowserContext.targets() method - -An array of all active targets inside the browser context. - -Signature: - -```typescript -targets(): Target[]; -``` -Returns: - -[Target](./puppeteer.target.md)\[\] - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.browsercontext.waitfortarget.md b/website/versioned_docs/version-10.0.0/puppeteer.browsercontext.waitfortarget.md deleted file mode 100644 index 46f3fee4..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.browsercontext.waitfortarget.md +++ /dev/null @@ -1,39 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserContext](./puppeteer.browsercontext.md) > [waitForTarget](./puppeteer.browsercontext.waitfortarget.md) - -## BrowserContext.waitForTarget() method - -This searches for a target in this specific browser context. - -Signature: - -```typescript -waitForTarget(predicate: (x: Target) => boolean, options?: { - timeout?: number; - }): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| predicate | (x: [Target](./puppeteer.target.md)) => boolean | A function to be run for every target | -| options | { timeout?: number; } | An object of options. Accepts a timout, which is the maximum wait time in milliseconds. Pass 0 to disable the timeout. Defaults to 30 seconds. | - -Returns: - -Promise<[Target](./puppeteer.target.md)> - -Promise which resolves to the first target found that matches the `predicate` function. - -## Example - -An example of finding a target for a page opened via `window.open`: - -```js -await page.evaluate(() => window.open('https://www.example.com/')); -const newWindowTarget = await browserContext.waitForTarget(target => target.url() === 'https://www.example.com/'); - -``` - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.browsercontextemittedevents.md b/website/versioned_docs/version-10.0.0/puppeteer.browsercontextemittedevents.md deleted file mode 100644 index 2302875d..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.browsercontextemittedevents.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserContextEmittedEvents](./puppeteer.browsercontextemittedevents.md) - -## BrowserContextEmittedEvents enum - - -Signature: - -```typescript -export declare const enum BrowserContextEmittedEvents -``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| TargetChanged | "targetchanged" | Emitted when the url of a target inside the browser context changes. Contains a [Target](./puppeteer.target.md) instance. | -| TargetCreated | "targetcreated" | Emitted when a target is created within the browser context, for example when a new page is opened by [window.open](https://developer.mozilla.org/en-US/docs/Web/API/Window/open) or by [browserContext.newPage](./puppeteer.browsercontext.newpage.md)Contains a [Target](./puppeteer.target.md) instance. | -| TargetDestroyed | "targetdestroyed" | Emitted when a target is destroyed within the browser context, for example when a page is closed. Contains a [Target](./puppeteer.target.md) instance. | - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.browseremittedevents.md b/website/versioned_docs/version-10.0.0/puppeteer.browseremittedevents.md deleted file mode 100644 index 779d0ba7..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.browseremittedevents.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserEmittedEvents](./puppeteer.browseremittedevents.md) - -## BrowserEmittedEvents enum - -All the events a [browser instance](./puppeteer.browser.md) may emit. - -Signature: - -```typescript -export declare const enum BrowserEmittedEvents -``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| Disconnected | "disconnected" | Emitted when Puppeteer gets disconnected from the Chromium instance. This might happen because of one of the following:- Chromium is closed or crashed- The [browser.disconnect](./puppeteer.browser.disconnect.md) method was called. | -| TargetChanged | "targetchanged" | Emitted when the url of a target changes. Contains a [Target](./puppeteer.target.md) instance. | -| TargetCreated | "targetcreated" | Emitted when a target is created, for example when a new page is opened by [window.open](https://developer.mozilla.org/en-US/docs/Web/API/Window/open) or by [browser.newPage](./puppeteer.browser.newpage.md)Contains a [Target](./puppeteer.target.md) instance. | -| TargetDestroyed | "targetdestroyed" | Emitted when a target is destroyed, for example when a page is closed. Contains a [Target](./puppeteer.target.md) instance. | - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.browserfetcher.candownload.md b/website/versioned_docs/version-10.0.0/puppeteer.browserfetcher.candownload.md deleted file mode 100644 index 11da9ded..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.browserfetcher.candownload.md +++ /dev/null @@ -1,30 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserFetcher](./puppeteer.browserfetcher.md) > [canDownload](./puppeteer.browserfetcher.candownload.md) - -## BrowserFetcher.canDownload() method - -Initiates a HEAD request to check if the revision is available. - -Signature: - -```typescript -canDownload(revision: string): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| revision | string | The revision to check availability for. | - -Returns: - -Promise<boolean> - -A promise that resolves to `true` if the revision could be downloaded from the host. - -## Remarks - -This method is affected by the current `product`. - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.browserfetcher.download.md b/website/versioned_docs/version-10.0.0/puppeteer.browserfetcher.download.md deleted file mode 100644 index d026a7cf..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.browserfetcher.download.md +++ /dev/null @@ -1,31 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserFetcher](./puppeteer.browserfetcher.md) > [download](./puppeteer.browserfetcher.download.md) - -## BrowserFetcher.download() method - -Initiates a GET request to download the revision from the host. - -Signature: - -```typescript -download(revision: string, progressCallback?: (x: number, y: number) => void): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| revision | string | The revision to download. | -| progressCallback | (x: number, y: number) => void | A function that will be called with two arguments: How many bytes have been downloaded and the total number of bytes of the download. | - -Returns: - -Promise<[BrowserFetcherRevisionInfo](./puppeteer.browserfetcherrevisioninfo.md)> - -A promise with revision information when the revision is downloaded and extracted. - -## Remarks - -This method is affected by the current `product`. - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.browserfetcher.host.md b/website/versioned_docs/version-10.0.0/puppeteer.browserfetcher.host.md deleted file mode 100644 index 863932bf..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.browserfetcher.host.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserFetcher](./puppeteer.browserfetcher.md) > [host](./puppeteer.browserfetcher.host.md) - -## BrowserFetcher.host() method - -Signature: - -```typescript -host(): string; -``` -Returns: - -string - -The download host being used. - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.browserfetcher.localrevisions.md b/website/versioned_docs/version-10.0.0/puppeteer.browserfetcher.localrevisions.md deleted file mode 100644 index e0a9bb93..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.browserfetcher.localrevisions.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserFetcher](./puppeteer.browserfetcher.md) > [localRevisions](./puppeteer.browserfetcher.localrevisions.md) - -## BrowserFetcher.localRevisions() method - -Signature: - -```typescript -localRevisions(): Promise; -``` -Returns: - -Promise<string\[\]> - -A promise with a list of all revision strings (for the current `product`) available locally on disk. - -## Remarks - -This method is affected by the current `product`. - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.browserfetcher.md b/website/versioned_docs/version-10.0.0/puppeteer.browserfetcher.md deleted file mode 100644 index 0b674fc1..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.browserfetcher.md +++ /dev/null @@ -1,45 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserFetcher](./puppeteer.browserfetcher.md) - -## BrowserFetcher class - -BrowserFetcher can download and manage different versions of Chromium and Firefox. - -Signature: - -```typescript -export declare class BrowserFetcher -``` - -## Remarks - -BrowserFetcher operates on revision strings that specify a precise version of Chromium, e.g. `"533271"`. Revision strings can be obtained from [omahaproxy.appspot.com](http://omahaproxy.appspot.com/). In the Firefox case, BrowserFetcher downloads Firefox Nightly and operates on version numbers such as `"75"`. - -The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `BrowserFetcher` class. - -## Example - -An example of using BrowserFetcher to download a specific version of Chromium and running Puppeteer against it: - -```js -const browserFetcher = puppeteer.createBrowserFetcher(); -const revisionInfo = await browserFetcher.download('533271'); -const browser = await puppeteer.launch({executablePath: revisionInfo.executablePath}) - -``` -\*\*NOTE\*\* BrowserFetcher is not designed to work concurrently with other instances of BrowserFetcher that share the same downloads directory. - -## Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [canDownload(revision)](./puppeteer.browserfetcher.candownload.md) | | Initiates a HEAD request to check if the revision is available. | -| [download(revision, progressCallback)](./puppeteer.browserfetcher.download.md) | | Initiates a GET request to download the revision from the host. | -| [host()](./puppeteer.browserfetcher.host.md) | | | -| [localRevisions()](./puppeteer.browserfetcher.localrevisions.md) | | | -| [platform()](./puppeteer.browserfetcher.platform.md) | | | -| [product()](./puppeteer.browserfetcher.product.md) | | | -| [remove(revision)](./puppeteer.browserfetcher.remove.md) | | | -| [revisionInfo(revision)](./puppeteer.browserfetcher.revisioninfo.md) | | | - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.browserfetcher.platform.md b/website/versioned_docs/version-10.0.0/puppeteer.browserfetcher.platform.md deleted file mode 100644 index c0230092..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.browserfetcher.platform.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserFetcher](./puppeteer.browserfetcher.md) > [platform](./puppeteer.browserfetcher.platform.md) - -## BrowserFetcher.platform() method - -Signature: - -```typescript -platform(): Platform; -``` -Returns: - -[Platform](./puppeteer.platform.md) - -Returns the current `Platform`, which is one of `mac`, `linux`, `win32` or `win64`. - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.browserfetcher.product.md b/website/versioned_docs/version-10.0.0/puppeteer.browserfetcher.product.md deleted file mode 100644 index 42fe893f..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.browserfetcher.product.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserFetcher](./puppeteer.browserfetcher.md) > [product](./puppeteer.browserfetcher.product.md) - -## BrowserFetcher.product() method - -Signature: - -```typescript -product(): Product; -``` -Returns: - -[Product](./puppeteer.product.md) - -Returns the current `Product`, which is one of `chrome` or `firefox`. - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.browserfetcher.remove.md b/website/versioned_docs/version-10.0.0/puppeteer.browserfetcher.remove.md deleted file mode 100644 index 9577aada..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.browserfetcher.remove.md +++ /dev/null @@ -1,28 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserFetcher](./puppeteer.browserfetcher.md) > [remove](./puppeteer.browserfetcher.remove.md) - -## BrowserFetcher.remove() method - -Signature: - -```typescript -remove(revision: string): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| revision | string | A revision to remove for the current product. | - -Returns: - -Promise<void> - -A promise that resolves when the revision has been removes or throws if the revision has not been downloaded. - -## Remarks - -This method is affected by the current `product`. - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.browserfetcher.revisioninfo.md b/website/versioned_docs/version-10.0.0/puppeteer.browserfetcher.revisioninfo.md deleted file mode 100644 index 6b1636b8..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.browserfetcher.revisioninfo.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserFetcher](./puppeteer.browserfetcher.md) > [revisionInfo](./puppeteer.browserfetcher.revisioninfo.md) - -## BrowserFetcher.revisionInfo() method - -Signature: - -```typescript -revisionInfo(revision: string): BrowserFetcherRevisionInfo; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| revision | string | The revision to get info for. | - -Returns: - -[BrowserFetcherRevisionInfo](./puppeteer.browserfetcherrevisioninfo.md) - -The revision info for the given revision. - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.browserfetcheroptions.host.md b/website/versioned_docs/version-10.0.0/puppeteer.browserfetcheroptions.host.md deleted file mode 100644 index c30723c1..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.browserfetcheroptions.host.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserFetcherOptions](./puppeteer.browserfetcheroptions.md) > [host](./puppeteer.browserfetcheroptions.host.md) - -## BrowserFetcherOptions.host property - -Signature: - -```typescript -host?: string; -``` diff --git a/website/versioned_docs/version-10.0.0/puppeteer.browserfetcheroptions.md b/website/versioned_docs/version-10.0.0/puppeteer.browserfetcheroptions.md deleted file mode 100644 index 16d69d64..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.browserfetcheroptions.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserFetcherOptions](./puppeteer.browserfetcheroptions.md) - -## BrowserFetcherOptions interface - - -Signature: - -```typescript -export interface BrowserFetcherOptions -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [host?](./puppeteer.browserfetcheroptions.host.md) | string | (Optional) | -| [path?](./puppeteer.browserfetcheroptions.path.md) | string | (Optional) | -| [platform?](./puppeteer.browserfetcheroptions.platform.md) | [Platform](./puppeteer.platform.md) | (Optional) | -| [product?](./puppeteer.browserfetcheroptions.product.md) | string | (Optional) | - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.browserfetcheroptions.path.md b/website/versioned_docs/version-10.0.0/puppeteer.browserfetcheroptions.path.md deleted file mode 100644 index e6a4bcdb..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.browserfetcheroptions.path.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserFetcherOptions](./puppeteer.browserfetcheroptions.md) > [path](./puppeteer.browserfetcheroptions.path.md) - -## BrowserFetcherOptions.path property - -Signature: - -```typescript -path?: string; -``` diff --git a/website/versioned_docs/version-10.0.0/puppeteer.browserfetcheroptions.platform.md b/website/versioned_docs/version-10.0.0/puppeteer.browserfetcheroptions.platform.md deleted file mode 100644 index b37d0ead..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.browserfetcheroptions.platform.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserFetcherOptions](./puppeteer.browserfetcheroptions.md) > [platform](./puppeteer.browserfetcheroptions.platform.md) - -## BrowserFetcherOptions.platform property - -Signature: - -```typescript -platform?: Platform; -``` diff --git a/website/versioned_docs/version-10.0.0/puppeteer.browserfetcheroptions.product.md b/website/versioned_docs/version-10.0.0/puppeteer.browserfetcheroptions.product.md deleted file mode 100644 index c5caa876..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.browserfetcheroptions.product.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserFetcherOptions](./puppeteer.browserfetcheroptions.md) > [product](./puppeteer.browserfetcheroptions.product.md) - -## BrowserFetcherOptions.product property - -Signature: - -```typescript -product?: string; -``` diff --git a/website/versioned_docs/version-10.0.0/puppeteer.browserfetcherrevisioninfo.executablepath.md b/website/versioned_docs/version-10.0.0/puppeteer.browserfetcherrevisioninfo.executablepath.md deleted file mode 100644 index 22e8fbfb..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.browserfetcherrevisioninfo.executablepath.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserFetcherRevisionInfo](./puppeteer.browserfetcherrevisioninfo.md) > [executablePath](./puppeteer.browserfetcherrevisioninfo.executablepath.md) - -## BrowserFetcherRevisionInfo.executablePath property - -Signature: - -```typescript -executablePath: string; -``` diff --git a/website/versioned_docs/version-10.0.0/puppeteer.browserfetcherrevisioninfo.folderpath.md b/website/versioned_docs/version-10.0.0/puppeteer.browserfetcherrevisioninfo.folderpath.md deleted file mode 100644 index bc31e043..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.browserfetcherrevisioninfo.folderpath.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserFetcherRevisionInfo](./puppeteer.browserfetcherrevisioninfo.md) > [folderPath](./puppeteer.browserfetcherrevisioninfo.folderpath.md) - -## BrowserFetcherRevisionInfo.folderPath property - -Signature: - -```typescript -folderPath: string; -``` diff --git a/website/versioned_docs/version-10.0.0/puppeteer.browserfetcherrevisioninfo.local.md b/website/versioned_docs/version-10.0.0/puppeteer.browserfetcherrevisioninfo.local.md deleted file mode 100644 index f35fc717..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.browserfetcherrevisioninfo.local.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserFetcherRevisionInfo](./puppeteer.browserfetcherrevisioninfo.md) > [local](./puppeteer.browserfetcherrevisioninfo.local.md) - -## BrowserFetcherRevisionInfo.local property - -Signature: - -```typescript -local: boolean; -``` diff --git a/website/versioned_docs/version-10.0.0/puppeteer.browserfetcherrevisioninfo.md b/website/versioned_docs/version-10.0.0/puppeteer.browserfetcherrevisioninfo.md deleted file mode 100644 index e7dabf4d..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.browserfetcherrevisioninfo.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserFetcherRevisionInfo](./puppeteer.browserfetcherrevisioninfo.md) - -## BrowserFetcherRevisionInfo interface - - -Signature: - -```typescript -export interface BrowserFetcherRevisionInfo -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [executablePath](./puppeteer.browserfetcherrevisioninfo.executablepath.md) | string | | -| [folderPath](./puppeteer.browserfetcherrevisioninfo.folderpath.md) | string | | -| [local](./puppeteer.browserfetcherrevisioninfo.local.md) | boolean | | -| [product](./puppeteer.browserfetcherrevisioninfo.product.md) | string | | -| [revision](./puppeteer.browserfetcherrevisioninfo.revision.md) | string | | -| [url](./puppeteer.browserfetcherrevisioninfo.url.md) | string | | - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.browserfetcherrevisioninfo.product.md b/website/versioned_docs/version-10.0.0/puppeteer.browserfetcherrevisioninfo.product.md deleted file mode 100644 index 99bdca57..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.browserfetcherrevisioninfo.product.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserFetcherRevisionInfo](./puppeteer.browserfetcherrevisioninfo.md) > [product](./puppeteer.browserfetcherrevisioninfo.product.md) - -## BrowserFetcherRevisionInfo.product property - -Signature: - -```typescript -product: string; -``` diff --git a/website/versioned_docs/version-10.0.0/puppeteer.browserfetcherrevisioninfo.revision.md b/website/versioned_docs/version-10.0.0/puppeteer.browserfetcherrevisioninfo.revision.md deleted file mode 100644 index e084a332..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.browserfetcherrevisioninfo.revision.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserFetcherRevisionInfo](./puppeteer.browserfetcherrevisioninfo.md) > [revision](./puppeteer.browserfetcherrevisioninfo.revision.md) - -## BrowserFetcherRevisionInfo.revision property - -Signature: - -```typescript -revision: string; -``` diff --git a/website/versioned_docs/version-10.0.0/puppeteer.browserfetcherrevisioninfo.url.md b/website/versioned_docs/version-10.0.0/puppeteer.browserfetcherrevisioninfo.url.md deleted file mode 100644 index eee943e9..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.browserfetcherrevisioninfo.url.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserFetcherRevisionInfo](./puppeteer.browserfetcherrevisioninfo.md) > [url](./puppeteer.browserfetcherrevisioninfo.url.md) - -## BrowserFetcherRevisionInfo.url property - -Signature: - -```typescript -url: string; -``` diff --git a/website/versioned_docs/version-10.0.0/puppeteer.browserlaunchargumentoptions.args.md b/website/versioned_docs/version-10.0.0/puppeteer.browserlaunchargumentoptions.args.md deleted file mode 100644 index 7fcc8893..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.browserlaunchargumentoptions.args.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserLaunchArgumentOptions](./puppeteer.browserlaunchargumentoptions.md) > [args](./puppeteer.browserlaunchargumentoptions.args.md) - -## BrowserLaunchArgumentOptions.args property - -Additional command line arguments to pass to the browser instance. - -Signature: - -```typescript -args?: string[]; -``` diff --git a/website/versioned_docs/version-10.0.0/puppeteer.browserlaunchargumentoptions.devtools.md b/website/versioned_docs/version-10.0.0/puppeteer.browserlaunchargumentoptions.devtools.md deleted file mode 100644 index 0bc2fbf8..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.browserlaunchargumentoptions.devtools.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserLaunchArgumentOptions](./puppeteer.browserlaunchargumentoptions.md) > [devtools](./puppeteer.browserlaunchargumentoptions.devtools.md) - -## BrowserLaunchArgumentOptions.devtools property - -Whether to auto-open a DevTools panel for each tab. If this is set to `true`, then `headless` will be set to `false` automatically. - -Signature: - -```typescript -devtools?: boolean; -``` diff --git a/website/versioned_docs/version-10.0.0/puppeteer.browserlaunchargumentoptions.headless.md b/website/versioned_docs/version-10.0.0/puppeteer.browserlaunchargumentoptions.headless.md deleted file mode 100644 index cc881e3c..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.browserlaunchargumentoptions.headless.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserLaunchArgumentOptions](./puppeteer.browserlaunchargumentoptions.md) > [headless](./puppeteer.browserlaunchargumentoptions.headless.md) - -## BrowserLaunchArgumentOptions.headless property - -Whether to run the browser in headless mode. - -Signature: - -```typescript -headless?: boolean; -``` diff --git a/website/versioned_docs/version-10.0.0/puppeteer.browserlaunchargumentoptions.md b/website/versioned_docs/version-10.0.0/puppeteer.browserlaunchargumentoptions.md deleted file mode 100644 index ec48b01c..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.browserlaunchargumentoptions.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserLaunchArgumentOptions](./puppeteer.browserlaunchargumentoptions.md) - -## BrowserLaunchArgumentOptions interface - -Launcher options that only apply to Chrome. - -Signature: - -```typescript -export interface BrowserLaunchArgumentOptions -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [args?](./puppeteer.browserlaunchargumentoptions.args.md) | string\[\] | (Optional) Additional command line arguments to pass to the browser instance. | -| [devtools?](./puppeteer.browserlaunchargumentoptions.devtools.md) | boolean | (Optional) Whether to auto-open a DevTools panel for each tab. If this is set to true, then headless will be set to false automatically. | -| [headless?](./puppeteer.browserlaunchargumentoptions.headless.md) | boolean | (Optional) Whether to run the browser in headless mode. | -| [userDataDir?](./puppeteer.browserlaunchargumentoptions.userdatadir.md) | string | (Optional) Path to a user data directory. [see the Chromium docs](https://chromium.googlesource.com/chromium/src/+/master/docs/user_data_dir.md) for more info. | - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.browserlaunchargumentoptions.userdatadir.md b/website/versioned_docs/version-10.0.0/puppeteer.browserlaunchargumentoptions.userdatadir.md deleted file mode 100644 index 03badd8a..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.browserlaunchargumentoptions.userdatadir.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserLaunchArgumentOptions](./puppeteer.browserlaunchargumentoptions.md) > [userDataDir](./puppeteer.browserlaunchargumentoptions.userdatadir.md) - -## BrowserLaunchArgumentOptions.userDataDir property - -Path to a user data directory. [see the Chromium docs](https://chromium.googlesource.com/chromium/src/+/master/docs/user_data_dir.md) for more info. - -Signature: - -```typescript -userDataDir?: string; -``` diff --git a/website/versioned_docs/version-10.0.0/puppeteer.cdpsession.connection.md b/website/versioned_docs/version-10.0.0/puppeteer.cdpsession.connection.md deleted file mode 100644 index e4ca7499..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.cdpsession.connection.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [CDPSession](./puppeteer.cdpsession.md) > [connection](./puppeteer.cdpsession.connection.md) - -## CDPSession.connection() method - -Signature: - -```typescript -connection(): Connection; -``` -Returns: - -[Connection](./puppeteer.connection.md) - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.cdpsession.detach.md b/website/versioned_docs/version-10.0.0/puppeteer.cdpsession.detach.md deleted file mode 100644 index b90f2c62..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.cdpsession.detach.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [CDPSession](./puppeteer.cdpsession.md) > [detach](./puppeteer.cdpsession.detach.md) - -## CDPSession.detach() method - -Detaches the cdpSession from the target. Once detached, the cdpSession object won't emit any events and can't be used to send messages. - -Signature: - -```typescript -detach(): Promise; -``` -Returns: - -Promise<void> - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.cdpsession.md b/website/versioned_docs/version-10.0.0/puppeteer.cdpsession.md deleted file mode 100644 index 4bac2335..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.cdpsession.md +++ /dev/null @@ -1,46 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [CDPSession](./puppeteer.cdpsession.md) - -## CDPSession class - -The `CDPSession` instances are used to talk raw Chrome Devtools Protocol. - -Signature: - -```typescript -export declare class CDPSession extends EventEmitter -``` -Extends: [EventEmitter](./puppeteer.eventemitter.md) - -## Remarks - -Protocol methods can be called with [CDPSession.send()](./puppeteer.cdpsession.send.md) method and protocol events can be subscribed to with `CDPSession.on` method. - -Useful links: [DevTools Protocol Viewer](https://chromedevtools.github.io/devtools-protocol/) and [Getting Started with DevTools Protocol](https://github.com/aslushnikov/getting-started-with-cdp/blob/master/README.md). - -The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `CDPSession` class. - -## Example - - -```js -const client = await page.target().createCDPSession(); -await client.send('Animation.enable'); -client.on('Animation.animationCreated', () => console.log('Animation created!')); -const response = await client.send('Animation.getPlaybackRate'); -console.log('playback rate is ' + response.playbackRate); -await client.send('Animation.setPlaybackRate', { - playbackRate: response.playbackRate / 2 -}); - -``` - -## Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [connection()](./puppeteer.cdpsession.connection.md) | | | -| [detach()](./puppeteer.cdpsession.detach.md) | | Detaches the cdpSession from the target. Once detached, the cdpSession object won't emit any events and can't be used to send messages. | -| [send(method, paramArgs)](./puppeteer.cdpsession.send.md) | | | - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.cdpsession.send.md b/website/versioned_docs/version-10.0.0/puppeteer.cdpsession.send.md deleted file mode 100644 index 317d01c9..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.cdpsession.send.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [CDPSession](./puppeteer.cdpsession.md) > [send](./puppeteer.cdpsession.send.md) - -## CDPSession.send() method - -Signature: - -```typescript -send(method: T, ...paramArgs: ProtocolMapping.Commands[T]['paramsType']): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| method | T | | -| paramArgs | ProtocolMapping.Commands\[T\]\['paramsType'\] | | - -Returns: - -Promise<ProtocolMapping.Commands\[T\]\['returnType'\]> - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.cdpsessiononmessageobject.error.md b/website/versioned_docs/version-10.0.0/puppeteer.cdpsessiononmessageobject.error.md deleted file mode 100644 index d4583855..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.cdpsessiononmessageobject.error.md +++ /dev/null @@ -1,14 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [CDPSessionOnMessageObject](./puppeteer.cdpsessiononmessageobject.md) > [error](./puppeteer.cdpsessiononmessageobject.error.md) - -## CDPSessionOnMessageObject.error property - -Signature: - -```typescript -error: { - message: string; - data: any; - }; -``` diff --git a/website/versioned_docs/version-10.0.0/puppeteer.cdpsessiononmessageobject.id.md b/website/versioned_docs/version-10.0.0/puppeteer.cdpsessiononmessageobject.id.md deleted file mode 100644 index 3e8d0a56..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.cdpsessiononmessageobject.id.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [CDPSessionOnMessageObject](./puppeteer.cdpsessiononmessageobject.md) > [id](./puppeteer.cdpsessiononmessageobject.id.md) - -## CDPSessionOnMessageObject.id property - -Signature: - -```typescript -id?: number; -``` diff --git a/website/versioned_docs/version-10.0.0/puppeteer.cdpsessiononmessageobject.md b/website/versioned_docs/version-10.0.0/puppeteer.cdpsessiononmessageobject.md deleted file mode 100644 index d7354b82..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.cdpsessiononmessageobject.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [CDPSessionOnMessageObject](./puppeteer.cdpsessiononmessageobject.md) - -## CDPSessionOnMessageObject interface - - -Signature: - -```typescript -export interface CDPSessionOnMessageObject -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [error](./puppeteer.cdpsessiononmessageobject.error.md) | { message: string; data: any; } | | -| [id?](./puppeteer.cdpsessiononmessageobject.id.md) | number | (Optional) | -| [method](./puppeteer.cdpsessiononmessageobject.method.md) | string | | -| [params](./puppeteer.cdpsessiononmessageobject.params.md) | Record<string, unknown> | | -| [result?](./puppeteer.cdpsessiononmessageobject.result.md) | any | (Optional) | - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.cdpsessiononmessageobject.method.md b/website/versioned_docs/version-10.0.0/puppeteer.cdpsessiononmessageobject.method.md deleted file mode 100644 index c5217865..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.cdpsessiononmessageobject.method.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [CDPSessionOnMessageObject](./puppeteer.cdpsessiononmessageobject.md) > [method](./puppeteer.cdpsessiononmessageobject.method.md) - -## CDPSessionOnMessageObject.method property - -Signature: - -```typescript -method: string; -``` diff --git a/website/versioned_docs/version-10.0.0/puppeteer.cdpsessiononmessageobject.params.md b/website/versioned_docs/version-10.0.0/puppeteer.cdpsessiononmessageobject.params.md deleted file mode 100644 index df6d129a..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.cdpsessiononmessageobject.params.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [CDPSessionOnMessageObject](./puppeteer.cdpsessiononmessageobject.md) > [params](./puppeteer.cdpsessiononmessageobject.params.md) - -## CDPSessionOnMessageObject.params property - -Signature: - -```typescript -params: Record; -``` diff --git a/website/versioned_docs/version-10.0.0/puppeteer.cdpsessiononmessageobject.result.md b/website/versioned_docs/version-10.0.0/puppeteer.cdpsessiononmessageobject.result.md deleted file mode 100644 index c53f7343..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.cdpsessiononmessageobject.result.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [CDPSessionOnMessageObject](./puppeteer.cdpsessiononmessageobject.md) > [result](./puppeteer.cdpsessiononmessageobject.result.md) - -## CDPSessionOnMessageObject.result property - -Signature: - -```typescript -result?: any; -``` diff --git a/website/versioned_docs/version-10.0.0/puppeteer.chromereleasechannel.md b/website/versioned_docs/version-10.0.0/puppeteer.chromereleasechannel.md deleted file mode 100644 index c4496235..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.chromereleasechannel.md +++ /dev/null @@ -1,12 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [ChromeReleaseChannel](./puppeteer.chromereleasechannel.md) - -## ChromeReleaseChannel type - - -Signature: - -```typescript -export declare type ChromeReleaseChannel = 'chrome' | 'chrome-beta' | 'chrome-canary' | 'chrome-dev'; -``` diff --git a/website/versioned_docs/version-10.0.0/puppeteer.clearcustomqueryhandlers.md b/website/versioned_docs/version-10.0.0/puppeteer.clearcustomqueryhandlers.md deleted file mode 100644 index f6bb8422..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.clearcustomqueryhandlers.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [clearCustomQueryHandlers](./puppeteer.clearcustomqueryhandlers.md) - -## clearCustomQueryHandlers() function - -Clears all registered handlers. - -Signature: - -```typescript -export declare function clearCustomQueryHandlers(): void; -``` -Returns: - -void - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.clickoptions.button.md b/website/versioned_docs/version-10.0.0/puppeteer.clickoptions.button.md deleted file mode 100644 index 2b9d0629..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.clickoptions.button.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [ClickOptions](./puppeteer.clickoptions.md) > [button](./puppeteer.clickoptions.button.md) - -## ClickOptions.button property - -Signature: - -```typescript -button?: 'left' | 'right' | 'middle'; -``` diff --git a/website/versioned_docs/version-10.0.0/puppeteer.clickoptions.clickcount.md b/website/versioned_docs/version-10.0.0/puppeteer.clickoptions.clickcount.md deleted file mode 100644 index 94257083..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.clickoptions.clickcount.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [ClickOptions](./puppeteer.clickoptions.md) > [clickCount](./puppeteer.clickoptions.clickcount.md) - -## ClickOptions.clickCount property - -Signature: - -```typescript -clickCount?: number; -``` diff --git a/website/versioned_docs/version-10.0.0/puppeteer.clickoptions.delay.md b/website/versioned_docs/version-10.0.0/puppeteer.clickoptions.delay.md deleted file mode 100644 index c96b46a1..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.clickoptions.delay.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [ClickOptions](./puppeteer.clickoptions.md) > [delay](./puppeteer.clickoptions.delay.md) - -## ClickOptions.delay property - -Time to wait between `mousedown` and `mouseup` in milliseconds. - -Signature: - -```typescript -delay?: number; -``` diff --git a/website/versioned_docs/version-10.0.0/puppeteer.clickoptions.md b/website/versioned_docs/version-10.0.0/puppeteer.clickoptions.md deleted file mode 100644 index 2ed03e2f..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.clickoptions.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [ClickOptions](./puppeteer.clickoptions.md) - -## ClickOptions interface - - -Signature: - -```typescript -export interface ClickOptions -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [button?](./puppeteer.clickoptions.button.md) | 'left' \| 'right' \| 'middle' | (Optional) | -| [clickCount?](./puppeteer.clickoptions.clickcount.md) | number | (Optional) | -| [delay?](./puppeteer.clickoptions.delay.md) | number | (Optional) Time to wait between mousedown and mouseup in milliseconds. | - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.commoneventemitter.addlistener.md b/website/versioned_docs/version-10.0.0/puppeteer.commoneventemitter.addlistener.md deleted file mode 100644 index 60f0fe3d..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.commoneventemitter.addlistener.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [CommonEventEmitter](./puppeteer.commoneventemitter.md) > [addListener](./puppeteer.commoneventemitter.addlistener.md) - -## CommonEventEmitter.addListener() method - -Signature: - -```typescript -addListener(event: EventType, handler: Handler): CommonEventEmitter; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| event | [EventType](./puppeteer.eventtype.md) | | -| handler | [Handler](./puppeteer.handler.md) | | - -Returns: - -[CommonEventEmitter](./puppeteer.commoneventemitter.md) - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.commoneventemitter.emit.md b/website/versioned_docs/version-10.0.0/puppeteer.commoneventemitter.emit.md deleted file mode 100644 index 75e72f37..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.commoneventemitter.emit.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [CommonEventEmitter](./puppeteer.commoneventemitter.md) > [emit](./puppeteer.commoneventemitter.emit.md) - -## CommonEventEmitter.emit() method - -Signature: - -```typescript -emit(event: EventType, eventData?: unknown): boolean; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| event | [EventType](./puppeteer.eventtype.md) | | -| eventData | unknown | | - -Returns: - -boolean - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.commoneventemitter.listenercount.md b/website/versioned_docs/version-10.0.0/puppeteer.commoneventemitter.listenercount.md deleted file mode 100644 index 2e68d936..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.commoneventemitter.listenercount.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [CommonEventEmitter](./puppeteer.commoneventemitter.md) > [listenerCount](./puppeteer.commoneventemitter.listenercount.md) - -## CommonEventEmitter.listenerCount() method - -Signature: - -```typescript -listenerCount(event: string): number; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| event | string | | - -Returns: - -number - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.commoneventemitter.md b/website/versioned_docs/version-10.0.0/puppeteer.commoneventemitter.md deleted file mode 100644 index 1ec59b25..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.commoneventemitter.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [CommonEventEmitter](./puppeteer.commoneventemitter.md) - -## CommonEventEmitter interface - - -Signature: - -```typescript -export interface CommonEventEmitter -``` - -## Methods - -| Method | Description | -| --- | --- | -| [addListener(event, handler)](./puppeteer.commoneventemitter.addlistener.md) | | -| [emit(event, eventData)](./puppeteer.commoneventemitter.emit.md) | | -| [listenerCount(event)](./puppeteer.commoneventemitter.listenercount.md) | | -| [off(event, handler)](./puppeteer.commoneventemitter.off.md) | | -| [on(event, handler)](./puppeteer.commoneventemitter.on.md) | | -| [once(event, handler)](./puppeteer.commoneventemitter.once.md) | | -| [removeAllListeners(event)](./puppeteer.commoneventemitter.removealllisteners.md) | | -| [removeListener(event, handler)](./puppeteer.commoneventemitter.removelistener.md) | | - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.commoneventemitter.off.md b/website/versioned_docs/version-10.0.0/puppeteer.commoneventemitter.off.md deleted file mode 100644 index bf8f9437..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.commoneventemitter.off.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [CommonEventEmitter](./puppeteer.commoneventemitter.md) > [off](./puppeteer.commoneventemitter.off.md) - -## CommonEventEmitter.off() method - -Signature: - -```typescript -off(event: EventType, handler: Handler): CommonEventEmitter; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| event | [EventType](./puppeteer.eventtype.md) | | -| handler | [Handler](./puppeteer.handler.md) | | - -Returns: - -[CommonEventEmitter](./puppeteer.commoneventemitter.md) - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.commoneventemitter.on.md b/website/versioned_docs/version-10.0.0/puppeteer.commoneventemitter.on.md deleted file mode 100644 index 15193a28..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.commoneventemitter.on.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [CommonEventEmitter](./puppeteer.commoneventemitter.md) > [on](./puppeteer.commoneventemitter.on.md) - -## CommonEventEmitter.on() method - -Signature: - -```typescript -on(event: EventType, handler: Handler): CommonEventEmitter; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| event | [EventType](./puppeteer.eventtype.md) | | -| handler | [Handler](./puppeteer.handler.md) | | - -Returns: - -[CommonEventEmitter](./puppeteer.commoneventemitter.md) - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.commoneventemitter.once.md b/website/versioned_docs/version-10.0.0/puppeteer.commoneventemitter.once.md deleted file mode 100644 index 9066bd6a..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.commoneventemitter.once.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [CommonEventEmitter](./puppeteer.commoneventemitter.md) > [once](./puppeteer.commoneventemitter.once.md) - -## CommonEventEmitter.once() method - -Signature: - -```typescript -once(event: EventType, handler: Handler): CommonEventEmitter; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| event | [EventType](./puppeteer.eventtype.md) | | -| handler | [Handler](./puppeteer.handler.md) | | - -Returns: - -[CommonEventEmitter](./puppeteer.commoneventemitter.md) - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.commoneventemitter.removealllisteners.md b/website/versioned_docs/version-10.0.0/puppeteer.commoneventemitter.removealllisteners.md deleted file mode 100644 index a52938a0..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.commoneventemitter.removealllisteners.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [CommonEventEmitter](./puppeteer.commoneventemitter.md) > [removeAllListeners](./puppeteer.commoneventemitter.removealllisteners.md) - -## CommonEventEmitter.removeAllListeners() method - -Signature: - -```typescript -removeAllListeners(event?: EventType): CommonEventEmitter; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| event | [EventType](./puppeteer.eventtype.md) | | - -Returns: - -[CommonEventEmitter](./puppeteer.commoneventemitter.md) - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.commoneventemitter.removelistener.md b/website/versioned_docs/version-10.0.0/puppeteer.commoneventemitter.removelistener.md deleted file mode 100644 index 9053478c..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.commoneventemitter.removelistener.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [CommonEventEmitter](./puppeteer.commoneventemitter.md) > [removeListener](./puppeteer.commoneventemitter.removelistener.md) - -## CommonEventEmitter.removeListener() method - -Signature: - -```typescript -removeListener(event: EventType, handler: Handler): CommonEventEmitter; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| event | [EventType](./puppeteer.eventtype.md) | | -| handler | [Handler](./puppeteer.handler.md) | | - -Returns: - -[CommonEventEmitter](./puppeteer.commoneventemitter.md) - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.connect.md b/website/versioned_docs/version-10.0.0/puppeteer.connect.md deleted file mode 100644 index 57b13bca..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.connect.md +++ /dev/null @@ -1,29 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [connect](./puppeteer.connect.md) - -## connect() function - -This method attaches Puppeteer to an existing browser instance. - -Signature: - -```typescript -export declare function connect(options: ConnectOptions): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| options | [ConnectOptions](./puppeteer.connectoptions.md) | Set of configurable options to set on the browser. | - -Returns: - -Promise<[Browser](./puppeteer.browser.md)> - -Promise which resolves to browser instance. - -## Remarks - - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.connection._callbacks.md b/website/versioned_docs/version-10.0.0/puppeteer.connection._callbacks.md deleted file mode 100644 index 69922d9e..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.connection._callbacks.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [Connection](./puppeteer.connection.md) > [\_callbacks](./puppeteer.connection._callbacks.md) - -## Connection.\_callbacks property - -Signature: - -```typescript -_callbacks: Map; -``` diff --git a/website/versioned_docs/version-10.0.0/puppeteer.connection._closed.md b/website/versioned_docs/version-10.0.0/puppeteer.connection._closed.md deleted file mode 100644 index 7c5aa062..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.connection._closed.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [Connection](./puppeteer.connection.md) > [\_closed](./puppeteer.connection._closed.md) - -## Connection.\_closed property - -Signature: - -```typescript -_closed: boolean; -``` diff --git a/website/versioned_docs/version-10.0.0/puppeteer.connection._constructor_.md b/website/versioned_docs/version-10.0.0/puppeteer.connection._constructor_.md deleted file mode 100644 index b5539c12..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.connection._constructor_.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [Connection](./puppeteer.connection.md) > [(constructor)](./puppeteer.connection._constructor_.md) - -## Connection.(constructor) - -Constructs a new instance of the `Connection` class - -Signature: - -```typescript -constructor(url: string, transport: ConnectionTransport, delay?: number); -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| url | string | | -| transport | [ConnectionTransport](./puppeteer.connectiontransport.md) | | -| delay | number | | - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.connection._delay.md b/website/versioned_docs/version-10.0.0/puppeteer.connection._delay.md deleted file mode 100644 index 14839d62..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.connection._delay.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [Connection](./puppeteer.connection.md) > [\_delay](./puppeteer.connection._delay.md) - -## Connection.\_delay property - -Signature: - -```typescript -_delay: number; -``` diff --git a/website/versioned_docs/version-10.0.0/puppeteer.connection._lastid.md b/website/versioned_docs/version-10.0.0/puppeteer.connection._lastid.md deleted file mode 100644 index 66c8641b..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.connection._lastid.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [Connection](./puppeteer.connection.md) > [\_lastId](./puppeteer.connection._lastid.md) - -## Connection.\_lastId property - -Signature: - -```typescript -_lastId: number; -``` diff --git a/website/versioned_docs/version-10.0.0/puppeteer.connection._onclose.md b/website/versioned_docs/version-10.0.0/puppeteer.connection._onclose.md deleted file mode 100644 index 31d6153e..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.connection._onclose.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [Connection](./puppeteer.connection.md) > [\_onClose](./puppeteer.connection._onclose.md) - -## Connection.\_onClose() method - -Signature: - -```typescript -_onClose(): void; -``` -Returns: - -void - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.connection._onmessage.md b/website/versioned_docs/version-10.0.0/puppeteer.connection._onmessage.md deleted file mode 100644 index 7dca08b4..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.connection._onmessage.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [Connection](./puppeteer.connection.md) > [\_onMessage](./puppeteer.connection._onmessage.md) - -## Connection.\_onMessage() method - -Signature: - -```typescript -_onMessage(message: string): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| message | string | | - -Returns: - -Promise<void> - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.connection._rawsend.md b/website/versioned_docs/version-10.0.0/puppeteer.connection._rawsend.md deleted file mode 100644 index 6a83d310..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.connection._rawsend.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [Connection](./puppeteer.connection.md) > [\_rawSend](./puppeteer.connection._rawsend.md) - -## Connection.\_rawSend() method - -Signature: - -```typescript -_rawSend(message: Record): number; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| message | Record<string, unknown> | | - -Returns: - -number - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.connection._sessions.md b/website/versioned_docs/version-10.0.0/puppeteer.connection._sessions.md deleted file mode 100644 index de2d7522..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.connection._sessions.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [Connection](./puppeteer.connection.md) > [\_sessions](./puppeteer.connection._sessions.md) - -## Connection.\_sessions property - -Signature: - -```typescript -_sessions: Map; -``` diff --git a/website/versioned_docs/version-10.0.0/puppeteer.connection._transport.md b/website/versioned_docs/version-10.0.0/puppeteer.connection._transport.md deleted file mode 100644 index c8692e63..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.connection._transport.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [Connection](./puppeteer.connection.md) > [\_transport](./puppeteer.connection._transport.md) - -## Connection.\_transport property - -Signature: - -```typescript -_transport: ConnectionTransport; -``` diff --git a/website/versioned_docs/version-10.0.0/puppeteer.connection._url.md b/website/versioned_docs/version-10.0.0/puppeteer.connection._url.md deleted file mode 100644 index fc5bce58..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.connection._url.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [Connection](./puppeteer.connection.md) > [\_url](./puppeteer.connection._url.md) - -## Connection.\_url property - -Signature: - -```typescript -_url: string; -``` diff --git a/website/versioned_docs/version-10.0.0/puppeteer.connection.createsession.md b/website/versioned_docs/version-10.0.0/puppeteer.connection.createsession.md deleted file mode 100644 index 19ccedbe..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.connection.createsession.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [Connection](./puppeteer.connection.md) > [createSession](./puppeteer.connection.createsession.md) - -## Connection.createSession() method - -Signature: - -```typescript -createSession(targetInfo: Protocol.Target.TargetInfo): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| targetInfo | Protocol.Target.TargetInfo | The target info | - -Returns: - -Promise<[CDPSession](./puppeteer.cdpsession.md)> - -The CDP session that is created - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.connection.dispose.md b/website/versioned_docs/version-10.0.0/puppeteer.connection.dispose.md deleted file mode 100644 index 07d8e9b5..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.connection.dispose.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [Connection](./puppeteer.connection.md) > [dispose](./puppeteer.connection.dispose.md) - -## Connection.dispose() method - -Signature: - -```typescript -dispose(): void; -``` -Returns: - -void - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.connection.fromsession.md b/website/versioned_docs/version-10.0.0/puppeteer.connection.fromsession.md deleted file mode 100644 index 8663934a..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.connection.fromsession.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [Connection](./puppeteer.connection.md) > [fromSession](./puppeteer.connection.fromsession.md) - -## Connection.fromSession() method - -Signature: - -```typescript -static fromSession(session: CDPSession): Connection; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| session | [CDPSession](./puppeteer.cdpsession.md) | | - -Returns: - -[Connection](./puppeteer.connection.md) - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.connection.md b/website/versioned_docs/version-10.0.0/puppeteer.connection.md deleted file mode 100644 index 385faea9..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.connection.md +++ /dev/null @@ -1,46 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [Connection](./puppeteer.connection.md) - -## Connection class - - -Signature: - -```typescript -export declare class Connection extends EventEmitter -``` -Extends: [EventEmitter](./puppeteer.eventemitter.md) - -## Constructors - -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [(constructor)(url, transport, delay)](./puppeteer.connection._constructor_.md) | | Constructs a new instance of the Connection class | - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [\_callbacks](./puppeteer.connection._callbacks.md) | | Map<number, [ConnectionCallback](./puppeteer.connectioncallback.md)> | | -| [\_closed](./puppeteer.connection._closed.md) | | boolean | | -| [\_delay](./puppeteer.connection._delay.md) | | number | | -| [\_lastId](./puppeteer.connection._lastid.md) | | number | | -| [\_sessions](./puppeteer.connection._sessions.md) | | Map<string, [CDPSession](./puppeteer.cdpsession.md)> | | -| [\_transport](./puppeteer.connection._transport.md) | | [ConnectionTransport](./puppeteer.connectiontransport.md) | | -| [\_url](./puppeteer.connection._url.md) | | string | | - -## Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [\_onClose()](./puppeteer.connection._onclose.md) | | | -| [\_onMessage(message)](./puppeteer.connection._onmessage.md) | | | -| [\_rawSend(message)](./puppeteer.connection._rawsend.md) | | | -| [createSession(targetInfo)](./puppeteer.connection.createsession.md) | | | -| [dispose()](./puppeteer.connection.dispose.md) | | | -| [fromSession(session)](./puppeteer.connection.fromsession.md) | static | | -| [send(method, paramArgs)](./puppeteer.connection.send.md) | | | -| [session(sessionId)](./puppeteer.connection.session.md) | | | -| [url()](./puppeteer.connection.url.md) | | | - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.connection.send.md b/website/versioned_docs/version-10.0.0/puppeteer.connection.send.md deleted file mode 100644 index b5c41854..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.connection.send.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [Connection](./puppeteer.connection.md) > [send](./puppeteer.connection.send.md) - -## Connection.send() method - -Signature: - -```typescript -send(method: T, ...paramArgs: ProtocolMapping.Commands[T]['paramsType']): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| method | T | | -| paramArgs | ProtocolMapping.Commands\[T\]\['paramsType'\] | | - -Returns: - -Promise<ProtocolMapping.Commands\[T\]\['returnType'\]> - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.connection.session.md b/website/versioned_docs/version-10.0.0/puppeteer.connection.session.md deleted file mode 100644 index 901679b7..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.connection.session.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [Connection](./puppeteer.connection.md) > [session](./puppeteer.connection.session.md) - -## Connection.session() method - -Signature: - -```typescript -session(sessionId: string): CDPSession | null; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| sessionId | string | The session id | - -Returns: - -[CDPSession](./puppeteer.cdpsession.md) \| null - -The current CDP session if it exists - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.connection.url.md b/website/versioned_docs/version-10.0.0/puppeteer.connection.url.md deleted file mode 100644 index 90bd6c61..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.connection.url.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [Connection](./puppeteer.connection.md) > [url](./puppeteer.connection.url.md) - -## Connection.url() method - -Signature: - -```typescript -url(): string; -``` -Returns: - -string - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.connectioncallback.error.md b/website/versioned_docs/version-10.0.0/puppeteer.connectioncallback.error.md deleted file mode 100644 index e5488d21..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.connectioncallback.error.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [ConnectionCallback](./puppeteer.connectioncallback.md) > [error](./puppeteer.connectioncallback.error.md) - -## ConnectionCallback.error property - -Signature: - -```typescript -error: Error; -``` diff --git a/website/versioned_docs/version-10.0.0/puppeteer.connectioncallback.md b/website/versioned_docs/version-10.0.0/puppeteer.connectioncallback.md deleted file mode 100644 index ca512049..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.connectioncallback.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [ConnectionCallback](./puppeteer.connectioncallback.md) - -## ConnectionCallback interface - - -Signature: - -```typescript -export interface ConnectionCallback -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [error](./puppeteer.connectioncallback.error.md) | Error | | -| [method](./puppeteer.connectioncallback.method.md) | string | | -| [reject](./puppeteer.connectioncallback.reject.md) | Function | | -| [resolve](./puppeteer.connectioncallback.resolve.md) | Function | | - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.connectioncallback.method.md b/website/versioned_docs/version-10.0.0/puppeteer.connectioncallback.method.md deleted file mode 100644 index 1cb9db85..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.connectioncallback.method.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [ConnectionCallback](./puppeteer.connectioncallback.md) > [method](./puppeteer.connectioncallback.method.md) - -## ConnectionCallback.method property - -Signature: - -```typescript -method: string; -``` diff --git a/website/versioned_docs/version-10.0.0/puppeteer.connectioncallback.reject.md b/website/versioned_docs/version-10.0.0/puppeteer.connectioncallback.reject.md deleted file mode 100644 index 2810ebcb..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.connectioncallback.reject.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [ConnectionCallback](./puppeteer.connectioncallback.md) > [reject](./puppeteer.connectioncallback.reject.md) - -## ConnectionCallback.reject property - -Signature: - -```typescript -reject: Function; -``` diff --git a/website/versioned_docs/version-10.0.0/puppeteer.connectioncallback.resolve.md b/website/versioned_docs/version-10.0.0/puppeteer.connectioncallback.resolve.md deleted file mode 100644 index 41dd3369..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.connectioncallback.resolve.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [ConnectionCallback](./puppeteer.connectioncallback.md) > [resolve](./puppeteer.connectioncallback.resolve.md) - -## ConnectionCallback.resolve property - -Signature: - -```typescript -resolve: Function; -``` diff --git a/website/versioned_docs/version-10.0.0/puppeteer.connectiontransport.close.md b/website/versioned_docs/version-10.0.0/puppeteer.connectiontransport.close.md deleted file mode 100644 index 8985544a..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.connectiontransport.close.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [ConnectionTransport](./puppeteer.connectiontransport.md) > [close](./puppeteer.connectiontransport.close.md) - -## ConnectionTransport.close() method - -Signature: - -```typescript -close(): any; -``` -Returns: - -any - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.connectiontransport.md b/website/versioned_docs/version-10.0.0/puppeteer.connectiontransport.md deleted file mode 100644 index 9c918538..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.connectiontransport.md +++ /dev/null @@ -1,27 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [ConnectionTransport](./puppeteer.connectiontransport.md) - -## ConnectionTransport interface - - -Signature: - -```typescript -export interface ConnectionTransport -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [onclose?](./puppeteer.connectiontransport.onclose.md) | () => void | (Optional) | -| [onmessage?](./puppeteer.connectiontransport.onmessage.md) | (message: string) => void | (Optional) | - -## Methods - -| Method | Description | -| --- | --- | -| [close()](./puppeteer.connectiontransport.close.md) | | -| [send(string)](./puppeteer.connectiontransport.send.md) | | - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.connectiontransport.onclose.md b/website/versioned_docs/version-10.0.0/puppeteer.connectiontransport.onclose.md deleted file mode 100644 index 7c87797c..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.connectiontransport.onclose.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [ConnectionTransport](./puppeteer.connectiontransport.md) > [onclose](./puppeteer.connectiontransport.onclose.md) - -## ConnectionTransport.onclose property - -Signature: - -```typescript -onclose?: () => void; -``` diff --git a/website/versioned_docs/version-10.0.0/puppeteer.connectiontransport.onmessage.md b/website/versioned_docs/version-10.0.0/puppeteer.connectiontransport.onmessage.md deleted file mode 100644 index 7af1a876..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.connectiontransport.onmessage.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [ConnectionTransport](./puppeteer.connectiontransport.md) > [onmessage](./puppeteer.connectiontransport.onmessage.md) - -## ConnectionTransport.onmessage property - -Signature: - -```typescript -onmessage?: (message: string) => void; -``` diff --git a/website/versioned_docs/version-10.0.0/puppeteer.connectiontransport.send.md b/website/versioned_docs/version-10.0.0/puppeteer.connectiontransport.send.md deleted file mode 100644 index 0a87f13a..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.connectiontransport.send.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [ConnectionTransport](./puppeteer.connectiontransport.md) > [send](./puppeteer.connectiontransport.send.md) - -## ConnectionTransport.send() method - -Signature: - -```typescript -send(string: any): any; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| string | any | | - -Returns: - -any - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.connectoptions.browserurl.md b/website/versioned_docs/version-10.0.0/puppeteer.connectoptions.browserurl.md deleted file mode 100644 index 987e5214..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.connectoptions.browserurl.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [ConnectOptions](./puppeteer.connectoptions.md) > [browserURL](./puppeteer.connectoptions.browserurl.md) - -## ConnectOptions.browserURL property - -Signature: - -```typescript -browserURL?: string; -``` diff --git a/website/versioned_docs/version-10.0.0/puppeteer.connectoptions.browserwsendpoint.md b/website/versioned_docs/version-10.0.0/puppeteer.connectoptions.browserwsendpoint.md deleted file mode 100644 index 2b79ea3c..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.connectoptions.browserwsendpoint.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [ConnectOptions](./puppeteer.connectoptions.md) > [browserWSEndpoint](./puppeteer.connectoptions.browserwsendpoint.md) - -## ConnectOptions.browserWSEndpoint property - -Signature: - -```typescript -browserWSEndpoint?: string; -``` diff --git a/website/versioned_docs/version-10.0.0/puppeteer.connectoptions.md b/website/versioned_docs/version-10.0.0/puppeteer.connectoptions.md deleted file mode 100644 index 4c465dda..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.connectoptions.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [ConnectOptions](./puppeteer.connectoptions.md) - -## ConnectOptions interface - - -Signature: - -```typescript -export interface ConnectOptions extends BrowserConnectOptions -``` -Extends: [BrowserConnectOptions](./puppeteer.browserconnectoptions.md) - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [browserURL?](./puppeteer.connectoptions.browserurl.md) | string | (Optional) | -| [browserWSEndpoint?](./puppeteer.connectoptions.browserwsendpoint.md) | string | (Optional) | -| [product?](./puppeteer.connectoptions.product.md) | [Product](./puppeteer.product.md) | (Optional) | -| [transport?](./puppeteer.connectoptions.transport.md) | [ConnectionTransport](./puppeteer.connectiontransport.md) | (Optional) | - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.connectoptions.product.md b/website/versioned_docs/version-10.0.0/puppeteer.connectoptions.product.md deleted file mode 100644 index b828ce7b..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.connectoptions.product.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [ConnectOptions](./puppeteer.connectoptions.md) > [product](./puppeteer.connectoptions.product.md) - -## ConnectOptions.product property - -Signature: - -```typescript -product?: Product; -``` diff --git a/website/versioned_docs/version-10.0.0/puppeteer.connectoptions.transport.md b/website/versioned_docs/version-10.0.0/puppeteer.connectoptions.transport.md deleted file mode 100644 index 50a40a1e..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.connectoptions.transport.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [ConnectOptions](./puppeteer.connectoptions.md) > [transport](./puppeteer.connectoptions.transport.md) - -## ConnectOptions.transport property - -Signature: - -```typescript -transport?: ConnectionTransport; -``` diff --git a/website/versioned_docs/version-10.0.0/puppeteer.consolemessage._constructor_.md b/website/versioned_docs/version-10.0.0/puppeteer.consolemessage._constructor_.md deleted file mode 100644 index 11614f1b..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.consolemessage._constructor_.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [ConsoleMessage](./puppeteer.consolemessage.md) > [(constructor)](./puppeteer.consolemessage._constructor_.md) - -## ConsoleMessage.(constructor) - -Constructs a new instance of the `ConsoleMessage` class - -Signature: - -```typescript -constructor(type: ConsoleMessageType, text: string, args: JSHandle[], stackTraceLocations: ConsoleMessageLocation[]); -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| type | [ConsoleMessageType](./puppeteer.consolemessagetype.md) | | -| text | string | | -| args | [JSHandle](./puppeteer.jshandle.md)\[\] | | -| stackTraceLocations | [ConsoleMessageLocation](./puppeteer.consolemessagelocation.md)\[\] | | - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.consolemessage.args.md b/website/versioned_docs/version-10.0.0/puppeteer.consolemessage.args.md deleted file mode 100644 index a346e18d..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.consolemessage.args.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [ConsoleMessage](./puppeteer.consolemessage.md) > [args](./puppeteer.consolemessage.args.md) - -## ConsoleMessage.args() method - -Signature: - -```typescript -args(): JSHandle[]; -``` -Returns: - -[JSHandle](./puppeteer.jshandle.md)\[\] - -An array of arguments passed to the console. - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.consolemessage.location.md b/website/versioned_docs/version-10.0.0/puppeteer.consolemessage.location.md deleted file mode 100644 index 1eac0154..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.consolemessage.location.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [ConsoleMessage](./puppeteer.consolemessage.md) > [location](./puppeteer.consolemessage.location.md) - -## ConsoleMessage.location() method - -Signature: - -```typescript -location(): ConsoleMessageLocation; -``` -Returns: - -[ConsoleMessageLocation](./puppeteer.consolemessagelocation.md) - -The location of the console message. - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.consolemessage.md b/website/versioned_docs/version-10.0.0/puppeteer.consolemessage.md deleted file mode 100644 index e56e5bd2..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.consolemessage.md +++ /dev/null @@ -1,30 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [ConsoleMessage](./puppeteer.consolemessage.md) - -## ConsoleMessage class - -ConsoleMessage objects are dispatched by page via the 'console' event. - -Signature: - -```typescript -export declare class ConsoleMessage -``` - -## Constructors - -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [(constructor)(type, text, args, stackTraceLocations)](./puppeteer.consolemessage._constructor_.md) | | Constructs a new instance of the ConsoleMessage class | - -## Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [args()](./puppeteer.consolemessage.args.md) | | | -| [location()](./puppeteer.consolemessage.location.md) | | | -| [stackTrace()](./puppeteer.consolemessage.stacktrace.md) | | | -| [text()](./puppeteer.consolemessage.text.md) | | | -| [type()](./puppeteer.consolemessage.type.md) | | | - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.consolemessage.stacktrace.md b/website/versioned_docs/version-10.0.0/puppeteer.consolemessage.stacktrace.md deleted file mode 100644 index b326e6c7..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.consolemessage.stacktrace.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [ConsoleMessage](./puppeteer.consolemessage.md) > [stackTrace](./puppeteer.consolemessage.stacktrace.md) - -## ConsoleMessage.stackTrace() method - -Signature: - -```typescript -stackTrace(): ConsoleMessageLocation[]; -``` -Returns: - -[ConsoleMessageLocation](./puppeteer.consolemessagelocation.md)\[\] - -The array of locations on the stack of the console message. - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.consolemessage.text.md b/website/versioned_docs/version-10.0.0/puppeteer.consolemessage.text.md deleted file mode 100644 index 6b4edb5c..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.consolemessage.text.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [ConsoleMessage](./puppeteer.consolemessage.md) > [text](./puppeteer.consolemessage.text.md) - -## ConsoleMessage.text() method - -Signature: - -```typescript -text(): string; -``` -Returns: - -string - -The text of the console message. - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.consolemessage.type.md b/website/versioned_docs/version-10.0.0/puppeteer.consolemessage.type.md deleted file mode 100644 index 685b6195..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.consolemessage.type.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [ConsoleMessage](./puppeteer.consolemessage.md) > [type](./puppeteer.consolemessage.type.md) - -## ConsoleMessage.type() method - -Signature: - -```typescript -type(): ConsoleMessageType; -``` -Returns: - -[ConsoleMessageType](./puppeteer.consolemessagetype.md) - -The type of the console message. - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.consolemessagelocation.columnnumber.md b/website/versioned_docs/version-10.0.0/puppeteer.consolemessagelocation.columnnumber.md deleted file mode 100644 index 23a6b3d2..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.consolemessagelocation.columnnumber.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [ConsoleMessageLocation](./puppeteer.consolemessagelocation.md) > [columnNumber](./puppeteer.consolemessagelocation.columnnumber.md) - -## ConsoleMessageLocation.columnNumber property - -0-based column number in the resource if known or `undefined` otherwise. - -Signature: - -```typescript -columnNumber?: number; -``` diff --git a/website/versioned_docs/version-10.0.0/puppeteer.consolemessagelocation.linenumber.md b/website/versioned_docs/version-10.0.0/puppeteer.consolemessagelocation.linenumber.md deleted file mode 100644 index cdc1fd45..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.consolemessagelocation.linenumber.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [ConsoleMessageLocation](./puppeteer.consolemessagelocation.md) > [lineNumber](./puppeteer.consolemessagelocation.linenumber.md) - -## ConsoleMessageLocation.lineNumber property - -0-based line number in the resource if known or `undefined` otherwise. - -Signature: - -```typescript -lineNumber?: number; -``` diff --git a/website/versioned_docs/version-10.0.0/puppeteer.consolemessagelocation.md b/website/versioned_docs/version-10.0.0/puppeteer.consolemessagelocation.md deleted file mode 100644 index b6f03216..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.consolemessagelocation.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [ConsoleMessageLocation](./puppeteer.consolemessagelocation.md) - -## ConsoleMessageLocation interface - - -Signature: - -```typescript -export interface ConsoleMessageLocation -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [columnNumber?](./puppeteer.consolemessagelocation.columnnumber.md) | number | (Optional) 0-based column number in the resource if known or undefined otherwise. | -| [lineNumber?](./puppeteer.consolemessagelocation.linenumber.md) | number | (Optional) 0-based line number in the resource if known or undefined otherwise. | -| [url?](./puppeteer.consolemessagelocation.url.md) | string | (Optional) URL of the resource if known or undefined otherwise. | - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.consolemessagelocation.url.md b/website/versioned_docs/version-10.0.0/puppeteer.consolemessagelocation.url.md deleted file mode 100644 index fe30226e..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.consolemessagelocation.url.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [ConsoleMessageLocation](./puppeteer.consolemessagelocation.md) > [url](./puppeteer.consolemessagelocation.url.md) - -## ConsoleMessageLocation.url property - -URL of the resource if known or `undefined` otherwise. - -Signature: - -```typescript -url?: string; -``` diff --git a/website/versioned_docs/version-10.0.0/puppeteer.consolemessagetype.md b/website/versioned_docs/version-10.0.0/puppeteer.consolemessagetype.md deleted file mode 100644 index d9a3e883..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.consolemessagetype.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [ConsoleMessageType](./puppeteer.consolemessagetype.md) - -## ConsoleMessageType type - -The supported types for console messages. - -Signature: - -```typescript -export declare type ConsoleMessageType = 'log' | 'debug' | 'info' | 'error' | 'warning' | 'dir' | 'dirxml' | 'table' | 'trace' | 'clear' | 'startGroup' | 'startGroupCollapsed' | 'endGroup' | 'assert' | 'profile' | 'profileEnd' | 'count' | 'timeEnd' | 'verbose'; -``` diff --git a/website/versioned_docs/version-10.0.0/puppeteer.continuerequestoverrides.headers.md b/website/versioned_docs/version-10.0.0/puppeteer.continuerequestoverrides.headers.md deleted file mode 100644 index 85a062bb..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.continuerequestoverrides.headers.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [ContinueRequestOverrides](./puppeteer.continuerequestoverrides.md) > [headers](./puppeteer.continuerequestoverrides.headers.md) - -## ContinueRequestOverrides.headers property - -Signature: - -```typescript -headers?: Record; -``` diff --git a/website/versioned_docs/version-10.0.0/puppeteer.continuerequestoverrides.md b/website/versioned_docs/version-10.0.0/puppeteer.continuerequestoverrides.md deleted file mode 100644 index 38e7a2de..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.continuerequestoverrides.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [ContinueRequestOverrides](./puppeteer.continuerequestoverrides.md) - -## ContinueRequestOverrides interface - - -Signature: - -```typescript -export interface ContinueRequestOverrides -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [headers?](./puppeteer.continuerequestoverrides.headers.md) | Record<string, string> | (Optional) | -| [method?](./puppeteer.continuerequestoverrides.method.md) | string | (Optional) | -| [postData?](./puppeteer.continuerequestoverrides.postdata.md) | string | (Optional) | -| [url?](./puppeteer.continuerequestoverrides.url.md) | string | (Optional) If set, the request URL will change. This is not a redirect. | - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.continuerequestoverrides.method.md b/website/versioned_docs/version-10.0.0/puppeteer.continuerequestoverrides.method.md deleted file mode 100644 index ef17b396..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.continuerequestoverrides.method.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [ContinueRequestOverrides](./puppeteer.continuerequestoverrides.md) > [method](./puppeteer.continuerequestoverrides.method.md) - -## ContinueRequestOverrides.method property - -Signature: - -```typescript -method?: string; -``` diff --git a/website/versioned_docs/version-10.0.0/puppeteer.continuerequestoverrides.postdata.md b/website/versioned_docs/version-10.0.0/puppeteer.continuerequestoverrides.postdata.md deleted file mode 100644 index 7d888532..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.continuerequestoverrides.postdata.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [ContinueRequestOverrides](./puppeteer.continuerequestoverrides.md) > [postData](./puppeteer.continuerequestoverrides.postdata.md) - -## ContinueRequestOverrides.postData property - -Signature: - -```typescript -postData?: string; -``` diff --git a/website/versioned_docs/version-10.0.0/puppeteer.continuerequestoverrides.url.md b/website/versioned_docs/version-10.0.0/puppeteer.continuerequestoverrides.url.md deleted file mode 100644 index 53ec6d6d..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.continuerequestoverrides.url.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [ContinueRequestOverrides](./puppeteer.continuerequestoverrides.md) > [url](./puppeteer.continuerequestoverrides.url.md) - -## ContinueRequestOverrides.url property - -If set, the request URL will change. This is not a redirect. - -Signature: - -```typescript -url?: string; -``` diff --git a/website/versioned_docs/version-10.0.0/puppeteer.coverage._constructor_.md b/website/versioned_docs/version-10.0.0/puppeteer.coverage._constructor_.md deleted file mode 100644 index 727461d1..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.coverage._constructor_.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [Coverage](./puppeteer.coverage.md) > [(constructor)](./puppeteer.coverage._constructor_.md) - -## Coverage.(constructor) - -Constructs a new instance of the `Coverage` class - -Signature: - -```typescript -constructor(client: CDPSession); -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| client | [CDPSession](./puppeteer.cdpsession.md) | | - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.coverage.md b/website/versioned_docs/version-10.0.0/puppeteer.coverage.md deleted file mode 100644 index a5a1a57b..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.coverage.md +++ /dev/null @@ -1,62 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [Coverage](./puppeteer.coverage.md) - -## Coverage class - -The Coverage class provides methods to gathers information about parts of JavaScript and CSS that were used by the page. - -Signature: - -```typescript -export declare class Coverage -``` - -## Remarks - -To output coverage in a form consumable by [Istanbul](https://github.com/istanbuljs), see [puppeteer-to-istanbul](https://github.com/istanbuljs/puppeteer-to-istanbul). - -## Example - -An example of using JavaScript and CSS coverage to get percentage of initially executed code: - -```js -// Enable both JavaScript and CSS coverage -await Promise.all([ - page.coverage.startJSCoverage(), - page.coverage.startCSSCoverage() -]); -// Navigate to page -await page.goto('https://example.com'); -// Disable both JavaScript and CSS coverage -const [jsCoverage, cssCoverage] = await Promise.all([ - page.coverage.stopJSCoverage(), - page.coverage.stopCSSCoverage(), -]); -let totalBytes = 0; -let usedBytes = 0; -const coverage = [...jsCoverage, ...cssCoverage]; -for (const entry of coverage) { - totalBytes += entry.text.length; - for (const range of entry.ranges) - usedBytes += range.end - range.start - 1; -} -console.log(`Bytes used: ${usedBytes / totalBytes * 100}%`); - -``` - -## Constructors - -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [(constructor)(client)](./puppeteer.coverage._constructor_.md) | | Constructs a new instance of the Coverage class | - -## Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [startCSSCoverage(options)](./puppeteer.coverage.startcsscoverage.md) | | | -| [startJSCoverage(options)](./puppeteer.coverage.startjscoverage.md) | | | -| [stopCSSCoverage()](./puppeteer.coverage.stopcsscoverage.md) | | | -| [stopJSCoverage()](./puppeteer.coverage.stopjscoverage.md) | | | - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.coverage.startcsscoverage.md b/website/versioned_docs/version-10.0.0/puppeteer.coverage.startcsscoverage.md deleted file mode 100644 index 2a5996d0..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.coverage.startcsscoverage.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [Coverage](./puppeteer.coverage.md) > [startCSSCoverage](./puppeteer.coverage.startcsscoverage.md) - -## Coverage.startCSSCoverage() method - -Signature: - -```typescript -startCSSCoverage(options?: CSSCoverageOptions): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| options | [CSSCoverageOptions](./puppeteer.csscoverageoptions.md) | Set of configurable options for coverage, defaults to resetOnNavigation : true | - -Returns: - -Promise<void> - -Promise that resolves when coverage is started. - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.coverage.startjscoverage.md b/website/versioned_docs/version-10.0.0/puppeteer.coverage.startjscoverage.md deleted file mode 100644 index b4e195f3..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.coverage.startjscoverage.md +++ /dev/null @@ -1,28 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [Coverage](./puppeteer.coverage.md) > [startJSCoverage](./puppeteer.coverage.startjscoverage.md) - -## Coverage.startJSCoverage() method - -Signature: - -```typescript -startJSCoverage(options?: JSCoverageOptions): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| options | [JSCoverageOptions](./puppeteer.jscoverageoptions.md) | Set of configurable options for coverage defaults to resetOnNavigation : true, reportAnonymousScripts : false | - -Returns: - -Promise<void> - -Promise that resolves when coverage is started. - -## Remarks - -Anonymous scripts are ones that don't have an associated url. These are scripts that are dynamically created on the page using `eval` or `new Function`. If `reportAnonymousScripts` is set to `true`, anonymous scripts will have `__puppeteer_evaluation_script__` as their URL. - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.coverage.stopcsscoverage.md b/website/versioned_docs/version-10.0.0/puppeteer.coverage.stopcsscoverage.md deleted file mode 100644 index e926fd00..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.coverage.stopcsscoverage.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [Coverage](./puppeteer.coverage.md) > [stopCSSCoverage](./puppeteer.coverage.stopcsscoverage.md) - -## Coverage.stopCSSCoverage() method - -Signature: - -```typescript -stopCSSCoverage(): Promise; -``` -Returns: - -Promise<[CoverageEntry](./puppeteer.coverageentry.md)\[\]> - -Promise that resolves to the array of coverage reports for all stylesheets. - -## Remarks - -CSS Coverage doesn't include dynamically injected style tags without sourceURLs. - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.coverage.stopjscoverage.md b/website/versioned_docs/version-10.0.0/puppeteer.coverage.stopjscoverage.md deleted file mode 100644 index 9a66b035..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.coverage.stopjscoverage.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [Coverage](./puppeteer.coverage.md) > [stopJSCoverage](./puppeteer.coverage.stopjscoverage.md) - -## Coverage.stopJSCoverage() method - -Signature: - -```typescript -stopJSCoverage(): Promise; -``` -Returns: - -Promise<[CoverageEntry](./puppeteer.coverageentry.md)\[\]> - -Promise that resolves to the array of coverage reports for all scripts. - -## Remarks - -JavaScript Coverage doesn't include anonymous scripts by default. However, scripts with sourceURLs are reported. - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.coverageentry.md b/website/versioned_docs/version-10.0.0/puppeteer.coverageentry.md deleted file mode 100644 index 2991f0d5..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.coverageentry.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [CoverageEntry](./puppeteer.coverageentry.md) - -## CoverageEntry interface - -The CoverageEntry class represents one entry of the coverage report. - -Signature: - -```typescript -export interface CoverageEntry -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [ranges](./puppeteer.coverageentry.ranges.md) | Array<{ start: number; end: number; }> | The covered range as start and end positions. | -| [text](./puppeteer.coverageentry.text.md) | string | The content of the style sheet or script. | -| [url](./puppeteer.coverageentry.url.md) | string | The URL of the style sheet or script. | - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.coverageentry.ranges.md b/website/versioned_docs/version-10.0.0/puppeteer.coverageentry.ranges.md deleted file mode 100644 index 8a0ad196..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.coverageentry.ranges.md +++ /dev/null @@ -1,16 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [CoverageEntry](./puppeteer.coverageentry.md) > [ranges](./puppeteer.coverageentry.ranges.md) - -## CoverageEntry.ranges property - -The covered range as start and end positions. - -Signature: - -```typescript -ranges: Array<{ - start: number; - end: number; - }>; -``` diff --git a/website/versioned_docs/version-10.0.0/puppeteer.coverageentry.text.md b/website/versioned_docs/version-10.0.0/puppeteer.coverageentry.text.md deleted file mode 100644 index a5d3ddc6..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.coverageentry.text.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [CoverageEntry](./puppeteer.coverageentry.md) > [text](./puppeteer.coverageentry.text.md) - -## CoverageEntry.text property - -The content of the style sheet or script. - -Signature: - -```typescript -text: string; -``` diff --git a/website/versioned_docs/version-10.0.0/puppeteer.coverageentry.url.md b/website/versioned_docs/version-10.0.0/puppeteer.coverageentry.url.md deleted file mode 100644 index 9f33d730..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.coverageentry.url.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [CoverageEntry](./puppeteer.coverageentry.md) > [url](./puppeteer.coverageentry.url.md) - -## CoverageEntry.url property - -The URL of the style sheet or script. - -Signature: - -```typescript -url: string; -``` diff --git a/website/versioned_docs/version-10.0.0/puppeteer.credentials.md b/website/versioned_docs/version-10.0.0/puppeteer.credentials.md deleted file mode 100644 index 106acd75..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.credentials.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [Credentials](./puppeteer.credentials.md) - -## Credentials interface - - -Signature: - -```typescript -export interface Credentials -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [password](./puppeteer.credentials.password.md) | string | | -| [username](./puppeteer.credentials.username.md) | string | | - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.credentials.password.md b/website/versioned_docs/version-10.0.0/puppeteer.credentials.password.md deleted file mode 100644 index 988017ac..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.credentials.password.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [Credentials](./puppeteer.credentials.md) > [password](./puppeteer.credentials.password.md) - -## Credentials.password property - -Signature: - -```typescript -password: string; -``` diff --git a/website/versioned_docs/version-10.0.0/puppeteer.credentials.username.md b/website/versioned_docs/version-10.0.0/puppeteer.credentials.username.md deleted file mode 100644 index 1cf2011c..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.credentials.username.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [Credentials](./puppeteer.credentials.md) > [username](./puppeteer.credentials.username.md) - -## Credentials.username property - -Signature: - -```typescript -username: string; -``` diff --git a/website/versioned_docs/version-10.0.0/puppeteer.csscoverage._client.md b/website/versioned_docs/version-10.0.0/puppeteer.csscoverage._client.md deleted file mode 100644 index 1c0e553d..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.csscoverage._client.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [CSSCoverage](./puppeteer.csscoverage.md) > [\_client](./puppeteer.csscoverage._client.md) - -## CSSCoverage.\_client property - -Signature: - -```typescript -_client: CDPSession; -``` diff --git a/website/versioned_docs/version-10.0.0/puppeteer.csscoverage._constructor_.md b/website/versioned_docs/version-10.0.0/puppeteer.csscoverage._constructor_.md deleted file mode 100644 index 1511bc67..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.csscoverage._constructor_.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [CSSCoverage](./puppeteer.csscoverage.md) > [(constructor)](./puppeteer.csscoverage._constructor_.md) - -## CSSCoverage.(constructor) - -Constructs a new instance of the `CSSCoverage` class - -Signature: - -```typescript -constructor(client: CDPSession); -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| client | [CDPSession](./puppeteer.cdpsession.md) | | - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.csscoverage._enabled.md b/website/versioned_docs/version-10.0.0/puppeteer.csscoverage._enabled.md deleted file mode 100644 index 2bcf0402..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.csscoverage._enabled.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [CSSCoverage](./puppeteer.csscoverage.md) > [\_enabled](./puppeteer.csscoverage._enabled.md) - -## CSSCoverage.\_enabled property - -Signature: - -```typescript -_enabled: boolean; -``` diff --git a/website/versioned_docs/version-10.0.0/puppeteer.csscoverage._eventlisteners.md b/website/versioned_docs/version-10.0.0/puppeteer.csscoverage._eventlisteners.md deleted file mode 100644 index 6d377436..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.csscoverage._eventlisteners.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [CSSCoverage](./puppeteer.csscoverage.md) > [\_eventListeners](./puppeteer.csscoverage._eventlisteners.md) - -## CSSCoverage.\_eventListeners property - -Signature: - -```typescript -_eventListeners: PuppeteerEventListener[]; -``` diff --git a/website/versioned_docs/version-10.0.0/puppeteer.csscoverage._onexecutioncontextscleared.md b/website/versioned_docs/version-10.0.0/puppeteer.csscoverage._onexecutioncontextscleared.md deleted file mode 100644 index 70210cc2..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.csscoverage._onexecutioncontextscleared.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [CSSCoverage](./puppeteer.csscoverage.md) > [\_onExecutionContextsCleared](./puppeteer.csscoverage._onexecutioncontextscleared.md) - -## CSSCoverage.\_onExecutionContextsCleared() method - -Signature: - -```typescript -_onExecutionContextsCleared(): void; -``` -Returns: - -void - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.csscoverage._onstylesheet.md b/website/versioned_docs/version-10.0.0/puppeteer.csscoverage._onstylesheet.md deleted file mode 100644 index 311e6e2f..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.csscoverage._onstylesheet.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [CSSCoverage](./puppeteer.csscoverage.md) > [\_onStyleSheet](./puppeteer.csscoverage._onstylesheet.md) - -## CSSCoverage.\_onStyleSheet() method - -Signature: - -```typescript -_onStyleSheet(event: Protocol.CSS.StyleSheetAddedEvent): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| event | Protocol.CSS.StyleSheetAddedEvent | | - -Returns: - -Promise<void> - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.csscoverage._reportanonymousscripts.md b/website/versioned_docs/version-10.0.0/puppeteer.csscoverage._reportanonymousscripts.md deleted file mode 100644 index d34910e6..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.csscoverage._reportanonymousscripts.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [CSSCoverage](./puppeteer.csscoverage.md) > [\_reportAnonymousScripts](./puppeteer.csscoverage._reportanonymousscripts.md) - -## CSSCoverage.\_reportAnonymousScripts property - -Signature: - -```typescript -_reportAnonymousScripts: boolean; -``` diff --git a/website/versioned_docs/version-10.0.0/puppeteer.csscoverage._resetonnavigation.md b/website/versioned_docs/version-10.0.0/puppeteer.csscoverage._resetonnavigation.md deleted file mode 100644 index ecb994ca..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.csscoverage._resetonnavigation.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [CSSCoverage](./puppeteer.csscoverage.md) > [\_resetOnNavigation](./puppeteer.csscoverage._resetonnavigation.md) - -## CSSCoverage.\_resetOnNavigation property - -Signature: - -```typescript -_resetOnNavigation: boolean; -``` diff --git a/website/versioned_docs/version-10.0.0/puppeteer.csscoverage._stylesheetsources.md b/website/versioned_docs/version-10.0.0/puppeteer.csscoverage._stylesheetsources.md deleted file mode 100644 index 5044bc3a..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.csscoverage._stylesheetsources.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [CSSCoverage](./puppeteer.csscoverage.md) > [\_stylesheetSources](./puppeteer.csscoverage._stylesheetsources.md) - -## CSSCoverage.\_stylesheetSources property - -Signature: - -```typescript -_stylesheetSources: Map; -``` diff --git a/website/versioned_docs/version-10.0.0/puppeteer.csscoverage._stylesheeturls.md b/website/versioned_docs/version-10.0.0/puppeteer.csscoverage._stylesheeturls.md deleted file mode 100644 index 2ea0794b..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.csscoverage._stylesheeturls.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [CSSCoverage](./puppeteer.csscoverage.md) > [\_stylesheetURLs](./puppeteer.csscoverage._stylesheeturls.md) - -## CSSCoverage.\_stylesheetURLs property - -Signature: - -```typescript -_stylesheetURLs: Map; -``` diff --git a/website/versioned_docs/version-10.0.0/puppeteer.csscoverage.md b/website/versioned_docs/version-10.0.0/puppeteer.csscoverage.md deleted file mode 100644 index f76249c2..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.csscoverage.md +++ /dev/null @@ -1,40 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [CSSCoverage](./puppeteer.csscoverage.md) - -## CSSCoverage class - - -Signature: - -```typescript -export declare class CSSCoverage -``` - -## Constructors - -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [(constructor)(client)](./puppeteer.csscoverage._constructor_.md) | | Constructs a new instance of the CSSCoverage class | - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [\_client](./puppeteer.csscoverage._client.md) | | [CDPSession](./puppeteer.cdpsession.md) | | -| [\_enabled](./puppeteer.csscoverage._enabled.md) | | boolean | | -| [\_eventListeners](./puppeteer.csscoverage._eventlisteners.md) | | [PuppeteerEventListener](./puppeteer.puppeteereventlistener.md)\[\] | | -| [\_reportAnonymousScripts](./puppeteer.csscoverage._reportanonymousscripts.md) | | boolean | | -| [\_resetOnNavigation](./puppeteer.csscoverage._resetonnavigation.md) | | boolean | | -| [\_stylesheetSources](./puppeteer.csscoverage._stylesheetsources.md) | | Map<string, string> | | -| [\_stylesheetURLs](./puppeteer.csscoverage._stylesheeturls.md) | | Map<string, string> | | - -## Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [\_onExecutionContextsCleared()](./puppeteer.csscoverage._onexecutioncontextscleared.md) | | | -| [\_onStyleSheet(event)](./puppeteer.csscoverage._onstylesheet.md) | | | -| [start(options)](./puppeteer.csscoverage.start.md) | | | -| [stop()](./puppeteer.csscoverage.stop.md) | | | - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.csscoverage.start.md b/website/versioned_docs/version-10.0.0/puppeteer.csscoverage.start.md deleted file mode 100644 index dc986e94..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.csscoverage.start.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [CSSCoverage](./puppeteer.csscoverage.md) > [start](./puppeteer.csscoverage.start.md) - -## CSSCoverage.start() method - -Signature: - -```typescript -start(options?: { - resetOnNavigation?: boolean; - }): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| options | { resetOnNavigation?: boolean; } | | - -Returns: - -Promise<void> - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.csscoverage.stop.md b/website/versioned_docs/version-10.0.0/puppeteer.csscoverage.stop.md deleted file mode 100644 index d08b2c69..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.csscoverage.stop.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [CSSCoverage](./puppeteer.csscoverage.md) > [stop](./puppeteer.csscoverage.stop.md) - -## CSSCoverage.stop() method - -Signature: - -```typescript -stop(): Promise; -``` -Returns: - -Promise<[CoverageEntry](./puppeteer.coverageentry.md)\[\]> - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.csscoverageoptions.md b/website/versioned_docs/version-10.0.0/puppeteer.csscoverageoptions.md deleted file mode 100644 index 699d2f04..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.csscoverageoptions.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [CSSCoverageOptions](./puppeteer.csscoverageoptions.md) - -## CSSCoverageOptions interface - -Set of configurable options for CSS coverage. - -Signature: - -```typescript -export interface CSSCoverageOptions -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [resetOnNavigation?](./puppeteer.csscoverageoptions.resetonnavigation.md) | boolean | (Optional) Whether to reset coverage on every navigation. | - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.csscoverageoptions.resetonnavigation.md b/website/versioned_docs/version-10.0.0/puppeteer.csscoverageoptions.resetonnavigation.md deleted file mode 100644 index 079ffe47..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.csscoverageoptions.resetonnavigation.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [CSSCoverageOptions](./puppeteer.csscoverageoptions.md) > [resetOnNavigation](./puppeteer.csscoverageoptions.resetonnavigation.md) - -## CSSCoverageOptions.resetOnNavigation property - -Whether to reset coverage on every navigation. - -Signature: - -```typescript -resetOnNavigation?: boolean; -``` diff --git a/website/versioned_docs/version-10.0.0/puppeteer.customerror._constructor_.md b/website/versioned_docs/version-10.0.0/puppeteer.customerror._constructor_.md deleted file mode 100644 index 1d0a6b10..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.customerror._constructor_.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [CustomError](./puppeteer.customerror.md) > [(constructor)](./puppeteer.customerror._constructor_.md) - -## CustomError.(constructor) - -Constructs a new instance of the `CustomError` class - -Signature: - -```typescript -constructor(message: string); -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| message | string | | - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.customerror.md b/website/versioned_docs/version-10.0.0/puppeteer.customerror.md deleted file mode 100644 index 6ff0b161..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.customerror.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [CustomError](./puppeteer.customerror.md) - -## CustomError class - - -Signature: - -```typescript -export declare class CustomError extends Error -``` -Extends: Error - -## Constructors - -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [(constructor)(message)](./puppeteer.customerror._constructor_.md) | | Constructs a new instance of the CustomError class | - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.customqueryhandler.md b/website/versioned_docs/version-10.0.0/puppeteer.customqueryhandler.md deleted file mode 100644 index 6aa1aa93..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.customqueryhandler.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [CustomQueryHandler](./puppeteer.customqueryhandler.md) - -## CustomQueryHandler interface - -Contains two functions `queryOne` and `queryAll` that can be [registered](./puppeteer.puppeteer.registercustomqueryhandler.md) as alternative querying strategies. The functions `queryOne` and `queryAll` are executed in the page context. `queryOne` should take an `Element` and a selector string as argument and return a single `Element` or `null` if no element is found. `queryAll` takes the same arguments but should instead return a `NodeListOf` or `Array` with all the elements that match the given query selector. - -Signature: - -```typescript -export interface CustomQueryHandler -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [queryAll?](./puppeteer.customqueryhandler.queryall.md) | (element: Element \| Document, selector: string) => Element\[\] \| NodeListOf<Element> | (Optional) | -| [queryOne?](./puppeteer.customqueryhandler.queryone.md) | (element: Element \| Document, selector: string) => Element \| null | (Optional) | - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.customqueryhandler.queryall.md b/website/versioned_docs/version-10.0.0/puppeteer.customqueryhandler.queryall.md deleted file mode 100644 index 71b35ca8..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.customqueryhandler.queryall.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [CustomQueryHandler](./puppeteer.customqueryhandler.md) > [queryAll](./puppeteer.customqueryhandler.queryall.md) - -## CustomQueryHandler.queryAll property - -Signature: - -```typescript -queryAll?: (element: Element | Document, selector: string) => Element[] | NodeListOf; -``` diff --git a/website/versioned_docs/version-10.0.0/puppeteer.customqueryhandler.queryone.md b/website/versioned_docs/version-10.0.0/puppeteer.customqueryhandler.queryone.md deleted file mode 100644 index 7f00edad..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.customqueryhandler.queryone.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [CustomQueryHandler](./puppeteer.customqueryhandler.md) > [queryOne](./puppeteer.customqueryhandler.queryone.md) - -## CustomQueryHandler.queryOne property - -Signature: - -```typescript -queryOne?: (element: Element | Document, selector: string) => Element | null; -``` diff --git a/website/versioned_docs/version-10.0.0/puppeteer.customqueryhandlernames.md b/website/versioned_docs/version-10.0.0/puppeteer.customqueryhandlernames.md deleted file mode 100644 index d077b98b..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.customqueryhandlernames.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [customQueryHandlerNames](./puppeteer.customqueryhandlernames.md) - -## customQueryHandlerNames() function - -Signature: - -```typescript -export declare function customQueryHandlerNames(): string[]; -``` -Returns: - -string\[\] - -a list with the names of all registered custom query handlers. - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.device.md b/website/versioned_docs/version-10.0.0/puppeteer.device.md deleted file mode 100644 index 1382b587..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.device.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [Device](./puppeteer.device.md) - -## Device interface - - -Signature: - -```typescript -export interface Device -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [name](./puppeteer.device.name.md) | string | | -| [userAgent](./puppeteer.device.useragent.md) | string | | -| [viewport](./puppeteer.device.viewport.md) | { width: number; height: number; deviceScaleFactor: number; isMobile: boolean; hasTouch: boolean; isLandscape: boolean; } | | - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.device.name.md b/website/versioned_docs/version-10.0.0/puppeteer.device.name.md deleted file mode 100644 index 6d044886..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.device.name.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [Device](./puppeteer.device.md) > [name](./puppeteer.device.name.md) - -## Device.name property - -Signature: - -```typescript -name: string; -``` diff --git a/website/versioned_docs/version-10.0.0/puppeteer.device.useragent.md b/website/versioned_docs/version-10.0.0/puppeteer.device.useragent.md deleted file mode 100644 index 1d79e8f6..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.device.useragent.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [Device](./puppeteer.device.md) > [userAgent](./puppeteer.device.useragent.md) - -## Device.userAgent property - -Signature: - -```typescript -userAgent: string; -``` diff --git a/website/versioned_docs/version-10.0.0/puppeteer.device.viewport.md b/website/versioned_docs/version-10.0.0/puppeteer.device.viewport.md deleted file mode 100644 index 9e16753e..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.device.viewport.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [Device](./puppeteer.device.md) > [viewport](./puppeteer.device.viewport.md) - -## Device.viewport property - -Signature: - -```typescript -viewport: { - width: number; - height: number; - deviceScaleFactor: number; - isMobile: boolean; - hasTouch: boolean; - isLandscape: boolean; - }; -``` diff --git a/website/versioned_docs/version-10.0.0/puppeteer.devices.md b/website/versioned_docs/version-10.0.0/puppeteer.devices.md deleted file mode 100644 index 97e35873..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.devices.md +++ /dev/null @@ -1,16 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [devices](./puppeteer.devices.md) - -## devices variable - -Signature: - -```typescript -devices: DevicesMap -``` - -## Remarks - -A list of devices to be used with `page.emulate(options)`. Actual list of devices can be found in [src/common/DeviceDescriptors.ts](https://github.com/puppeteer/puppeteer/blob/main/src/common/DeviceDescriptors.ts). - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.devicesmap.md b/website/versioned_docs/version-10.0.0/puppeteer.devicesmap.md deleted file mode 100644 index fb1afe4a..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.devicesmap.md +++ /dev/null @@ -1,16 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [DevicesMap](./puppeteer.devicesmap.md) - -## DevicesMap type - - -Signature: - -```typescript -export declare type DevicesMap = { - [name: string]: Device; -}; -``` -References: [Device](./puppeteer.device.md) - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.dialog.accept.md b/website/versioned_docs/version-10.0.0/puppeteer.dialog.accept.md deleted file mode 100644 index cf738637..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.dialog.accept.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [Dialog](./puppeteer.dialog.md) > [accept](./puppeteer.dialog.accept.md) - -## Dialog.accept() method - -Signature: - -```typescript -accept(promptText?: string): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| promptText | string | optional text that will be entered in the dialog prompt. Has no effect if the dialog's type is not prompt. | - -Returns: - -Promise<void> - -A promise that resolves when the dialog has been accepted. - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.dialog.defaultvalue.md b/website/versioned_docs/version-10.0.0/puppeteer.dialog.defaultvalue.md deleted file mode 100644 index fe83eecc..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.dialog.defaultvalue.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [Dialog](./puppeteer.dialog.md) > [defaultValue](./puppeteer.dialog.defaultvalue.md) - -## Dialog.defaultValue() method - -Signature: - -```typescript -defaultValue(): string; -``` -Returns: - -string - -The default value of the prompt, or an empty string if the dialog is not a `prompt`. - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.dialog.dismiss.md b/website/versioned_docs/version-10.0.0/puppeteer.dialog.dismiss.md deleted file mode 100644 index 900c2863..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.dialog.dismiss.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [Dialog](./puppeteer.dialog.md) > [dismiss](./puppeteer.dialog.dismiss.md) - -## Dialog.dismiss() method - -Signature: - -```typescript -dismiss(): Promise; -``` -Returns: - -Promise<void> - -A promise which will resolve once the dialog has been dismissed - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.dialog.md b/website/versioned_docs/version-10.0.0/puppeteer.dialog.md deleted file mode 100644 index 13c9c277..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.dialog.md +++ /dev/null @@ -1,47 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [Dialog](./puppeteer.dialog.md) - -## Dialog class - -Dialog instances are dispatched by the [Page](./puppeteer.page.md) via the `dialog` event. - -Signature: - -```typescript -export declare class Dialog -``` - -## Remarks - -The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `Dialog` class. - -## Example - - -```js -const puppeteer = require('puppeteer'); - -(async () => { - const browser = await puppeteer.launch(); - const page = await browser.newPage(); - page.on('dialog', async dialog => { - console.log(dialog.message()); - await dialog.dismiss(); - await browser.close(); - }); - page.evaluate(() => alert('1')); -})(); - -``` - -## Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [accept(promptText)](./puppeteer.dialog.accept.md) | | | -| [defaultValue()](./puppeteer.dialog.defaultvalue.md) | | | -| [dismiss()](./puppeteer.dialog.dismiss.md) | | | -| [message()](./puppeteer.dialog.message.md) | | | -| [type()](./puppeteer.dialog.type.md) | | | - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.dialog.message.md b/website/versioned_docs/version-10.0.0/puppeteer.dialog.message.md deleted file mode 100644 index e725b67f..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.dialog.message.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [Dialog](./puppeteer.dialog.md) > [message](./puppeteer.dialog.message.md) - -## Dialog.message() method - -Signature: - -```typescript -message(): string; -``` -Returns: - -string - -The message displayed in the dialog. - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.dialog.type.md b/website/versioned_docs/version-10.0.0/puppeteer.dialog.type.md deleted file mode 100644 index 07e789bd..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.dialog.type.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [Dialog](./puppeteer.dialog.md) > [type](./puppeteer.dialog.type.md) - -## Dialog.type() method - -Signature: - -```typescript -type(): Protocol.Page.DialogType; -``` -Returns: - -Protocol.Page.DialogType - -The type of the dialog. - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.elementhandle._.md b/website/versioned_docs/version-10.0.0/puppeteer.elementhandle._.md deleted file mode 100644 index 80479eeb..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.elementhandle._.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [ElementHandle](./puppeteer.elementhandle.md) > [$](./puppeteer.elementhandle._.md) - -## ElementHandle.$() method - -Runs `element.querySelector` within the page. If no element matches the selector, the return value resolves to `null`. - -Signature: - -```typescript -$(selector: string): Promise | null>; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| selector | string | | - -Returns: - -Promise<[ElementHandle](./puppeteer.elementhandle.md)<T> \| null> - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.elementhandle.__.md b/website/versioned_docs/version-10.0.0/puppeteer.elementhandle.__.md deleted file mode 100644 index 06986b9d..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.elementhandle.__.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [ElementHandle](./puppeteer.elementhandle.md) > [$$](./puppeteer.elementhandle.__.md) - -## ElementHandle.$$() method - -Runs `element.querySelectorAll` within the page. If no elements match the selector, the return value resolves to `[]`. - -Signature: - -```typescript -$$(selector: string): Promise>>; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| selector | string | | - -Returns: - -Promise<Array<[ElementHandle](./puppeteer.elementhandle.md)<T>>> - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.elementhandle.__eval.md b/website/versioned_docs/version-10.0.0/puppeteer.elementhandle.__eval.md deleted file mode 100644 index a93ca002..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.elementhandle.__eval.md +++ /dev/null @@ -1,49 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [ElementHandle](./puppeteer.elementhandle.md) > [$$eval](./puppeteer.elementhandle.__eval.md) - -## ElementHandle.$$eval() method - -This method runs `document.querySelectorAll` within the element and passes it as the first argument to `pageFunction`. If there's no element matching `selector`, the method throws an error. - -If `pageFunction` returns a Promise, then `frame.$$eval` would wait for the promise to resolve and return its value. - -Signature: - -```typescript -$$eval(selector: string, pageFunction: (elements: Element[], ...args: unknown[]) => ReturnType | Promise, ...args: SerializableOrJSHandle[]): Promise>; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| selector | string | | -| pageFunction | (elements: Element\[\], ...args: unknown\[\]) => ReturnType \| Promise<ReturnType> | | -| args | [SerializableOrJSHandle](./puppeteer.serializableorjshandle.md)\[\] | | - -Returns: - -Promise<[WrapElementHandle](./puppeteer.wrapelementhandle.md)<ReturnType>> - -## Example 1 - - -```html -
-
Hello!
-
Hi!
-
- -``` - -## Example 2 - - -```js -const feedHandle = await page.$('.feed'); -expect(await feedHandle.$$eval('.tweet', nodes => nodes.map(n => n.innerText))) - .toEqual(['Hello!', 'Hi!']); - -``` - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.elementhandle._eval.md b/website/versioned_docs/version-10.0.0/puppeteer.elementhandle._eval.md deleted file mode 100644 index 9c05c448..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.elementhandle._eval.md +++ /dev/null @@ -1,38 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [ElementHandle](./puppeteer.elementhandle.md) > [$eval](./puppeteer.elementhandle._eval.md) - -## ElementHandle.$eval() method - -This method runs `document.querySelector` within the element and passes it as the first argument to `pageFunction`. If there's no element matching `selector`, the method throws an error. - -If `pageFunction` returns a Promise, then `frame.$eval` would wait for the promise to resolve and return its value. - -Signature: - -```typescript -$eval(selector: string, pageFunction: (element: Element, ...args: unknown[]) => ReturnType | Promise, ...args: SerializableOrJSHandle[]): Promise>; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| selector | string | | -| pageFunction | (element: Element, ...args: unknown\[\]) => ReturnType \| Promise<ReturnType> | | -| args | [SerializableOrJSHandle](./puppeteer.serializableorjshandle.md)\[\] | | - -Returns: - -Promise<[WrapElementHandle](./puppeteer.wrapelementhandle.md)<ReturnType>> - -## Example - - -```js -const tweetHandle = await page.$('.tweet'); -expect(await tweetHandle.$eval('.like', node => node.innerText)).toBe('100'); -expect(await tweetHandle.$eval('.retweets', node => node.innerText)).toBe('10'); - -``` - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.elementhandle._x.md b/website/versioned_docs/version-10.0.0/puppeteer.elementhandle._x.md deleted file mode 100644 index db94315b..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.elementhandle._x.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [ElementHandle](./puppeteer.elementhandle.md) > [$x](./puppeteer.elementhandle._x.md) - -## ElementHandle.$x() method - -The method evaluates the XPath expression relative to the elementHandle. If there are no such elements, the method will resolve to an empty array. - -Signature: - -```typescript -$x(expression: string): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| expression | string | Expression to [evaluate](https://developer.mozilla.org/en-US/docs/Web/API/Document/evaluate) | - -Returns: - -Promise<[ElementHandle](./puppeteer.elementhandle.md)\[\]> - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.elementhandle.aselement.md b/website/versioned_docs/version-10.0.0/puppeteer.elementhandle.aselement.md deleted file mode 100644 index 0df27995..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.elementhandle.aselement.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [ElementHandle](./puppeteer.elementhandle.md) > [asElement](./puppeteer.elementhandle.aselement.md) - -## ElementHandle.asElement() method - -Signature: - -```typescript -asElement(): ElementHandle | null; -``` -Returns: - -[ElementHandle](./puppeteer.elementhandle.md)<ElementType> \| null - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.elementhandle.boundingbox.md b/website/versioned_docs/version-10.0.0/puppeteer.elementhandle.boundingbox.md deleted file mode 100644 index eda3aaeb..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.elementhandle.boundingbox.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [ElementHandle](./puppeteer.elementhandle.md) > [boundingBox](./puppeteer.elementhandle.boundingbox.md) - -## ElementHandle.boundingBox() method - -This method returns the bounding box of the element (relative to the main frame), or `null` if the element is not visible. - -Signature: - -```typescript -boundingBox(): Promise; -``` -Returns: - -Promise<[BoundingBox](./puppeteer.boundingbox.md) \| null> - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.elementhandle.boxmodel.md b/website/versioned_docs/version-10.0.0/puppeteer.elementhandle.boxmodel.md deleted file mode 100644 index 0e1a6679..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.elementhandle.boxmodel.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [ElementHandle](./puppeteer.elementhandle.md) > [boxModel](./puppeteer.elementhandle.boxmodel.md) - -## ElementHandle.boxModel() method - -This method returns boxes of the element, or `null` if the element is not visible. - -Signature: - -```typescript -boxModel(): Promise; -``` -Returns: - -Promise<[BoxModel](./puppeteer.boxmodel.md) \| null> - -## Remarks - -Boxes are represented as an array of points; Each Point is an object `{x, y}`. Box points are sorted clock-wise. - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.elementhandle.click.md b/website/versioned_docs/version-10.0.0/puppeteer.elementhandle.click.md deleted file mode 100644 index 23a2d94a..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.elementhandle.click.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [ElementHandle](./puppeteer.elementhandle.md) > [click](./puppeteer.elementhandle.click.md) - -## ElementHandle.click() method - -This method scrolls element into view if needed, and then uses [Page.mouse](./puppeteer.page.mouse.md) to click in the center of the element. If the element is detached from DOM, the method throws an error. - -Signature: - -```typescript -click(options?: ClickOptions): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| options | [ClickOptions](./puppeteer.clickoptions.md) | | - -Returns: - -Promise<void> - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.elementhandle.clickablepoint.md b/website/versioned_docs/version-10.0.0/puppeteer.elementhandle.clickablepoint.md deleted file mode 100644 index b12f9217..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.elementhandle.clickablepoint.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [ElementHandle](./puppeteer.elementhandle.md) > [clickablePoint](./puppeteer.elementhandle.clickablepoint.md) - -## ElementHandle.clickablePoint() method - -Signature: - -```typescript -clickablePoint(): Promise; -``` -Returns: - -Promise<[Point](./puppeteer.point.md)> - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.elementhandle.contentframe.md b/website/versioned_docs/version-10.0.0/puppeteer.elementhandle.contentframe.md deleted file mode 100644 index 186e0126..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.elementhandle.contentframe.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [ElementHandle](./puppeteer.elementhandle.md) > [contentFrame](./puppeteer.elementhandle.contentframe.md) - -## ElementHandle.contentFrame() method - -Resolves to the content frame for element handles referencing iframe nodes, or null otherwise - -Signature: - -```typescript -contentFrame(): Promise; -``` -Returns: - -Promise<[Frame](./puppeteer.frame.md) \| null> - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.elementhandle.drag.md b/website/versioned_docs/version-10.0.0/puppeteer.elementhandle.drag.md deleted file mode 100644 index 7e16df4e..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.elementhandle.drag.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [ElementHandle](./puppeteer.elementhandle.md) > [drag](./puppeteer.elementhandle.drag.md) - -## ElementHandle.drag() method - -This method creates and captures a dragevent from the element. - -Signature: - -```typescript -drag(target: Point): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| target | [Point](./puppeteer.point.md) | | - -Returns: - -Promise<Protocol.Input.DragData> - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.elementhandle.draganddrop.md b/website/versioned_docs/version-10.0.0/puppeteer.elementhandle.draganddrop.md deleted file mode 100644 index 80c69427..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.elementhandle.draganddrop.md +++ /dev/null @@ -1,27 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [ElementHandle](./puppeteer.elementhandle.md) > [dragAndDrop](./puppeteer.elementhandle.draganddrop.md) - -## ElementHandle.dragAndDrop() method - -This method triggers a dragenter, dragover, and drop on the element. - -Signature: - -```typescript -dragAndDrop(target: ElementHandle, options?: { - delay: number; - }): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| target | [ElementHandle](./puppeteer.elementhandle.md) | | -| options | { delay: number; } | | - -Returns: - -Promise<void> - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.elementhandle.dragenter.md b/website/versioned_docs/version-10.0.0/puppeteer.elementhandle.dragenter.md deleted file mode 100644 index f54d33b1..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.elementhandle.dragenter.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [ElementHandle](./puppeteer.elementhandle.md) > [dragEnter](./puppeteer.elementhandle.dragenter.md) - -## ElementHandle.dragEnter() method - -This method creates a `dragenter` event on the element. - -Signature: - -```typescript -dragEnter(data?: Protocol.Input.DragData): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| data | Protocol.Input.DragData | | - -Returns: - -Promise<void> - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.elementhandle.dragover.md b/website/versioned_docs/version-10.0.0/puppeteer.elementhandle.dragover.md deleted file mode 100644 index 73566c16..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.elementhandle.dragover.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [ElementHandle](./puppeteer.elementhandle.md) > [dragOver](./puppeteer.elementhandle.dragover.md) - -## ElementHandle.dragOver() method - -This method creates a `dragover` event on the element. - -Signature: - -```typescript -dragOver(data?: Protocol.Input.DragData): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| data | Protocol.Input.DragData | | - -Returns: - -Promise<void> - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.elementhandle.drop.md b/website/versioned_docs/version-10.0.0/puppeteer.elementhandle.drop.md deleted file mode 100644 index b6470e42..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.elementhandle.drop.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [ElementHandle](./puppeteer.elementhandle.md) > [drop](./puppeteer.elementhandle.drop.md) - -## ElementHandle.drop() method - -This method triggers a drop on the element. - -Signature: - -```typescript -drop(data?: Protocol.Input.DragData): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| data | Protocol.Input.DragData | | - -Returns: - -Promise<void> - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.elementhandle.focus.md b/website/versioned_docs/version-10.0.0/puppeteer.elementhandle.focus.md deleted file mode 100644 index 4509b290..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.elementhandle.focus.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [ElementHandle](./puppeteer.elementhandle.md) > [focus](./puppeteer.elementhandle.focus.md) - -## ElementHandle.focus() method - -Calls [focus](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus) on the element. - -Signature: - -```typescript -focus(): Promise; -``` -Returns: - -Promise<void> - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.elementhandle.hover.md b/website/versioned_docs/version-10.0.0/puppeteer.elementhandle.hover.md deleted file mode 100644 index 30943ba1..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.elementhandle.hover.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [ElementHandle](./puppeteer.elementhandle.md) > [hover](./puppeteer.elementhandle.hover.md) - -## ElementHandle.hover() method - -This method scrolls element into view if needed, and then uses [Page.mouse](./puppeteer.page.mouse.md) to hover over the center of the element. If the element is detached from DOM, the method throws an error. - -Signature: - -```typescript -hover(): Promise; -``` -Returns: - -Promise<void> - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.elementhandle.isintersectingviewport.md b/website/versioned_docs/version-10.0.0/puppeteer.elementhandle.isintersectingviewport.md deleted file mode 100644 index 4621338b..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.elementhandle.isintersectingviewport.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [ElementHandle](./puppeteer.elementhandle.md) > [isIntersectingViewport](./puppeteer.elementhandle.isintersectingviewport.md) - -## ElementHandle.isIntersectingViewport() method - -Resolves to true if the element is visible in the current viewport. - -Signature: - -```typescript -isIntersectingViewport(): Promise; -``` -Returns: - -Promise<boolean> - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.elementhandle.md b/website/versioned_docs/version-10.0.0/puppeteer.elementhandle.md deleted file mode 100644 index 8670c079..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.elementhandle.md +++ /dev/null @@ -1,63 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [ElementHandle](./puppeteer.elementhandle.md) - -## ElementHandle class - -ElementHandle represents an in-page DOM element. - -Signature: - -```typescript -export declare class ElementHandle extends JSHandle -``` -Extends: [JSHandle](./puppeteer.jshandle.md)<ElementType> - -## Remarks - -ElementHandles can be created with the [Page.$()](./puppeteer.page._.md) method. - -```js -const puppeteer = require('puppeteer'); - -(async () => { - const browser = await puppeteer.launch(); - const page = await browser.newPage(); - await page.goto('https://example.com'); - const hrefElement = await page.$('a'); - await hrefElement.click(); - // ... -})(); - -``` -ElementHandle prevents the DOM element from being garbage-collected unless the handle is [disposed](./puppeteer.jshandle.dispose.md). ElementHandles are auto-disposed when their origin frame gets navigated. - -ElementHandle instances can be used as arguments in [Page.$eval()](./puppeteer.page._eval.md) and [Page.evaluate()](./puppeteer.page.evaluate.md) methods. - -If you're using TypeScript, ElementHandle takes a generic argument that denotes the type of element the handle is holding within. For example, if you have a handle to a `` element matching `selector`, the method throws an error. - -Signature: - -```typescript -select(...values: string[]): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| values | string\[\] | 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: - -Promise<string\[\]> - -## Example - - -```js -handle.select('blue'); // single selection -handle.select('red', 'green', 'blue'); // multiple selections - -``` - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.elementhandle.tap.md b/website/versioned_docs/version-10.0.0/puppeteer.elementhandle.tap.md deleted file mode 100644 index a6942420..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.elementhandle.tap.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [ElementHandle](./puppeteer.elementhandle.md) > [tap](./puppeteer.elementhandle.tap.md) - -## ElementHandle.tap() method - -This method scrolls element into view if needed, and then uses [Touchscreen.tap()](./puppeteer.touchscreen.tap.md) to tap in the center of the element. If the element is detached from DOM, the method throws an error. - -Signature: - -```typescript -tap(): Promise; -``` -Returns: - -Promise<void> - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.elementhandle.type.md b/website/versioned_docs/version-10.0.0/puppeteer.elementhandle.type.md deleted file mode 100644 index 3a64609b..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.elementhandle.type.md +++ /dev/null @@ -1,49 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [ElementHandle](./puppeteer.elementhandle.md) > [type](./puppeteer.elementhandle.type.md) - -## ElementHandle.type() method - -Focuses the element, and then sends a `keydown`, `keypress`/`input`, and `keyup` event for each character in the text. - -To press a special key, like `Control` or `ArrowDown`, use [ElementHandle.press()](./puppeteer.elementhandle.press.md). - -Signature: - -```typescript -type(text: string, options?: { - delay: number; - }): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| text | string | | -| options | { delay: number; } | | - -Returns: - -Promise<void> - -## Example 1 - - -```js -await elementHandle.type('Hello'); // Types instantly -await elementHandle.type('World', {delay: 100}); // Types slower, like a user - -``` - -## Example 2 - -An example of typing into a text field and then submitting the form: - -```js -const elementHandle = await page.$('input'); -await elementHandle.type('some text'); -await elementHandle.press('Enter'); - -``` - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.elementhandle.uploadfile.md b/website/versioned_docs/version-10.0.0/puppeteer.elementhandle.uploadfile.md deleted file mode 100644 index a4d1b4cd..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.elementhandle.uploadfile.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [ElementHandle](./puppeteer.elementhandle.md) > [uploadFile](./puppeteer.elementhandle.uploadfile.md) - -## ElementHandle.uploadFile() method - -This method expects `elementHandle` to point to an [input element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input). - -Signature: - -```typescript -uploadFile(...filePaths: string[]): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| filePaths | string\[\] | Sets the value of the file input to these paths. If some of the filePaths are relative paths, then they are resolved relative to the [current working directory](https://nodejs.org/api/process.html#process_process_cwd) | - -Returns: - -Promise<void> - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.errorcode.md b/website/versioned_docs/version-10.0.0/puppeteer.errorcode.md deleted file mode 100644 index 5ab270c5..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.errorcode.md +++ /dev/null @@ -1,12 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [ErrorCode](./puppeteer.errorcode.md) - -## ErrorCode type - - -Signature: - -```typescript -export declare type ErrorCode = 'aborted' | 'accessdenied' | 'addressunreachable' | 'blockedbyclient' | 'blockedbyresponse' | 'connectionaborted' | 'connectionclosed' | 'connectionfailed' | 'connectionrefused' | 'connectionreset' | 'internetdisconnected' | 'namenotresolved' | 'timedout' | 'failed'; -``` diff --git a/website/versioned_docs/version-10.0.0/puppeteer.errors.md b/website/versioned_docs/version-10.0.0/puppeteer.errors.md deleted file mode 100644 index 15c99b87..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.errors.md +++ /dev/null @@ -1,12 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [errors](./puppeteer.errors.md) - -## errors variable - - -Signature: - -```typescript -errors: PuppeteerErrors -``` diff --git a/website/versioned_docs/version-10.0.0/puppeteer.evaluatefn.md b/website/versioned_docs/version-10.0.0/puppeteer.evaluatefn.md deleted file mode 100644 index 23f80a34..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.evaluatefn.md +++ /dev/null @@ -1,12 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [EvaluateFn](./puppeteer.evaluatefn.md) - -## EvaluateFn type - - -Signature: - -```typescript -export declare type EvaluateFn = string | ((arg1: T, ...args: any[]) => any); -``` diff --git a/website/versioned_docs/version-10.0.0/puppeteer.evaluatefnreturntype.md b/website/versioned_docs/version-10.0.0/puppeteer.evaluatefnreturntype.md deleted file mode 100644 index 6829af5a..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.evaluatefnreturntype.md +++ /dev/null @@ -1,14 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [EvaluateFnReturnType](./puppeteer.evaluatefnreturntype.md) - -## EvaluateFnReturnType type - - -Signature: - -```typescript -export declare type EvaluateFnReturnType = T extends (...args: any[]) => infer R ? R : any; -``` -References: [EvaluateFn](./puppeteer.evaluatefn.md) - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.evaluatehandlefn.md b/website/versioned_docs/version-10.0.0/puppeteer.evaluatehandlefn.md deleted file mode 100644 index 22191cfe..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.evaluatehandlefn.md +++ /dev/null @@ -1,12 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [EvaluateHandleFn](./puppeteer.evaluatehandlefn.md) - -## EvaluateHandleFn type - - -Signature: - -```typescript -export declare type EvaluateHandleFn = string | ((...args: any[]) => any); -``` diff --git a/website/versioned_docs/version-10.0.0/puppeteer.evaluation_script_url.md b/website/versioned_docs/version-10.0.0/puppeteer.evaluation_script_url.md deleted file mode 100644 index ab5912e6..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.evaluation_script_url.md +++ /dev/null @@ -1,12 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [EVALUATION\_SCRIPT\_URL](./puppeteer.evaluation_script_url.md) - -## EVALUATION\_SCRIPT\_URL variable - - -Signature: - -```typescript -EVALUATION_SCRIPT_URL = "__puppeteer_evaluation_script__" -``` diff --git a/website/versioned_docs/version-10.0.0/puppeteer.eventemitter.addlistener.md b/website/versioned_docs/version-10.0.0/puppeteer.eventemitter.addlistener.md deleted file mode 100644 index d492b3d8..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.eventemitter.addlistener.md +++ /dev/null @@ -1,30 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [EventEmitter](./puppeteer.eventemitter.md) > [addListener](./puppeteer.eventemitter.addlistener.md) - -## EventEmitter.addListener() method - -> Warning: This API is now obsolete. -> -> please use [EventEmitter.on()](./puppeteer.eventemitter.on.md) instead. -> - -Add an event listener. - -Signature: - -```typescript -addListener(event: EventType, handler: Handler): EventEmitter; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| event | [EventType](./puppeteer.eventtype.md) | | -| handler | [Handler](./puppeteer.handler.md) | | - -Returns: - -[EventEmitter](./puppeteer.eventemitter.md) - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.eventemitter.emit.md b/website/versioned_docs/version-10.0.0/puppeteer.eventemitter.emit.md deleted file mode 100644 index 1db43ac7..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.eventemitter.emit.md +++ /dev/null @@ -1,27 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [EventEmitter](./puppeteer.eventemitter.md) > [emit](./puppeteer.eventemitter.emit.md) - -## EventEmitter.emit() method - -Emit an event and call any associated listeners. - -Signature: - -```typescript -emit(event: EventType, eventData?: unknown): boolean; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| event | [EventType](./puppeteer.eventtype.md) | the event you'd like to emit | -| eventData | unknown | any data you'd like to emit with the event | - -Returns: - -boolean - -`true` if there are any listeners, `false` if there are not. - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.eventemitter.listenercount.md b/website/versioned_docs/version-10.0.0/puppeteer.eventemitter.listenercount.md deleted file mode 100644 index 6b6d7792..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.eventemitter.listenercount.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [EventEmitter](./puppeteer.eventemitter.md) > [listenerCount](./puppeteer.eventemitter.listenercount.md) - -## EventEmitter.listenerCount() method - -Gets the number of listeners for a given event. - -Signature: - -```typescript -listenerCount(event: EventType): number; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| event | [EventType](./puppeteer.eventtype.md) | the event to get the listener count for | - -Returns: - -number - -the number of listeners bound to the given event - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.eventemitter.md b/website/versioned_docs/version-10.0.0/puppeteer.eventemitter.md deleted file mode 100644 index 634d9a56..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.eventemitter.md +++ /dev/null @@ -1,34 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [EventEmitter](./puppeteer.eventemitter.md) - -## EventEmitter class - -The EventEmitter class that many Puppeteer classes extend. - -Signature: - -```typescript -export declare class EventEmitter implements CommonEventEmitter -``` -Implements: [CommonEventEmitter](./puppeteer.commoneventemitter.md) - -## Remarks - -This allows you to listen to events that Puppeteer classes fire and act accordingly. Therefore you'll mostly use [on](./puppeteer.eventemitter.on.md) and [off](./puppeteer.eventemitter.off.md) to bind and unbind to event listeners. - -The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `EventEmitter` class. - -## Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [addListener(event, handler)](./puppeteer.eventemitter.addlistener.md) | | Add an event listener. | -| [emit(event, eventData)](./puppeteer.eventemitter.emit.md) | | Emit an event and call any associated listeners. | -| [listenerCount(event)](./puppeteer.eventemitter.listenercount.md) | | Gets the number of listeners for a given event. | -| [off(event, handler)](./puppeteer.eventemitter.off.md) | | Remove an event listener from firing. | -| [on(event, handler)](./puppeteer.eventemitter.on.md) | | Bind an event listener to fire when an event occurs. | -| [once(event, handler)](./puppeteer.eventemitter.once.md) | | Like on but the listener will only be fired once and then it will be removed. | -| [removeAllListeners(event)](./puppeteer.eventemitter.removealllisteners.md) | | Removes all listeners. If given an event argument, it will remove only listeners for that event. | -| [removeListener(event, handler)](./puppeteer.eventemitter.removelistener.md) | | Remove an event listener. | - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.eventemitter.off.md b/website/versioned_docs/version-10.0.0/puppeteer.eventemitter.off.md deleted file mode 100644 index 71578a24..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.eventemitter.off.md +++ /dev/null @@ -1,27 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [EventEmitter](./puppeteer.eventemitter.md) > [off](./puppeteer.eventemitter.off.md) - -## EventEmitter.off() method - -Remove an event listener from firing. - -Signature: - -```typescript -off(event: EventType, handler: Handler): EventEmitter; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| event | [EventType](./puppeteer.eventtype.md) | the event type you'd like to stop listening to. | -| handler | [Handler](./puppeteer.handler.md) | the function that should be removed. | - -Returns: - -[EventEmitter](./puppeteer.eventemitter.md) - -`this` to enable you to chain method calls. - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.eventemitter.on.md b/website/versioned_docs/version-10.0.0/puppeteer.eventemitter.on.md deleted file mode 100644 index d6bcf47a..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.eventemitter.on.md +++ /dev/null @@ -1,27 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [EventEmitter](./puppeteer.eventemitter.md) > [on](./puppeteer.eventemitter.on.md) - -## EventEmitter.on() method - -Bind an event listener to fire when an event occurs. - -Signature: - -```typescript -on(event: EventType, handler: Handler): EventEmitter; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| event | [EventType](./puppeteer.eventtype.md) | the event type you'd like to listen to. Can be a string or symbol. | -| handler | [Handler](./puppeteer.handler.md) | the function to be called when the event occurs. | - -Returns: - -[EventEmitter](./puppeteer.eventemitter.md) - -`this` to enable you to chain method calls. - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.eventemitter.once.md b/website/versioned_docs/version-10.0.0/puppeteer.eventemitter.once.md deleted file mode 100644 index 39cd7dd4..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.eventemitter.once.md +++ /dev/null @@ -1,27 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [EventEmitter](./puppeteer.eventemitter.md) > [once](./puppeteer.eventemitter.once.md) - -## EventEmitter.once() method - -Like `on` but the listener will only be fired once and then it will be removed. - -Signature: - -```typescript -once(event: EventType, handler: Handler): EventEmitter; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| event | [EventType](./puppeteer.eventtype.md) | the event you'd like to listen to | -| handler | [Handler](./puppeteer.handler.md) | the handler function to run when the event occurs | - -Returns: - -[EventEmitter](./puppeteer.eventemitter.md) - -`this` to enable you to chain method calls. - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.eventemitter.removealllisteners.md b/website/versioned_docs/version-10.0.0/puppeteer.eventemitter.removealllisteners.md deleted file mode 100644 index d03627c9..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.eventemitter.removealllisteners.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [EventEmitter](./puppeteer.eventemitter.md) > [removeAllListeners](./puppeteer.eventemitter.removealllisteners.md) - -## EventEmitter.removeAllListeners() method - -Removes all listeners. If given an event argument, it will remove only listeners for that event. - -Signature: - -```typescript -removeAllListeners(event?: EventType): EventEmitter; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| event | [EventType](./puppeteer.eventtype.md) | the event to remove listeners for. | - -Returns: - -[EventEmitter](./puppeteer.eventemitter.md) - -`this` to enable you to chain method calls. - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.eventemitter.removelistener.md b/website/versioned_docs/version-10.0.0/puppeteer.eventemitter.removelistener.md deleted file mode 100644 index c388eb33..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.eventemitter.removelistener.md +++ /dev/null @@ -1,30 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [EventEmitter](./puppeteer.eventemitter.md) > [removeListener](./puppeteer.eventemitter.removelistener.md) - -## EventEmitter.removeListener() method - -> Warning: This API is now obsolete. -> -> please use [EventEmitter.off()](./puppeteer.eventemitter.off.md) instead. -> - -Remove an event listener. - -Signature: - -```typescript -removeListener(event: EventType, handler: Handler): EventEmitter; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| event | [EventType](./puppeteer.eventtype.md) | | -| handler | [Handler](./puppeteer.handler.md) | | - -Returns: - -[EventEmitter](./puppeteer.eventemitter.md) - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.eventtype.md b/website/versioned_docs/version-10.0.0/puppeteer.eventtype.md deleted file mode 100644 index 81a51014..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.eventtype.md +++ /dev/null @@ -1,12 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [EventType](./puppeteer.eventtype.md) - -## EventType type - - -Signature: - -```typescript -export declare type EventType = string | symbol; -``` diff --git a/website/versioned_docs/version-10.0.0/puppeteer.executioncontext.evaluate.md b/website/versioned_docs/version-10.0.0/puppeteer.executioncontext.evaluate.md deleted file mode 100644 index e1e53281..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.executioncontext.evaluate.md +++ /dev/null @@ -1,64 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [ExecutionContext](./puppeteer.executioncontext.md) > [evaluate](./puppeteer.executioncontext.evaluate.md) - -## ExecutionContext.evaluate() method - -Signature: - -```typescript -evaluate(pageFunction: Function | string, ...args: unknown[]): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| pageFunction | Function \| string | a function to be evaluated in the executionContext | -| args | unknown\[\] | argument to pass to the page function | - -Returns: - -Promise<ReturnType> - -A promise that resolves to the return value of the given function. - -## Remarks - -If the function passed to the `executionContext.evaluate` returns a Promise, then `executionContext.evaluate` would wait for the promise to resolve and return its value. If the function passed to the `executionContext.evaluate` returns a non-serializable value, then `executionContext.evaluate` resolves to `undefined`. DevTools Protocol also supports transferring some additional values that are not serializable by `JSON`: `-0`, `NaN`, `Infinity`, `-Infinity`, and bigint literals. - -## Example 1 - - -```js -const executionContext = await page.mainFrame().executionContext(); -const result = await executionContext.evaluate(() => Promise.resolve(8 * 7))* ; -console.log(result); // prints "56" - -``` - -## Example 2 - -A string can also be passed in instead of a function. - -```js -console.log(await executionContext.evaluate('1 + 2')); // prints "3" - -``` - -## Example 3 - -[JSHandle](./puppeteer.jshandle.md) instances can be passed as arguments to the `executionContext.* evaluate`: - -```js -const oneHandle = await executionContext.evaluateHandle(() => 1); -const twoHandle = await executionContext.evaluateHandle(() => 2); -const result = await executionContext.evaluate( - (a, b) => a + b, oneHandle, * twoHandle -); -await oneHandle.dispose(); -await twoHandle.dispose(); -console.log(result); // prints '3'. - -``` - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.executioncontext.evaluatehandle.md b/website/versioned_docs/version-10.0.0/puppeteer.executioncontext.evaluatehandle.md deleted file mode 100644 index e8c9e3d4..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.executioncontext.evaluatehandle.md +++ /dev/null @@ -1,62 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [ExecutionContext](./puppeteer.executioncontext.md) > [evaluateHandle](./puppeteer.executioncontext.evaluatehandle.md) - -## ExecutionContext.evaluateHandle() method - -Signature: - -```typescript -evaluateHandle(pageFunction: EvaluateHandleFn, ...args: SerializableOrJSHandle[]): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| pageFunction | [EvaluateHandleFn](./puppeteer.evaluatehandlefn.md) | a function to be evaluated in the executionContext | -| args | [SerializableOrJSHandle](./puppeteer.serializableorjshandle.md)\[\] | argument to pass to the page function | - -Returns: - -Promise<HandleType> - -A promise that resolves to the return value of the given function as an in-page object (a [JSHandle](./puppeteer.jshandle.md)). - -## Remarks - -The only difference between `executionContext.evaluate` and `executionContext.evaluateHandle` is that `executionContext.evaluateHandle` returns an in-page object (a [JSHandle](./puppeteer.jshandle.md)). If the function passed to the `executionContext.evaluateHandle` returns a Promise, then `executionContext.evaluateHandle` would wait for the promise to resolve and return its value. - -## Example 1 - - -```js -const context = await page.mainFrame().executionContext(); -const aHandle = await context.evaluateHandle(() => Promise.resolve(self)); -aHandle; // Handle for the global object. - -``` - -## Example 2 - -A string can also be passed in instead of a function. - -```js -// Handle for the '3' * object. -const aHandle = await context.evaluateHandle('1 + 2'); - -``` - -## Example 3 - -JSHandle instances can be passed as arguments to the `executionContext.* evaluateHandle`: - -```js -const aHandle = await context.evaluateHandle(() => document.body); -const resultHandle = await context.evaluateHandle(body => body.innerHTML, * aHandle); -console.log(await resultHandle.jsonValue()); // prints body's innerHTML -await aHandle.dispose(); -await resultHandle.dispose(); - -``` - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.executioncontext.frame.md b/website/versioned_docs/version-10.0.0/puppeteer.executioncontext.frame.md deleted file mode 100644 index be7d61d4..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.executioncontext.frame.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [ExecutionContext](./puppeteer.executioncontext.md) > [frame](./puppeteer.executioncontext.frame.md) - -## ExecutionContext.frame() method - -Signature: - -```typescript -frame(): Frame | null; -``` -Returns: - -[Frame](./puppeteer.frame.md) \| null - -The frame associated with this execution context. - -## Remarks - -Not every execution context is associated with a frame. For example, workers and extensions have execution contexts that are not associated with frames. - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.executioncontext.md b/website/versioned_docs/version-10.0.0/puppeteer.executioncontext.md deleted file mode 100644 index 88699a5d..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.executioncontext.md +++ /dev/null @@ -1,29 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [ExecutionContext](./puppeteer.executioncontext.md) - -## ExecutionContext class - -This class represents a context for JavaScript execution. A \[Page\] might have many execution contexts: - each [frame](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/iframe) has "default" execution context that is always created after frame is attached to DOM. This context is returned by the [Frame.executionContext()](./puppeteer.frame.executioncontext.md) method. - [Extension](https://developer.chrome.com/extensions)'s content scripts create additional execution contexts. - -Besides pages, execution contexts can be found in [workers](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API). - -Signature: - -```typescript -export declare class ExecutionContext -``` - -## Remarks - -The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `ExecutionContext` class. - -## Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [evaluate(pageFunction, args)](./puppeteer.executioncontext.evaluate.md) | | | -| [evaluateHandle(pageFunction, args)](./puppeteer.executioncontext.evaluatehandle.md) | | | -| [frame()](./puppeteer.executioncontext.frame.md) | | | -| [queryObjects(prototypeHandle)](./puppeteer.executioncontext.queryobjects.md) | | This method iterates the JavaScript heap and finds all the objects with the given prototype. | - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.executioncontext.queryobjects.md b/website/versioned_docs/version-10.0.0/puppeteer.executioncontext.queryobjects.md deleted file mode 100644 index abeea9c3..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.executioncontext.queryobjects.md +++ /dev/null @@ -1,46 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [ExecutionContext](./puppeteer.executioncontext.md) > [queryObjects](./puppeteer.executioncontext.queryobjects.md) - -## ExecutionContext.queryObjects() method - -This method iterates the JavaScript heap and finds all the objects with the given prototype. - -Signature: - -```typescript -queryObjects(prototypeHandle: JSHandle): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| prototypeHandle | [JSHandle](./puppeteer.jshandle.md) | a handle to the object prototype | - -Returns: - -Promise<[JSHandle](./puppeteer.jshandle.md)> - -A handle to an array of objects with the given prototype. - -## Remarks - - -## Example - - -```js -// 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(); - -``` - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.filechooser.accept.md b/website/versioned_docs/version-10.0.0/puppeteer.filechooser.accept.md deleted file mode 100644 index 173ec7c6..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.filechooser.accept.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [FileChooser](./puppeteer.filechooser.md) > [accept](./puppeteer.filechooser.accept.md) - -## FileChooser.accept() method - -Accept the file chooser request with given paths. - -Signature: - -```typescript -accept(filePaths: string[]): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| filePaths | string\[\] | If some of the filePaths are relative paths, then they are resolved relative to the [current working directory](https://nodejs.org/api/process.html#process_process_cwd). | - -Returns: - -Promise<void> - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.filechooser.cancel.md b/website/versioned_docs/version-10.0.0/puppeteer.filechooser.cancel.md deleted file mode 100644 index 6e557e07..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.filechooser.cancel.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [FileChooser](./puppeteer.filechooser.md) > [cancel](./puppeteer.filechooser.cancel.md) - -## FileChooser.cancel() method - -Closes the file chooser without selecting any files. - -Signature: - -```typescript -cancel(): void; -``` -Returns: - -void - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.filechooser.ismultiple.md b/website/versioned_docs/version-10.0.0/puppeteer.filechooser.ismultiple.md deleted file mode 100644 index 58e54a02..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.filechooser.ismultiple.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [FileChooser](./puppeteer.filechooser.md) > [isMultiple](./puppeteer.filechooser.ismultiple.md) - -## FileChooser.isMultiple() method - -Whether file chooser allow for [multiple](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/file#attr-multiple) file selection. - -Signature: - -```typescript -isMultiple(): boolean; -``` -Returns: - -boolean - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.filechooser.md b/website/versioned_docs/version-10.0.0/puppeteer.filechooser.md deleted file mode 100644 index 77738b1a..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.filechooser.md +++ /dev/null @@ -1,42 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [FileChooser](./puppeteer.filechooser.md) - -## FileChooser class - -File choosers let you react to the page requesting for a file. - -Signature: - -```typescript -export declare class FileChooser -``` - -## Remarks - -`FileChooser` objects are returned via the `page.waitForFileChooser` method. - -The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `FileChooser` class. - -## Example - -An example of using `FileChooser`: - -```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\*\* In browsers, only one file chooser can be opened at a time. All file choosers must be accepted or canceled. Not doing so will prevent subsequent file choosers from appearing. - -## Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [accept(filePaths)](./puppeteer.filechooser.accept.md) | | Accept the file chooser request with given paths. | -| [cancel()](./puppeteer.filechooser.cancel.md) | | Closes the file chooser without selecting any files. | -| [isMultiple()](./puppeteer.filechooser.ismultiple.md) | | Whether file chooser allow for [multiple](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/file#attr-multiple) file selection. | - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.frame._.md b/website/versioned_docs/version-10.0.0/puppeteer.frame._.md deleted file mode 100644 index 8250f209..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.frame._.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [Frame](./puppeteer.frame.md) > [$](./puppeteer.frame._.md) - -## Frame.$() method - -This method queries the frame for the given selector. - -Signature: - -```typescript -$(selector: string): Promise | null>; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| selector | string | a selector to query for. | - -Returns: - -Promise<[ElementHandle](./puppeteer.elementhandle.md)<T> \| null> - -A promise which resolves to an `ElementHandle` pointing at the element, or `null` if it was not found. - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.frame.__.md b/website/versioned_docs/version-10.0.0/puppeteer.frame.__.md deleted file mode 100644 index 32b33da9..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.frame.__.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [Frame](./puppeteer.frame.md) > [$$](./puppeteer.frame.__.md) - -## Frame.$$() method - -This runs `document.querySelectorAll` in the frame and returns the result. - -Signature: - -```typescript -$$(selector: string): Promise>>; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| selector | string | a selector to search for | - -Returns: - -Promise<Array<[ElementHandle](./puppeteer.elementhandle.md)<T>>> - -An array of element handles pointing to the found frame elements. - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.frame.__eval.md b/website/versioned_docs/version-10.0.0/puppeteer.frame.__eval.md deleted file mode 100644 index 909b8510..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.frame.__eval.md +++ /dev/null @@ -1,38 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [Frame](./puppeteer.frame.md) > [$$eval](./puppeteer.frame.__eval.md) - -## Frame.$$eval() method - -Signature: - -```typescript -$$eval(selector: string, pageFunction: (elements: Element[], ...args: unknown[]) => ReturnType | Promise, ...args: SerializableOrJSHandle[]): Promise>; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| selector | string | the selector to query for | -| pageFunction | (elements: Element\[\], ...args: unknown\[\]) => ReturnType \| Promise<ReturnType> | the function to be evaluated in the frame's context | -| args | [SerializableOrJSHandle](./puppeteer.serializableorjshandle.md)\[\] | additional arguments to pass to pageFunction | - -Returns: - -Promise<[WrapElementHandle](./puppeteer.wrapelementhandle.md)<ReturnType>> - -## Remarks - -This method runs `Array.from(document.querySelectorAll(selector))` within the frame and passes it as the first argument to `pageFunction`. - -If `pageFunction` returns a Promise, then `frame.$$eval` would wait for the promise to resolve and return its value. - -## Example - - -```js -const divsCounts = await frame.$$eval('div', divs => divs.length); - -``` - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.frame._eval.md b/website/versioned_docs/version-10.0.0/puppeteer.frame._eval.md deleted file mode 100644 index 32da2b07..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.frame._eval.md +++ /dev/null @@ -1,38 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [Frame](./puppeteer.frame.md) > [$eval](./puppeteer.frame._eval.md) - -## Frame.$eval() method - -Signature: - -```typescript -$eval(selector: string, pageFunction: (element: Element, ...args: unknown[]) => ReturnType | Promise, ...args: SerializableOrJSHandle[]): Promise>; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| selector | string | the selector to query for | -| pageFunction | (element: Element, ...args: unknown\[\]) => ReturnType \| Promise<ReturnType> | the function to be evaluated in the frame's context | -| args | [SerializableOrJSHandle](./puppeteer.serializableorjshandle.md)\[\] | additional arguments to pass to pageFunction | - -Returns: - -Promise<[WrapElementHandle](./puppeteer.wrapelementhandle.md)<ReturnType>> - -## Remarks - -This method runs `document.querySelector` within the frame and passes it as the first argument to `pageFunction`. - -If `pageFunction` returns a Promise, then `frame.$eval` would wait for the promise to resolve and return its value. - -## Example - - -```js -const searchValue = await frame.$eval('#search', el => el.value); - -``` - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.frame._x.md b/website/versioned_docs/version-10.0.0/puppeteer.frame._x.md deleted file mode 100644 index dc07d590..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.frame._x.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [Frame](./puppeteer.frame.md) > [$x](./puppeteer.frame._x.md) - -## Frame.$x() method - -This method evaluates the given XPath expression and returns the results. - -Signature: - -```typescript -$x(expression: string): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| expression | string | the XPath expression to evaluate. | - -Returns: - -Promise<[ElementHandle](./puppeteer.elementhandle.md)\[\]> - diff --git a/website/versioned_docs/version-10.0.0/puppeteer.frame.addscripttag.md b/website/versioned_docs/version-10.0.0/puppeteer.frame.addscripttag.md deleted file mode 100644 index 658a6fa8..00000000 --- a/website/versioned_docs/version-10.0.0/puppeteer.frame.addscripttag.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [Frame](./puppeteer.frame.md) > [addScriptTag](./puppeteer.frame.addscripttag.md) - -## Frame.addScriptTag() method - -Adds a `