{ "metadata": { "toolPackage": "@microsoft/api-extractor", "toolVersion": "7.33.7", "schemaVersion": 1010, "oldestForwardsCompatibleVersion": 1001, "tsdocConfig": { "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", "noStandardTags": true, "tagDefinitions": [ { "tagName": "@alpha", "syntaxKind": "modifier" }, { "tagName": "@beta", "syntaxKind": "modifier" }, { "tagName": "@defaultValue", "syntaxKind": "block" }, { "tagName": "@decorator", "syntaxKind": "block", "allowMultiple": true }, { "tagName": "@deprecated", "syntaxKind": "block" }, { "tagName": "@eventProperty", "syntaxKind": "modifier" }, { "tagName": "@example", "syntaxKind": "block", "allowMultiple": true }, { "tagName": "@experimental", "syntaxKind": "modifier" }, { "tagName": "@inheritDoc", "syntaxKind": "inline" }, { "tagName": "@internal", "syntaxKind": "modifier" }, { "tagName": "@label", "syntaxKind": "inline" }, { "tagName": "@link", "syntaxKind": "inline", "allowMultiple": true }, { "tagName": "@override", "syntaxKind": "modifier" }, { "tagName": "@packageDocumentation", "syntaxKind": "modifier" }, { "tagName": "@param", "syntaxKind": "block", "allowMultiple": true }, { "tagName": "@privateRemarks", "syntaxKind": "block" }, { "tagName": "@public", "syntaxKind": "modifier" }, { "tagName": "@readonly", "syntaxKind": "modifier" }, { "tagName": "@remarks", "syntaxKind": "block" }, { "tagName": "@returns", "syntaxKind": "block" }, { "tagName": "@sealed", "syntaxKind": "modifier" }, { "tagName": "@see", "syntaxKind": "block" }, { "tagName": "@throws", "syntaxKind": "block", "allowMultiple": true }, { "tagName": "@typeParam", "syntaxKind": "block", "allowMultiple": true }, { "tagName": "@virtual", "syntaxKind": "modifier" }, { "tagName": "@betaDocumentation", "syntaxKind": "modifier" }, { "tagName": "@internalRemarks", "syntaxKind": "block" }, { "tagName": "@preapproved", "syntaxKind": "modifier" } ], "supportForTags": { "@alpha": true, "@beta": true, "@defaultValue": true, "@decorator": true, "@deprecated": true, "@eventProperty": true, "@example": true, "@experimental": true, "@inheritDoc": true, "@internal": true, "@label": true, "@link": true, "@override": true, "@packageDocumentation": true, "@param": true, "@privateRemarks": true, "@public": true, "@readonly": true, "@remarks": true, "@returns": true, "@sealed": true, "@see": true, "@throws": true, "@typeParam": true, "@virtual": true, "@betaDocumentation": true, "@internalRemarks": true, "@preapproved": true }, "reportUnsupportedHtmlElements": false } }, "kind": "Package", "canonicalReference": "puppeteer-core!", "docComment": "", "name": "puppeteer-core", "preserveMemberOrder": false, "members": [ { "kind": "EntryPoint", "canonicalReference": "puppeteer-core!", "name": "", "preserveMemberOrder": false, "members": [ { "kind": "Class", "canonicalReference": "puppeteer-core!Accessibility:class", "docComment": "/**\n * The Accessibility class provides methods for inspecting Chromium's accessibility tree. The accessibility tree is used by assistive technology such as {@link https://en.wikipedia.org/wiki/Screen_reader | screen readers} or {@link https://en.wikipedia.org/wiki/Switch_access | switches}.\n *\n * @remarks\n *\n * Accessibility is a very platform-specific thing. On different platforms, there are different screen readers that might have wildly different output.\n *\n * 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.\n *\n * 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.\n *\n * 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.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class Accessibility " } ], "fileUrlPath": "src/common/Accessibility.ts", "releaseTag": "Public", "name": "Accessibility", "preserveMemberOrder": false, "members": [ { "kind": "Method", "canonicalReference": "puppeteer-core!Accessibility#snapshot:member(1)", "docComment": "/**\n * Captures the current state of the accessibility tree. The returned object represents the root accessible node of the page.\n *\n * @remarks\n *\n * **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`.\n *\n * @returns An AXNode object representing the snapshot.\n *\n * @example\n *\n * An example of dumping the entire accessibility tree:\n * ```ts\n * const snapshot = await page.accessibility.snapshot();\n * console.log(snapshot);\n * ```\n *\n * @example\n *\n * An example of logging the focused node's name:\n * ```ts\n * const snapshot = await page.accessibility.snapshot();\n * const node = findFocusedNode(snapshot);\n * console.log(node && node.name);\n *\n * function findFocusedNode(node) {\n * if (node.focused) return node;\n * for (const child of node.children || []) {\n * const foundNode = findFocusedNode(child);\n * return foundNode;\n * }\n * return null;\n * }\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", "text": "snapshot(options?: " }, { "kind": "Reference", "text": "SnapshotOptions", "canonicalReference": "puppeteer-core!SnapshotOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "SerializedAXNode", "canonicalReference": "puppeteer-core!SerializedAXNode:interface" }, { "kind": "Content", "text": " | null>" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 7 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true } ], "isOptional": false, "name": "snapshot" } ], "implementsTokenRanges": [] }, { "kind": "TypeAlias", "canonicalReference": "puppeteer-core!ActionResult:type", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type ActionResult = " }, { "kind": "Content", "text": "'continue' | 'abort' | 'respond'" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/common/HTTPRequest.ts", "releaseTag": "Public", "name": "ActionResult", "typeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "TypeAlias", "canonicalReference": "puppeteer-core!Awaitable:type", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type Awaitable = " }, { "kind": "Content", "text": "T | " }, { "kind": "Reference", "text": "PromiseLike", "canonicalReference": "!PromiseLike:interface" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/common/types.ts", "releaseTag": "Public", "name": "Awaitable", "typeParameters": [ { "typeParameterName": "T", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "typeTokenRange": { "startIndex": 1, "endIndex": 4 } }, { "kind": "Interface", "canonicalReference": "puppeteer-core!BoundingBox:interface", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface BoundingBox extends " }, { "kind": "Reference", "text": "Point", "canonicalReference": "puppeteer-core!Point:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/common/JSHandle.ts", "releaseTag": "Public", "name": "BoundingBox", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "puppeteer-core!BoundingBox#height:member", "docComment": "/**\n * the height of the element in pixels.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "height: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "height", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "puppeteer-core!BoundingBox#width:member", "docComment": "/**\n * the width of the element in pixels.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "width: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "width", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "puppeteer-core!BoxModel:interface", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface BoxModel " } ], "fileUrlPath": "src/common/JSHandle.ts", "releaseTag": "Public", "name": "BoxModel", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "puppeteer-core!BoxModel#border:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "border: " }, { "kind": "Reference", "text": "Point", "canonicalReference": "puppeteer-core!Point:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "border", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "puppeteer-core!BoxModel#content:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "content: " }, { "kind": "Reference", "text": "Point", "canonicalReference": "puppeteer-core!Point:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "content", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "puppeteer-core!BoxModel#height:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "height: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "height", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "puppeteer-core!BoxModel#margin:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "margin: " }, { "kind": "Reference", "text": "Point", "canonicalReference": "puppeteer-core!Point:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "margin", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "puppeteer-core!BoxModel#padding:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "padding: " }, { "kind": "Reference", "text": "Point", "canonicalReference": "puppeteer-core!Point:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "padding", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "puppeteer-core!BoxModel#width:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "width: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "width", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "puppeteer-core!Browser:class", "docComment": "/**\n * A Browser is created when Puppeteer connects to a Chromium instance, either through {@link PuppeteerNode.launch} or {@link Puppeteer.connect}.\n *\n * @remarks\n *\n * The Browser class extends from Puppeteer's {@link EventEmitter} class and will emit various events which are documented in the {@link BrowserEmittedEvents} enum.\n *\n * 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.\n *\n * @example\n *\n * An example of using a {@link Browser} to create a {@link Page}:\n * ```ts\n * import puppeteer from 'puppeteer';\n *\n * (async () => {\n * const browser = await puppeteer.launch();\n * const page = await browser.newPage();\n * await page.goto('https://example.com');\n * await browser.close();\n * })();\n * ```\n *\n * @example\n *\n * An example of disconnecting from and reconnecting to a {@link Browser}:\n * ```ts\n * import puppeteer from 'puppeteer';\n *\n * (async () => {\n * const browser = await puppeteer.launch();\n * // Store the endpoint to be able to reconnect to Chromium\n * const browserWSEndpoint = browser.wsEndpoint();\n * // Disconnect puppeteer from Chromium\n * browser.disconnect();\n *\n * // Use the endpoint to reestablish a connection\n * const browser2 = await puppeteer.connect({browserWSEndpoint});\n * // Close Chromium\n * await browser2.close();\n * })();\n * ```\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class Browser extends " }, { "kind": "Reference", "text": "EventEmitter", "canonicalReference": "puppeteer-core!EventEmitter:class" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/api/Browser.ts", "releaseTag": "Public", "name": "Browser", "preserveMemberOrder": false, "members": [ { "kind": "Method", "canonicalReference": "puppeteer-core!Browser#browserContexts:member(1)", "docComment": "/**\n * Returns an array of all open browser contexts. In a newly created browser, this will return a single instance of {@link BrowserContext}.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "browserContexts(): " }, { "kind": "Reference", "text": "BrowserContext", "canonicalReference": "puppeteer-core!BrowserContext:class" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "name": "browserContexts" }, { "kind": "Method", "canonicalReference": "puppeteer-core!Browser#close:member(1)", "docComment": "/**\n * Closes Chromium and all of its pages (if any were opened). The {@link Browser} object itself is considered to be disposed and cannot be used anymore.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "close(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "name": "close" }, { "kind": "Method", "canonicalReference": "puppeteer-core!Browser#createIncognitoBrowserContext:member(1)", "docComment": "/**\n * Creates a new incognito browser context. This won't share cookies/cache with other browser contexts.\n *\n * @example\n * ```ts\n * (async () => {\n * const browser = await puppeteer.launch();\n * // Create a new incognito browser context.\n * const context = await browser.createIncognitoBrowserContext();\n * // Create a new page in a pristine context.\n * const page = await context.newPage();\n * // Do stuff\n * await page.goto('https://example.com');\n * })();\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", "text": "createIncognitoBrowserContext(options?: " }, { "kind": "Reference", "text": "BrowserContextOptions", "canonicalReference": "puppeteer-core!BrowserContextOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "BrowserContext", "canonicalReference": "puppeteer-core!BrowserContext:class" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 7 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true } ], "isOptional": false, "name": "createIncognitoBrowserContext" }, { "kind": "Method", "canonicalReference": "puppeteer-core!Browser#defaultBrowserContext:member(1)", "docComment": "/**\n * Returns the default browser context. The default browser context cannot be closed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "defaultBrowserContext(): " }, { "kind": "Reference", "text": "BrowserContext", "canonicalReference": "puppeteer-core!BrowserContext:class" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "name": "defaultBrowserContext" }, { "kind": "Method", "canonicalReference": "puppeteer-core!Browser#disconnect:member(1)", "docComment": "/**\n * Disconnects Puppeteer from the browser, but leaves the Chromium process running. After calling `disconnect`, the {@link Browser} object is considered disposed and cannot be used anymore.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "disconnect(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "name": "disconnect" }, { "kind": "Method", "canonicalReference": "puppeteer-core!Browser#isConnected:member(1)", "docComment": "/**\n * Indicates that the browser is connected.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isConnected(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "name": "isConnected" }, { "kind": "Method", "canonicalReference": "puppeteer-core!Browser#newPage:member(1)", "docComment": "/**\n * Promise which resolves to a new {@link Page} object. The Page is created in a default browser context.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "newPage(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Page", "canonicalReference": "puppeteer-core!Page:class" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "name": "newPage" }, { "kind": "Method", "canonicalReference": "puppeteer-core!Browser#pages:member(1)", "docComment": "/**\n * An array of all open pages inside the Browser.\n *\n * @remarks\n *\n * 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 {@link Target.page}.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "pages(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Page", "canonicalReference": "puppeteer-core!Page:class" }, { "kind": "Content", "text": "[]>" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "name": "pages" }, { "kind": "Method", "canonicalReference": "puppeteer-core!Browser#process:member(1)", "docComment": "/**\n * The spawned browser process. Returns `null` if the browser instance was created with {@link Puppeteer.connect}.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "process(): " }, { "kind": "Reference", "text": "ChildProcess", "canonicalReference": "!\"\\\"child_process\\\"\".ChildProcess:class" }, { "kind": "Content", "text": " | null" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "name": "process" }, { "kind": "Method", "canonicalReference": "puppeteer-core!Browser#target:member(1)", "docComment": "/**\n * The target associated with the browser.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "target(): " }, { "kind": "Reference", "text": "Target", "canonicalReference": "puppeteer-core!Target:class" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "name": "target" }, { "kind": "Method", "canonicalReference": "puppeteer-core!Browser#targets:member(1)", "docComment": "/**\n * All active targets inside the Browser. In case of multiple browser contexts, returns an array with all the targets in all browser contexts.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "targets(): " }, { "kind": "Reference", "text": "Target", "canonicalReference": "puppeteer-core!Target:class" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "name": "targets" }, { "kind": "Method", "canonicalReference": "puppeteer-core!Browser#userAgent:member(1)", "docComment": "/**\n * The browser's original user agent. Pages can override the browser user agent with {@link Page.setUserAgent}.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "userAgent(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "name": "userAgent" }, { "kind": "Method", "canonicalReference": "puppeteer-core!Browser#version:member(1)", "docComment": "/**\n * A string representing the browser name and version.\n *\n * @remarks\n *\n * For headless Chromium, this is similar to `HeadlessChrome/61.0.3153.0`. For non-headless, this is similar to `Chrome/61.0.3153.0`.\n *\n * The format of browser.version() might change with future releases of Chromium.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "version(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "name": "version" }, { "kind": "Method", "canonicalReference": "puppeteer-core!Browser#waitForTarget:member(1)", "docComment": "/**\n * Searches for a target in all browser contexts.\n *\n * @param predicate - A function to be run for every target.\n *\n * @returns The first target found that matches the `predicate` function.\n *\n * @example\n *\n * An example of finding a target for a page opened via `window.open`:\n * ```ts\n * await page.evaluate(() => window.open('https://www.example.com/'));\n * const newWindowTarget = await browser.waitForTarget(\n * target => target.url() === 'https://www.example.com/'\n * );\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", "text": "waitForTarget(predicate: " }, { "kind": "Content", "text": "(x: " }, { "kind": "Reference", "text": "Target", "canonicalReference": "puppeteer-core!Target:class" }, { "kind": "Content", "text": ") => boolean | " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ", options?: " }, { "kind": "Reference", "text": "WaitForTargetOptions", "canonicalReference": "puppeteer-core!WaitForTargetOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Target", "canonicalReference": "puppeteer-core!Target:class" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 13 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "predicate", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 6 }, "isOptional": false }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "isOptional": true } ], "isOptional": false, "name": "waitForTarget" }, { "kind": "Method", "canonicalReference": "puppeteer-core!Browser#wsEndpoint:member(1)", "docComment": "/**\n * The browser websocket endpoint which can be used as an argument to {@link Puppeteer.connect}.\n *\n * @remarks\n *\n * The format is `ws://${host}:${port}/devtools/browser/`.\n *\n * You can find the `webSocketDebuggerUrl` from `http://${host}:${port}/json/version`. Learn more about the {@link https://chromedevtools.github.io/devtools-protocol | devtools protocol} and the {@link https://chromedevtools.github.io/devtools-protocol/#how-do-i-access-the-browser-target | browser endpoint}.\n *\n * @returns The Browser websocket url.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "wsEndpoint(): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "name": "wsEndpoint" } ], "extendsTokenRange": { "startIndex": 1, "endIndex": 2 }, "implementsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "puppeteer-core!BrowserConnectOptions:interface", "docComment": "/**\n * Generic browser options that can be passed when launching any browser or when connecting to an existing browser instance.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface BrowserConnectOptions " } ], "fileUrlPath": "src/common/BrowserConnector.ts", "releaseTag": "Public", "name": "BrowserConnectOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "puppeteer-core!BrowserConnectOptions#defaultViewport:member", "docComment": "/**\n * Sets the viewport for each page.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "defaultViewport?: " }, { "kind": "Reference", "text": "Viewport", "canonicalReference": "puppeteer-core!Viewport:interface" }, { "kind": "Content", "text": " | null" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "defaultViewport", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "puppeteer-core!BrowserConnectOptions#ignoreHTTPSErrors:member", "docComment": "/**\n * Whether to ignore HTTPS errors during navigation.\n *\n * @defaultValue\n *\n * false\n */\n", "excerptTokens": [ { "kind": "Content", "text": "ignoreHTTPSErrors?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "ignoreHTTPSErrors", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "puppeteer-core!BrowserConnectOptions#slowMo:member", "docComment": "/**\n * Slows down Puppeteer operations by the specified amount of milliseconds to aid debugging.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "slowMo?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "slowMo", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "puppeteer-core!BrowserConnectOptions#targetFilter:member", "docComment": "/**\n * Callback to decide if Puppeteer should connect to a given target or not.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "targetFilter?: " }, { "kind": "Reference", "text": "TargetFilterCallback", "canonicalReference": "puppeteer-core!TargetFilterCallback:type" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "targetFilter", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "puppeteer-core!BrowserContext:class", "docComment": "/**\n * 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 {@link Browser.newPage | Browser.newPage} creates a page in the default browser context.\n *\n * @remarks\n *\n * The Browser class extends from Puppeteer's {@link EventEmitter} class and will emit various events which are documented in the {@link BrowserContextEmittedEvents} enum.\n *\n * If a page opens another page, e.g. with a `window.open` call, the popup will belong to the parent page's browser context.\n *\n * Puppeteer allows creation of \"incognito\" browser contexts with {@link Browser.createIncognitoBrowserContext | Browser.createIncognitoBrowserContext} method. \"Incognito\" browser contexts don't write any browsing data to disk.\n *\n * 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.\n *\n * @example\n * ```ts\n * // Create a new incognito browser context\n * const context = await browser.createIncognitoBrowserContext();\n * // Create a new page inside context.\n * const page = await context.newPage();\n * // ... do stuff with page ...\n * await page.goto('https://example.com');\n * // Dispose context once it's no longer needed.\n * await context.close();\n * ```\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class BrowserContext extends " }, { "kind": "Reference", "text": "EventEmitter", "canonicalReference": "puppeteer-core!EventEmitter:class" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/api/BrowserContext.ts", "releaseTag": "Public", "name": "BrowserContext", "preserveMemberOrder": false, "members": [ { "kind": "Method", "canonicalReference": "puppeteer-core!BrowserContext#browser:member(1)", "docComment": "/**\n * The browser this browser context belongs to.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "browser(): " }, { "kind": "Reference", "text": "Browser", "canonicalReference": "puppeteer-core!Browser:class" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "name": "browser" }, { "kind": "Method", "canonicalReference": "puppeteer-core!BrowserContext#clearPermissionOverrides:member(1)", "docComment": "/**\n * Clears all permission overrides for the browser context.\n *\n * @example\n * ```ts\n * const context = browser.defaultBrowserContext();\n * context.overridePermissions('https://example.com', ['clipboard-read']);\n * // do stuff ..\n * context.clearPermissionOverrides();\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", "text": "clearPermissionOverrides(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "name": "clearPermissionOverrides" }, { "kind": "Method", "canonicalReference": "puppeteer-core!BrowserContext#close:member(1)", "docComment": "/**\n * Closes the browser context. All the targets that belong to the browser context will be closed.\n *\n * @remarks\n *\n * Only incognito browser contexts can be closed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "close(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "name": "close" }, { "kind": "Property", "canonicalReference": "puppeteer-core!BrowserContext#id:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "get id(): " }, { "kind": "Content", "text": "string | undefined" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "id", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false }, { "kind": "Method", "canonicalReference": "puppeteer-core!BrowserContext#isIncognito:member(1)", "docComment": "/**\n * Returns whether BrowserContext is incognito. The default browser context is the only non-incognito browser context.\n *\n * @remarks\n *\n * The default browser context cannot be closed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isIncognito(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "name": "isIncognito" }, { "kind": "Method", "canonicalReference": "puppeteer-core!BrowserContext#newPage:member(1)", "docComment": "/**\n * Creates a new page in the browser context.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "newPage(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Page", "canonicalReference": "puppeteer-core!Page:class" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "name": "newPage" }, { "kind": "Method", "canonicalReference": "puppeteer-core!BrowserContext#overridePermissions:member(1)", "docComment": "/**\n * @param origin - The origin to grant permissions to, e.g. \"https://example.com\".\n *\n * @param permissions - An array of permissions to grant. All permissions that are not listed here will be automatically denied.\n *\n * @example\n * ```ts\n * const context = browser.defaultBrowserContext();\n * await context.overridePermissions('https://html5demos.com', [\n * 'geolocation',\n * ]);\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", "text": "overridePermissions(origin: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", permissions: " }, { "kind": "Reference", "text": "Permission", "canonicalReference": "puppeteer-core!Permission:type" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 6, "endIndex": 8 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "origin", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "permissions", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "isOptional": false } ], "isOptional": false, "name": "overridePermissions" }, { "kind": "Method", "canonicalReference": "puppeteer-core!BrowserContext#pages:member(1)", "docComment": "/**\n * An array of all pages inside the browser context.\n *\n * @returns 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 {@link Target.page | the target page}.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "pages(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Page", "canonicalReference": "puppeteer-core!Page:class" }, { "kind": "Content", "text": "[]>" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "name": "pages" }, { "kind": "Method", "canonicalReference": "puppeteer-core!BrowserContext#targets:member(1)", "docComment": "/**\n * An array of all active targets inside the browser context.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "targets(): " }, { "kind": "Reference", "text": "Target", "canonicalReference": "puppeteer-core!Target:class" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "name": "targets" }, { "kind": "Method", "canonicalReference": "puppeteer-core!BrowserContext#waitForTarget:member(1)", "docComment": "/**\n * This searches for a target in this specific browser context.\n *\n * @param predicate - A function to be run for every target\n *\n * @param options - An object of options. Accepts a timeout, which is the maximum wait time in milliseconds. Pass `0` to disable the timeout. Defaults to 30 seconds.\n *\n * @returns Promise which resolves to the first target found that matches the `predicate` function.\n *\n * @example\n *\n * An example of finding a target for a page opened via `window.open`:\n * ```ts\n * await page.evaluate(() => window.open('https://www.example.com/'));\n * const newWindowTarget = await browserContext.waitForTarget(\n * target => target.url() === 'https://www.example.com/'\n * );\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", "text": "waitForTarget(predicate: " }, { "kind": "Content", "text": "(x: " }, { "kind": "Reference", "text": "Target", "canonicalReference": "puppeteer-core!Target:class" }, { "kind": "Content", "text": ") => boolean | " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ", options?: " }, { "kind": "Content", "text": "{\n timeout?: number;\n }" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Target", "canonicalReference": "puppeteer-core!Target:class" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 13 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "predicate", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 6 }, "isOptional": false }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "isOptional": true } ], "isOptional": false, "name": "waitForTarget" } ], "extendsTokenRange": { "startIndex": 1, "endIndex": 2 }, "implementsTokenRanges": [] }, { "kind": "Enum", "canonicalReference": "puppeteer-core!BrowserContextEmittedEvents:enum", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare const enum BrowserContextEmittedEvents " } ], "fileUrlPath": "src/api/Browser.ts", "releaseTag": "Public", "name": "BrowserContextEmittedEvents", "preserveMemberOrder": false, "members": [ { "kind": "EnumMember", "canonicalReference": "puppeteer-core!BrowserContextEmittedEvents.TargetChanged:member", "docComment": "/**\n * Emitted when the url of a target inside the browser context changes. Contains a {@link Target} instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "TargetChanged = " }, { "kind": "Content", "text": "\"targetchanged\"" } ], "initializerTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "name": "TargetChanged" }, { "kind": "EnumMember", "canonicalReference": "puppeteer-core!BrowserContextEmittedEvents.TargetCreated:member", "docComment": "/**\n * Emitted when a target is created within the browser context, for example when a new page is opened by {@link https://developer.mozilla.org/en-US/docs/Web/API/Window/open | window.open} or by {@link BrowserContext.newPage | browserContext.newPage}\n *\n * Contains a {@link Target} instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "TargetCreated = " }, { "kind": "Content", "text": "\"targetcreated\"" } ], "initializerTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "name": "TargetCreated" }, { "kind": "EnumMember", "canonicalReference": "puppeteer-core!BrowserContextEmittedEvents.TargetDestroyed:member", "docComment": "/**\n * Emitted when a target is destroyed within the browser context, for example when a page is closed. Contains a {@link Target} instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "TargetDestroyed = " }, { "kind": "Content", "text": "\"targetdestroyed\"" } ], "initializerTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "name": "TargetDestroyed" } ] }, { "kind": "Interface", "canonicalReference": "puppeteer-core!BrowserContextOptions:interface", "docComment": "/**\n * BrowserContext options.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface BrowserContextOptions " } ], "fileUrlPath": "src/api/Browser.ts", "releaseTag": "Public", "name": "BrowserContextOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "puppeteer-core!BrowserContextOptions#proxyBypassList:member", "docComment": "/**\n * Bypass the proxy for the given list of hosts.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "proxyBypassList?: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "proxyBypassList", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "puppeteer-core!BrowserContextOptions#proxyServer:member", "docComment": "/**\n * Proxy server with optional port to use for all requests. Username and password can be set in `Page.authenticate`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "proxyServer?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "proxyServer", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Enum", "canonicalReference": "puppeteer-core!BrowserEmittedEvents:enum", "docComment": "/**\n * All the events a {@link Browser | browser instance} may emit.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare const enum BrowserEmittedEvents " } ], "fileUrlPath": "src/api/Browser.ts", "releaseTag": "Public", "name": "BrowserEmittedEvents", "preserveMemberOrder": false, "members": [ { "kind": "EnumMember", "canonicalReference": "puppeteer-core!BrowserEmittedEvents.Disconnected:member", "docComment": "/**\n * Emitted when Puppeteer gets disconnected from the Chromium instance. This might happen because of one of the following:\n *\n * - Chromium is closed or crashed\n *\n * - The {@link Browser.disconnect | browser.disconnect} method was called.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "Disconnected = " }, { "kind": "Content", "text": "\"disconnected\"" } ], "initializerTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "name": "Disconnected" }, { "kind": "EnumMember", "canonicalReference": "puppeteer-core!BrowserEmittedEvents.TargetChanged:member", "docComment": "/**\n * Emitted when the url of a target changes. Contains a {@link Target} instance.\n *\n * @remarks\n *\n * Note that this includes target changes in incognito browser contexts.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "TargetChanged = " }, { "kind": "Content", "text": "\"targetchanged\"" } ], "initializerTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "name": "TargetChanged" }, { "kind": "EnumMember", "canonicalReference": "puppeteer-core!BrowserEmittedEvents.TargetCreated:member", "docComment": "/**\n * Emitted when a target is created, for example when a new page is opened by {@link https://developer.mozilla.org/en-US/docs/Web/API/Window/open | window.open} or by {@link Browser.newPage | browser.newPage}\n *\n * Contains a {@link Target} instance.\n *\n * @remarks\n *\n * Note that this includes target creations in incognito browser contexts.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "TargetCreated = " }, { "kind": "Content", "text": "\"targetcreated\"" } ], "initializerTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "name": "TargetCreated" }, { "kind": "EnumMember", "canonicalReference": "puppeteer-core!BrowserEmittedEvents.TargetDestroyed:member", "docComment": "/**\n * Emitted when a target is destroyed, for example when a page is closed. Contains a {@link Target} instance.\n *\n * @remarks\n *\n * Note that this includes target destructions in incognito browser contexts.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "TargetDestroyed = " }, { "kind": "Content", "text": "\"targetdestroyed\"" } ], "initializerTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "name": "TargetDestroyed" } ] }, { "kind": "Class", "canonicalReference": "puppeteer-core!BrowserFetcher:class", "docComment": "/**\n * BrowserFetcher can download and manage different versions of Chromium and Firefox.\n *\n * @remarks\n *\n * BrowserFetcher is not designed to work concurrently with other instances of BrowserFetcher that share the same downloads directory.\n *\n * @example\n *\n * An example of using BrowserFetcher to download a specific version of Chromium and running Puppeteer against it:\n * ```ts\n * const browserFetcher = new BrowserFetcher({path: 'path/to/download/folder'});\n * const revisionInfo = await browserFetcher.download('533271');\n * const browser = await puppeteer.launch({\n * executablePath: revisionInfo.executablePath,\n * });\n * ```\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class BrowserFetcher " } ], "fileUrlPath": "src/node/BrowserFetcher.ts", "releaseTag": "Public", "name": "BrowserFetcher", "preserveMemberOrder": false, "members": [ { "kind": "Constructor", "canonicalReference": "puppeteer-core!BrowserFetcher:constructor(1)", "docComment": "/**\n * Constructs a browser fetcher for the given options.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(options: " }, { "kind": "Reference", "text": "BrowserFetcherOptions", "canonicalReference": "puppeteer-core!BrowserFetcherOptions:interface" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ] }, { "kind": "Method", "canonicalReference": "puppeteer-core!BrowserFetcher#canDownload:member(1)", "docComment": "/**\n * Initiates a HEAD request to check if the revision is available.\n *\n * @remarks\n *\n * This method is affected by the current `product`.\n *\n * @param revision - The revision to check availability for.\n *\n * @returns A promise that resolves to `true` if the revision could be downloaded from the host.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "canDownload(revision: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "revision", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "name": "canDownload" }, { "kind": "Method", "canonicalReference": "puppeteer-core!BrowserFetcher#download:member(1)", "docComment": "/**\n * Initiates a GET request to download the revision from the host.\n *\n * @remarks\n *\n * This method is affected by the current `product`.\n *\n * @param revision - The revision to download.\n *\n * @param progressCallback - A function that will be called with two arguments: How many bytes have been downloaded and the total number of bytes of the download.\n *\n * @returns A promise with revision information when the revision is downloaded and extracted.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "download(revision: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", progressCallback?: " }, { "kind": "Content", "text": "(x: number, y: number) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "BrowserFetcherRevisionInfo", "canonicalReference": "puppeteer-core!BrowserFetcherRevisionInfo:interface" }, { "kind": "Content", "text": " | undefined>" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 9 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "revision", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "progressCallback", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "isOptional": false, "name": "download" }, { "kind": "Method", "canonicalReference": "puppeteer-core!BrowserFetcher#host:member(1)", "docComment": "/**\n * @returns The download host being used.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "host(): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "name": "host" }, { "kind": "Method", "canonicalReference": "puppeteer-core!BrowserFetcher#localRevisions:member(1)", "docComment": "/**\n * @remarks\n *\n * This method is affected by the current `product`.\n *\n * @returns A list of all revision strings (for the current `product`) available locally on disk.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "localRevisions(): " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "name": "localRevisions" }, { "kind": "Method", "canonicalReference": "puppeteer-core!BrowserFetcher#platform:member(1)", "docComment": "/**\n * @returns Returns the current `Platform`, which is one of `mac`, `linux`, `win32` or `win64`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "platform(): " }, { "kind": "Reference", "text": "Platform", "canonicalReference": "puppeteer-core!Platform:type" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "name": "platform" }, { "kind": "Method", "canonicalReference": "puppeteer-core!BrowserFetcher#product:member(1)", "docComment": "/**\n * @returns Returns the current `Product`, which is one of `chrome` or `firefox`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "product(): " }, { "kind": "Reference", "text": "Product", "canonicalReference": "puppeteer-core!Product:type" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "name": "product" }, { "kind": "Method", "canonicalReference": "puppeteer-core!BrowserFetcher#remove:member(1)", "docComment": "/**\n * @remarks\n *\n * This method is affected by the current `product`.\n *\n * @param revision - A revision to remove for the current `product`.\n *\n * @returns A promise that resolves when the revision has been removes or throws if the revision has not been downloaded.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "remove(revision: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "revision", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "name": "remove" }, { "kind": "Method", "canonicalReference": "puppeteer-core!BrowserFetcher#revisionInfo:member(1)", "docComment": "/**\n * @param revision - The revision to get info for.\n *\n * @returns The revision info for the given revision.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "revisionInfo(revision: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "BrowserFetcherRevisionInfo", "canonicalReference": "puppeteer-core!BrowserFetcherRevisionInfo:interface" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "revision", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "name": "revisionInfo" } ], "implementsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "puppeteer-core!BrowserFetcherOptions:interface", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface BrowserFetcherOptions " } ], "fileUrlPath": "src/node/BrowserFetcher.ts", "releaseTag": "Public", "name": "BrowserFetcherOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "puppeteer-core!BrowserFetcherOptions#host:member", "docComment": "/**\n * Determines the host that will be used for downloading.\n *\n * @defaultValue\n *\n * Either\n *\n * - https://storage.googleapis.com or - https://archive.mozilla.org/pub/firefox/nightly/latest-mozilla-central\n */\n", "excerptTokens": [ { "kind": "Content", "text": "host?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "host", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "puppeteer-core!BrowserFetcherOptions#path:member", "docComment": "/**\n * Determines the path to download browsers to.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "path: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "path", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "puppeteer-core!BrowserFetcherOptions#platform:member", "docComment": "/**\n * Determines which platform the browser will be suited for.\n *\n * @defaultValue\n *\n * Auto-detected.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "platform?: " }, { "kind": "Reference", "text": "Platform", "canonicalReference": "puppeteer-core!Platform:type" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "platform", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "puppeteer-core!BrowserFetcherOptions#product:member", "docComment": "/**\n * Determines which product the {@link BrowserFetcher} is for.\n *\n * @defaultValue\n *\n * `\"chrome\"`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "product?: " }, { "kind": "Content", "text": "'chrome' | 'firefox'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "product", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "puppeteer-core!BrowserFetcherOptions#useMacOSARMBinary:member", "docComment": "/**\n * Enables the use of the Chromium binary for macOS ARM.\n *\n * @experimental\n */\n", "excerptTokens": [ { "kind": "Content", "text": "useMacOSARMBinary?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "useMacOSARMBinary", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "puppeteer-core!BrowserFetcherRevisionInfo:interface", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface BrowserFetcherRevisionInfo " } ], "fileUrlPath": "src/node/BrowserFetcher.ts", "releaseTag": "Public", "name": "BrowserFetcherRevisionInfo", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "puppeteer-core!BrowserFetcherRevisionInfo#executablePath:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "executablePath: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "executablePath", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "puppeteer-core!BrowserFetcherRevisionInfo#folderPath:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "folderPath: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "folderPath", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "puppeteer-core!BrowserFetcherRevisionInfo#local:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "local: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "local", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "puppeteer-core!BrowserFetcherRevisionInfo#product:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "product: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "product", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "puppeteer-core!BrowserFetcherRevisionInfo#revision:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "revision: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "revision", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "puppeteer-core!BrowserFetcherRevisionInfo#url:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "url: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "url", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "puppeteer-core!BrowserLaunchArgumentOptions:interface", "docComment": "/**\n * Launcher options that only apply to Chrome.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface BrowserLaunchArgumentOptions " } ], "fileUrlPath": "src/node/LaunchOptions.ts", "releaseTag": "Public", "name": "BrowserLaunchArgumentOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "puppeteer-core!BrowserLaunchArgumentOptions#args:member", "docComment": "/**\n * Additional command line arguments to pass to the browser instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "args?: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "args", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "puppeteer-core!BrowserLaunchArgumentOptions#debuggingPort:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "debuggingPort?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "debuggingPort", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "puppeteer-core!BrowserLaunchArgumentOptions#devtools:member", "docComment": "/**\n * Whether to auto-open a DevTools panel for each tab. If this is set to `true`, then `headless` will be forced to `false`.\n *\n * @defaultValue\n *\n * `false`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "devtools?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "devtools", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "puppeteer-core!BrowserLaunchArgumentOptions#headless:member", "docComment": "/**\n * Whether to run the browser in headless mode.\n *\n * @defaultValue\n *\n * true\n */\n", "excerptTokens": [ { "kind": "Content", "text": "headless?: " }, { "kind": "Content", "text": "boolean | 'new'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "headless", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "puppeteer-core!BrowserLaunchArgumentOptions#userDataDir:member", "docComment": "/**\n * Path to a user data directory. {@link https://chromium.googlesource.com/chromium/src/+/refs/heads/main/docs/user_data_dir.md | see the Chromium docs} for more info.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "userDataDir?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "userDataDir", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "puppeteer-core!CDPSession:class", "docComment": "/**\n * The `CDPSession` instances are used to talk raw Chrome Devtools Protocol.\n *\n * @remarks\n *\n * Protocol methods can be called with {@link CDPSession.send} method and protocol events can be subscribed to with `CDPSession.on` method.\n *\n * Useful links: {@link https://chromedevtools.github.io/devtools-protocol/ | DevTools Protocol Viewer} and {@link https://github.com/aslushnikov/getting-started-with-cdp/blob/HEAD/README.md | Getting Started with DevTools Protocol}.\n *\n * 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.\n *\n * @example\n * ```ts\n * const client = await page.target().createCDPSession();\n * await client.send('Animation.enable');\n * client.on('Animation.animationCreated', () =>\n * console.log('Animation created!')\n * );\n * const response = await client.send('Animation.getPlaybackRate');\n * console.log('playback rate is ' + response.playbackRate);\n * await client.send('Animation.setPlaybackRate', {\n * playbackRate: response.playbackRate / 2,\n * });\n * ```\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class CDPSession extends " }, { "kind": "Reference", "text": "EventEmitter", "canonicalReference": "puppeteer-core!EventEmitter:class" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/common/Connection.ts", "releaseTag": "Public", "name": "CDPSession", "preserveMemberOrder": false, "members": [ { "kind": "Method", "canonicalReference": "puppeteer-core!CDPSession#connection:member(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "connection(): " }, { "kind": "Reference", "text": "Connection", "canonicalReference": "puppeteer-core!Connection:class" }, { "kind": "Content", "text": " | undefined" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "name": "connection" }, { "kind": "Method", "canonicalReference": "puppeteer-core!CDPSession#detach:member(1)", "docComment": "/**\n * Detaches the cdpSession from the target. Once detached, the cdpSession object won't emit any events and can't be used to send messages.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "detach(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "name": "detach" }, { "kind": "Method", "canonicalReference": "puppeteer-core!CDPSession#id:member(1)", "docComment": "/**\n * Returns the session's id.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "id(): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "name": "id" }, { "kind": "Method", "canonicalReference": "puppeteer-core!CDPSession#send:member(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "send(method: " }, { "kind": "Content", "text": "T" }, { "kind": "Content", "text": ", ...paramArgs: " }, { "kind": "Reference", "text": "ProtocolMapping.Commands", "canonicalReference": "devtools-protocol!ProtocolMapping.Commands:interface" }, { "kind": "Content", "text": "[T]['paramsType']" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "ProtocolMapping.Commands", "canonicalReference": "devtools-protocol!ProtocolMapping.Commands:interface" }, { "kind": "Content", "text": "[T]['returnType']>" }, { "kind": "Content", "text": ";" } ], "typeParameters": [ { "typeParameterName": "T", "constraintTokenRange": { "startIndex": 1, "endIndex": 3 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 13 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "method", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 }, "isOptional": false }, { "parameterName": "paramArgs", "parameterTypeTokenRange": { "startIndex": 6, "endIndex": 8 }, "isOptional": false } ], "isOptional": false, "name": "send" } ], "extendsTokenRange": { "startIndex": 1, "endIndex": 2 }, "implementsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "puppeteer-core!CDPSessionOnMessageObject:interface", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface CDPSessionOnMessageObject " } ], "fileUrlPath": "src/common/Connection.ts", "releaseTag": "Public", "name": "CDPSessionOnMessageObject", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "puppeteer-core!CDPSessionOnMessageObject#error:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "error: " }, { "kind": "Content", "text": "{\n message: string;\n data: any;\n code: number;\n }" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "error", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "puppeteer-core!CDPSessionOnMessageObject#id:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "id?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "id", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "puppeteer-core!CDPSessionOnMessageObject#method:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "method: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "method", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "puppeteer-core!CDPSessionOnMessageObject#params:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "params: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "params", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "puppeteer-core!CDPSessionOnMessageObject#result:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "result?: " }, { "kind": "Content", "text": "any" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "result", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "TypeAlias", "canonicalReference": "puppeteer-core!ChromeReleaseChannel:type", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type ChromeReleaseChannel = " }, { "kind": "Content", "text": "'chrome' | 'chrome-beta' | 'chrome-canary' | 'chrome-dev'" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/node/LaunchOptions.ts", "releaseTag": "Public", "name": "ChromeReleaseChannel", "typeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "Function", "canonicalReference": "puppeteer-core!clearCustomQueryHandlers:function(1)", "docComment": "/**\n * @deprecated\n *\n * Import {@link Puppeteer} and use the static method {@link Puppeteer.clearCustomQueryHandlers}\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function clearCustomQueryHandlers(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/common/QueryHandler.ts", "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "clearCustomQueryHandlers" }, { "kind": "Interface", "canonicalReference": "puppeteer-core!ClickOptions:interface", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ClickOptions " } ], "fileUrlPath": "src/common/JSHandle.ts", "releaseTag": "Public", "name": "ClickOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "puppeteer-core!ClickOptions#button:member", "docComment": "/**\n * @defaultValue\n *\n * 'left'\n */\n", "excerptTokens": [ { "kind": "Content", "text": "button?: " }, { "kind": "Reference", "text": "MouseButton", "canonicalReference": "puppeteer-core!MouseButton:type" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "button", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "puppeteer-core!ClickOptions#clickCount:member", "docComment": "/**\n * @defaultValue\n *\n * 1\n */\n", "excerptTokens": [ { "kind": "Content", "text": "clickCount?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "clickCount", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "puppeteer-core!ClickOptions#delay:member", "docComment": "/**\n * Time to wait between `mousedown` and `mouseup` in milliseconds.\n *\n * @defaultValue\n *\n * 0\n */\n", "excerptTokens": [ { "kind": "Content", "text": "delay?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "delay", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "puppeteer-core!ClickOptions#offset:member", "docComment": "/**\n * Offset for the clickable point relative to the top-left corner of the border box.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "offset?: " }, { "kind": "Reference", "text": "Offset", "canonicalReference": "puppeteer-core!Offset:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "offset", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "puppeteer-core!CommonEventEmitter:interface", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface CommonEventEmitter " } ], "fileUrlPath": "src/common/EventEmitter.ts", "releaseTag": "Public", "name": "CommonEventEmitter", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "puppeteer-core!CommonEventEmitter#addListener:member(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "addListener(event: " }, { "kind": "Reference", "text": "EventType", "canonicalReference": "puppeteer-core!EventType:type" }, { "kind": "Content", "text": ", handler: " }, { "kind": "Reference", "text": "Handler", "canonicalReference": "puppeteer-core!Handler:type" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "CommonEventEmitter", "canonicalReference": "puppeteer-core!CommonEventEmitter:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "handler", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "addListener" }, { "kind": "MethodSignature", "canonicalReference": "puppeteer-core!CommonEventEmitter#emit:member(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "emit(event: " }, { "kind": "Reference", "text": "EventType", "canonicalReference": "puppeteer-core!EventType:type" }, { "kind": "Content", "text": ", eventData?: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "eventData", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "name": "emit" }, { "kind": "MethodSignature", "canonicalReference": "puppeteer-core!CommonEventEmitter#listenerCount:member(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "listenerCount(event: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "listenerCount" }, { "kind": "MethodSignature", "canonicalReference": "puppeteer-core!CommonEventEmitter#off:member(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "off(event: " }, { "kind": "Reference", "text": "EventType", "canonicalReference": "puppeteer-core!EventType:type" }, { "kind": "Content", "text": ", handler: " }, { "kind": "Reference", "text": "Handler", "canonicalReference": "puppeteer-core!Handler:type" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "CommonEventEmitter", "canonicalReference": "puppeteer-core!CommonEventEmitter:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "handler", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "off" }, { "kind": "MethodSignature", "canonicalReference": "puppeteer-core!CommonEventEmitter#on:member(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "on(event: " }, { "kind": "Reference", "text": "EventType", "canonicalReference": "puppeteer-core!EventType:type" }, { "kind": "Content", "text": ", handler: " }, { "kind": "Reference", "text": "Handler", "canonicalReference": "puppeteer-core!Handler:type" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "CommonEventEmitter", "canonicalReference": "puppeteer-core!CommonEventEmitter:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "handler", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "on" }, { "kind": "MethodSignature", "canonicalReference": "puppeteer-core!CommonEventEmitter#once:member(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "once(event: " }, { "kind": "Reference", "text": "EventType", "canonicalReference": "puppeteer-core!EventType:type" }, { "kind": "Content", "text": ", handler: " }, { "kind": "Reference", "text": "Handler", "canonicalReference": "puppeteer-core!Handler:type" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "CommonEventEmitter", "canonicalReference": "puppeteer-core!CommonEventEmitter:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "handler", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "once" }, { "kind": "MethodSignature", "canonicalReference": "puppeteer-core!CommonEventEmitter#removeAllListeners:member(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "removeAllListeners(event?: " }, { "kind": "Reference", "text": "EventType", "canonicalReference": "puppeteer-core!EventType:type" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "CommonEventEmitter", "canonicalReference": "puppeteer-core!CommonEventEmitter:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true } ], "name": "removeAllListeners" }, { "kind": "MethodSignature", "canonicalReference": "puppeteer-core!CommonEventEmitter#removeListener:member(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "removeListener(event: " }, { "kind": "Reference", "text": "EventType", "canonicalReference": "puppeteer-core!EventType:type" }, { "kind": "Content", "text": ", handler: " }, { "kind": "Reference", "text": "Handler", "canonicalReference": "puppeteer-core!Handler:type" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "CommonEventEmitter", "canonicalReference": "puppeteer-core!CommonEventEmitter:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "handler", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "removeListener" } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "puppeteer-core!Configuration:interface", "docComment": "/**\n * Defines options to configure Puppeteer's behavior during installation and runtime.\n *\n * See individual properties for more information.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface Configuration " } ], "fileUrlPath": "src/common/Configuration.ts", "releaseTag": "Public", "name": "Configuration", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "puppeteer-core!Configuration#browserRevision:member", "docComment": "/**\n * Specifies a certain version of the browser you'd like Puppeteer to use.\n *\n * Can be overridden by `PUPPETEER_BROWSER_REVISION`.\n *\n * See {@link PuppeteerNode.launch | puppeteer.launch} on how executable path is inferred.\n *\n * @defaultValue\n *\n * A compatible-revision of the browser.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "browserRevision?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "browserRevision", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "puppeteer-core!Configuration#cacheDirectory:member", "docComment": "/**\n * Defines the directory to be used by Puppeteer for caching.\n *\n * Can be overridden by `PUPPETEER_CACHE_DIR`.\n *\n * @defaultValue\n *\n * `path.join(os.homedir(), '.cache', 'puppeteer')`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "cacheDirectory?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "cacheDirectory", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "puppeteer-core!Configuration#defaultProduct:member", "docComment": "/**\n * Specifies which browser you'd like Puppeteer to use.\n *\n * Can be overridden by `PUPPETEER_PRODUCT`.\n *\n * @defaultValue\n *\n * `'chrome'`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "defaultProduct?: " }, { "kind": "Reference", "text": "Product", "canonicalReference": "puppeteer-core!Product:type" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "defaultProduct", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "puppeteer-core!Configuration#downloadHost:member", "docComment": "/**\n * Specifies the URL prefix that is used to download Chromium.\n *\n * Can be overridden by `PUPPETEER_DOWNLOAD_HOST`.\n *\n * @remarks\n *\n * This must include the protocol and may even need a path prefix.\n *\n * @defaultValue\n *\n * Either https://storage.googleapis.com or https://archive.mozilla.org/pub/firefox/nightly/latest-mozilla-central, depending on the product.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "downloadHost?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "downloadHost", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "puppeteer-core!Configuration#downloadPath:member", "docComment": "/**\n * Specifies the path for the downloads folder.\n *\n * Can be overridden by `PUPPETEER_DOWNLOAD_PATH`.\n *\n * @defaultValue\n *\n * `/` where `` is Puppeteer's cache directory and `` is the name of the browser.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "downloadPath?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "downloadPath", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "puppeteer-core!Configuration#executablePath:member", "docComment": "/**\n * Specifies an executable path to be used in {@link PuppeteerNode.launch | puppeteer.launch}.\n *\n * Can be overridden by `PUPPETEER_EXECUTABLE_PATH`.\n *\n * @defaultValue\n *\n * Auto-computed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "executablePath?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "executablePath", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "puppeteer-core!Configuration#experiments:member", "docComment": "/**\n * Defines experimental options for Puppeteer.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "experiments?: " }, { "kind": "Reference", "text": "ExperimentsConfiguration", "canonicalReference": "puppeteer-core!ExperimentsConfiguration:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "experiments", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "puppeteer-core!Configuration#logLevel:member", "docComment": "/**\n * Tells Puppeteer to log at the given level.\n *\n * At the moment, any option silences logging.\n *\n * @defaultValue\n *\n * `undefined`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "logLevel?: " }, { "kind": "Content", "text": "'silent' | 'error' | 'warn'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "logLevel", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "puppeteer-core!Configuration#skipDownload:member", "docComment": "/**\n * Tells Puppeteer to not download during installation.\n *\n * Can be overridden by `PUPPETEER_SKIP_DOWNLOAD`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "skipDownload?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "skipDownload", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "puppeteer-core!Configuration#temporaryDirectory:member", "docComment": "/**\n * Defines the directory to be used by Puppeteer for creating temporary files.\n *\n * Can be overridden by `PUPPETEER_TMP_DIR`.\n *\n * @defaultValue\n *\n * `os.tmpdir()`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "temporaryDirectory?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "temporaryDirectory", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Variable", "canonicalReference": "puppeteer-core!connect:var", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "connect: " }, { "kind": "Content", "text": "(options: import(\"./common/Puppeteer.js\")." }, { "kind": "Reference", "text": "ConnectOptions", "canonicalReference": "puppeteer-core!ConnectOptions:interface" }, { "kind": "Content", "text": ") => " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "" } ], "fileUrlPath": "src/puppeteer-core.ts", "isReadonly": true, "releaseTag": "Public", "name": "connect", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 8 } }, { "kind": "Class", "canonicalReference": "puppeteer-core!Connection:class", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class Connection extends " }, { "kind": "Reference", "text": "EventEmitter", "canonicalReference": "puppeteer-core!EventEmitter:class" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/common/Connection.ts", "releaseTag": "Public", "name": "Connection", "preserveMemberOrder": false, "members": [ { "kind": "Constructor", "canonicalReference": "puppeteer-core!Connection:constructor(1)", "docComment": "/**\n * Constructs a new instance of the `Connection` class\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(url: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", transport: " }, { "kind": "Reference", "text": "ConnectionTransport", "canonicalReference": "puppeteer-core!ConnectionTransport:interface" }, { "kind": "Content", "text": ", delay?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "url", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "transport", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "delay", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": true } ] }, { "kind": "Method", "canonicalReference": "puppeteer-core!Connection#createSession:member(1)", "docComment": "/**\n * @param targetInfo - The target info\n *\n * @returns The CDP session that is created\n */\n", "excerptTokens": [ { "kind": "Content", "text": "createSession(targetInfo: " }, { "kind": "Reference", "text": "Protocol.Target.TargetInfo", "canonicalReference": "devtools-protocol!Protocol.Target.TargetInfo:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "CDPSession", "canonicalReference": "puppeteer-core!CDPSession:class" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 7 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "targetInfo", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "name": "createSession" }, { "kind": "Method", "canonicalReference": "puppeteer-core!Connection#dispose:member(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "dispose(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "name": "dispose" }, { "kind": "Method", "canonicalReference": "puppeteer-core!Connection.fromSession:member(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "static fromSession(session: " }, { "kind": "Reference", "text": "CDPSession", "canonicalReference": "puppeteer-core!CDPSession:class" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Connection", "canonicalReference": "puppeteer-core!Connection:class" }, { "kind": "Content", "text": " | undefined" }, { "kind": "Content", "text": ";" } ], "isStatic": true, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "session", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "name": "fromSession" }, { "kind": "Method", "canonicalReference": "puppeteer-core!Connection#send:member(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "send(method: " }, { "kind": "Content", "text": "T" }, { "kind": "Content", "text": ", ...paramArgs: " }, { "kind": "Reference", "text": "ProtocolMapping.Commands", "canonicalReference": "devtools-protocol!ProtocolMapping.Commands:interface" }, { "kind": "Content", "text": "[T]['paramsType']" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "ProtocolMapping.Commands", "canonicalReference": "devtools-protocol!ProtocolMapping.Commands:interface" }, { "kind": "Content", "text": "[T]['returnType']>" }, { "kind": "Content", "text": ";" } ], "typeParameters": [ { "typeParameterName": "T", "constraintTokenRange": { "startIndex": 1, "endIndex": 3 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 13 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "method", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 }, "isOptional": false }, { "parameterName": "paramArgs", "parameterTypeTokenRange": { "startIndex": 6, "endIndex": 8 }, "isOptional": false } ], "isOptional": false, "name": "send" }, { "kind": "Method", "canonicalReference": "puppeteer-core!Connection#session:member(1)", "docComment": "/**\n * @param sessionId - The session id\n *\n * @returns The current CDP session if it exists\n */\n", "excerptTokens": [ { "kind": "Content", "text": "session(sessionId: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "CDPSession", "canonicalReference": "puppeteer-core!CDPSession:class" }, { "kind": "Content", "text": " | null" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "sessionId", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "name": "session" }, { "kind": "Method", "canonicalReference": "puppeteer-core!Connection#url:member(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "url(): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "name": "url" } ], "extendsTokenRange": { "startIndex": 1, "endIndex": 2 }, "implementsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "puppeteer-core!ConnectionCallback:interface", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ConnectionCallback " } ], "fileUrlPath": "src/common/Connection.ts", "releaseTag": "Public", "name": "ConnectionCallback", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "puppeteer-core!ConnectionCallback#error:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "error: " }, { "kind": "Reference", "text": "ProtocolError", "canonicalReference": "puppeteer-core!ProtocolError:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "error", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "puppeteer-core!ConnectionCallback#method:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "method: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "method", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "puppeteer-core!ConnectionCallback#reject:member(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "reject(args: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "args", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "reject" }, { "kind": "MethodSignature", "canonicalReference": "puppeteer-core!ConnectionCallback#resolve:member(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "resolve(args: " }, { "kind": "Content", "text": "unknown" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "args", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "resolve" } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "puppeteer-core!ConnectionTransport:interface", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ConnectionTransport " } ], "fileUrlPath": "src/common/ConnectionTransport.ts", "releaseTag": "Public", "name": "ConnectionTransport", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "puppeteer-core!ConnectionTransport#close:member(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "close(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "close" }, { "kind": "PropertySignature", "canonicalReference": "puppeteer-core!ConnectionTransport#onclose:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "onclose?: " }, { "kind": "Content", "text": "() => void" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "onclose", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "puppeteer-core!ConnectionTransport#onmessage:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "onmessage?: " }, { "kind": "Content", "text": "(message: string) => void" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "onmessage", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "puppeteer-core!ConnectionTransport#send:member(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "send(message: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "message", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "send" } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "puppeteer-core!ConnectOptions:interface", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ConnectOptions extends " }, { "kind": "Reference", "text": "BrowserConnectOptions", "canonicalReference": "puppeteer-core!BrowserConnectOptions:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/common/Puppeteer.ts", "releaseTag": "Public", "name": "ConnectOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "puppeteer-core!ConnectOptions#browserURL:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "browserURL?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "browserURL", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "puppeteer-core!ConnectOptions#browserWSEndpoint:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "browserWSEndpoint?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "browserWSEndpoint", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "puppeteer-core!ConnectOptions#headers:member", "docComment": "/**\n * Headers to use for the web socket connection.\n *\n * @remarks\n *\n * Only works in the Node.js environment.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "headers?: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "headers", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "puppeteer-core!ConnectOptions#transport:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "transport?: " }, { "kind": "Reference", "text": "ConnectionTransport", "canonicalReference": "puppeteer-core!ConnectionTransport:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "transport", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Class", "canonicalReference": "puppeteer-core!ConsoleMessage:class", "docComment": "/**\n * ConsoleMessage objects are dispatched by page via the 'console' event.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class ConsoleMessage " } ], "fileUrlPath": "src/common/ConsoleMessage.ts", "releaseTag": "Public", "name": "ConsoleMessage", "preserveMemberOrder": false, "members": [ { "kind": "Constructor", "canonicalReference": "puppeteer-core!ConsoleMessage:constructor(1)", "docComment": "/**\n * Constructs a new instance of the `ConsoleMessage` class\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(type: " }, { "kind": "Reference", "text": "ConsoleMessageType", "canonicalReference": "puppeteer-core!ConsoleMessageType:type" }, { "kind": "Content", "text": ", text: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", args: " }, { "kind": "Reference", "text": "JSHandle", "canonicalReference": "puppeteer-core!JSHandle:class" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ", stackTraceLocations: " }, { "kind": "Reference", "text": "ConsoleMessageLocation", "canonicalReference": "puppeteer-core!ConsoleMessageLocation:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "type", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "text", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "args", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 7 }, "isOptional": false }, { "parameterName": "stackTraceLocations", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 10 }, "isOptional": false } ] }, { "kind": "Method", "canonicalReference": "puppeteer-core!ConsoleMessage#args:member(1)", "docComment": "/**\n * @returns An array of arguments passed to the console.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "args(): " }, { "kind": "Reference", "text": "JSHandle", "canonicalReference": "puppeteer-core!JSHandle:class" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "name": "args" }, { "kind": "Method", "canonicalReference": "puppeteer-core!ConsoleMessage#location:member(1)", "docComment": "/**\n * @returns The location of the console message.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "location(): " }, { "kind": "Reference", "text": "ConsoleMessageLocation", "canonicalReference": "puppeteer-core!ConsoleMessageLocation:interface" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "name": "location" }, { "kind": "Method", "canonicalReference": "puppeteer-core!ConsoleMessage#stackTrace:member(1)", "docComment": "/**\n * @returns The array of locations on the stack of the console message.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "stackTrace(): " }, { "kind": "Reference", "text": "ConsoleMessageLocation", "canonicalReference": "puppeteer-core!ConsoleMessageLocation:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "name": "stackTrace" }, { "kind": "Method", "canonicalReference": "puppeteer-core!ConsoleMessage#text:member(1)", "docComment": "/**\n * @returns The text of the console message.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "text(): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "name": "text" }, { "kind": "Method", "canonicalReference": "puppeteer-core!ConsoleMessage#type:member(1)", "docComment": "/**\n * @returns The type of the console message.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "type(): " }, { "kind": "Reference", "text": "ConsoleMessageType", "canonicalReference": "puppeteer-core!ConsoleMessageType:type" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "name": "type" } ], "implementsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "puppeteer-core!ConsoleMessageLocation:interface", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ConsoleMessageLocation " } ], "fileUrlPath": "src/common/ConsoleMessage.ts", "releaseTag": "Public", "name": "ConsoleMessageLocation", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "puppeteer-core!ConsoleMessageLocation#columnNumber:member", "docComment": "/**\n * 0-based column number in the resource if known or `undefined` otherwise.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "columnNumber?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "columnNumber", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "puppeteer-core!ConsoleMessageLocation#lineNumber:member", "docComment": "/**\n * 0-based line number in the resource if known or `undefined` otherwise.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "lineNumber?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "lineNumber", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "puppeteer-core!ConsoleMessageLocation#url:member", "docComment": "/**\n * URL of the resource if known or `undefined` otherwise.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "url?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "url", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "TypeAlias", "canonicalReference": "puppeteer-core!ConsoleMessageType:type", "docComment": "/**\n * The supported types for console messages.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type ConsoleMessageType = " }, { "kind": "Content", "text": "'log' | 'debug' | 'info' | 'error' | 'warning' | 'dir' | 'dirxml' | 'table' | 'trace' | 'clear' | 'startGroup' | 'startGroupCollapsed' | 'endGroup' | 'assert' | 'profile' | 'profileEnd' | 'count' | 'timeEnd' | 'verbose'" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/common/ConsoleMessage.ts", "releaseTag": "Public", "name": "ConsoleMessageType", "typeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "Interface", "canonicalReference": "puppeteer-core!ContinueRequestOverrides:interface", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ContinueRequestOverrides " } ], "fileUrlPath": "src/common/HTTPRequest.ts", "releaseTag": "Public", "name": "ContinueRequestOverrides", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "puppeteer-core!ContinueRequestOverrides#headers:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "headers?: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "headers", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "puppeteer-core!ContinueRequestOverrides#method:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "method?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "method", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "puppeteer-core!ContinueRequestOverrides#postData:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "postData?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "postData", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "puppeteer-core!ContinueRequestOverrides#url:member", "docComment": "/**\n * If set, the request URL will change. This is not a redirect.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "url?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "url", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "puppeteer-core!Coverage:class", "docComment": "/**\n * The Coverage class provides methods to gathers information about parts of JavaScript and CSS that were used by the page.\n *\n * @remarks\n *\n * To output coverage in a form consumable by {@link https://github.com/istanbuljs | Istanbul}, see {@link https://github.com/istanbuljs/puppeteer-to-istanbul | puppeteer-to-istanbul}.\n *\n * @example\n *\n * An example of using JavaScript and CSS coverage to get percentage of initially executed code:\n * ```ts\n * // Enable both JavaScript and CSS coverage\n * await Promise.all([\n * page.coverage.startJSCoverage(),\n * page.coverage.startCSSCoverage(),\n * ]);\n * // Navigate to page\n * await page.goto('https://example.com');\n * // Disable both JavaScript and CSS coverage\n * const [jsCoverage, cssCoverage] = await Promise.all([\n * page.coverage.stopJSCoverage(),\n * page.coverage.stopCSSCoverage(),\n * ]);\n * let totalBytes = 0;\n * let usedBytes = 0;\n * const coverage = [...jsCoverage, ...cssCoverage];\n * for (const entry of coverage) {\n * totalBytes += entry.text.length;\n * for (const range of entry.ranges) usedBytes += range.end - range.start - 1;\n * }\n * console.log(`Bytes used: ${(usedBytes / totalBytes) * 100}%`);\n * ```\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class Coverage " } ], "fileUrlPath": "src/common/Coverage.ts", "releaseTag": "Public", "name": "Coverage", "preserveMemberOrder": false, "members": [ { "kind": "Constructor", "canonicalReference": "puppeteer-core!Coverage:constructor(1)", "docComment": "/**\n * Constructs a new instance of the `Coverage` class\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(client: " }, { "kind": "Reference", "text": "CDPSession", "canonicalReference": "puppeteer-core!CDPSession:class" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "client", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ] }, { "kind": "Method", "canonicalReference": "puppeteer-core!Coverage#startCSSCoverage:member(1)", "docComment": "/**\n * @param options - Set of configurable options for coverage, defaults to `resetOnNavigation : true`\n *\n * @returns Promise that resolves when coverage is started.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "startCSSCoverage(options?: " }, { "kind": "Reference", "text": "CSSCoverageOptions", "canonicalReference": "puppeteer-core!CSSCoverageOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true } ], "isOptional": false, "name": "startCSSCoverage" }, { "kind": "Method", "canonicalReference": "puppeteer-core!Coverage#startJSCoverage:member(1)", "docComment": "/**\n * @remarks\n *\n * 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 URL will start with `debugger://VM` (unless a magic //# sourceURL comment is present, in which case that will the be URL).\n *\n * @param options - Set of configurable options for coverage defaults to `resetOnNavigation : true, reportAnonymousScripts : false,` `includeRawScriptCoverage : false, useBlockCoverage : true`\n *\n * @returns Promise that resolves when coverage is started.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "startJSCoverage(options?: " }, { "kind": "Reference", "text": "JSCoverageOptions", "canonicalReference": "puppeteer-core!JSCoverageOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true } ], "isOptional": false, "name": "startJSCoverage" }, { "kind": "Method", "canonicalReference": "puppeteer-core!Coverage#stopCSSCoverage:member(1)", "docComment": "/**\n * @remarks\n *\n * CSS Coverage doesn't include dynamically injected style tags without sourceURLs.\n *\n * @returns Promise that resolves to the array of coverage reports for all stylesheets.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "stopCSSCoverage(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "CoverageEntry", "canonicalReference": "puppeteer-core!CoverageEntry:interface" }, { "kind": "Content", "text": "[]>" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "name": "stopCSSCoverage" }, { "kind": "Method", "canonicalReference": "puppeteer-core!Coverage#stopJSCoverage:member(1)", "docComment": "/**\n * @remarks\n *\n * JavaScript Coverage doesn't include anonymous scripts by default. However, scripts with sourceURLs are reported.\n *\n * @returns Promise that resolves to the array of coverage reports for all scripts.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "stopJSCoverage(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "JSCoverageEntry", "canonicalReference": "puppeteer-core!JSCoverageEntry:interface" }, { "kind": "Content", "text": "[]>" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "name": "stopJSCoverage" } ], "implementsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "puppeteer-core!CoverageEntry:interface", "docComment": "/**\n * The CoverageEntry class represents one entry of the coverage report.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface CoverageEntry " } ], "fileUrlPath": "src/common/Coverage.ts", "releaseTag": "Public", "name": "CoverageEntry", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "puppeteer-core!CoverageEntry#ranges:member", "docComment": "/**\n * The covered range as start and end positions.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "ranges: " }, { "kind": "Reference", "text": "Array", "canonicalReference": "!Array:interface" }, { "kind": "Content", "text": "<{\n start: number;\n end: number;\n }>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "ranges", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "puppeteer-core!CoverageEntry#text:member", "docComment": "/**\n * The content of the style sheet or script.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "text: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "text", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "puppeteer-core!CoverageEntry#url:member", "docComment": "/**\n * The URL of the style sheet or script.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "url: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "url", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Variable", "canonicalReference": "puppeteer-core!createBrowserFetcher:var", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "createBrowserFetcher: " }, { "kind": "Content", "text": "(options?: " }, { "kind": "Reference", "text": "Partial", "canonicalReference": "!Partial:type" }, { "kind": "Content", "text": ") => import(\"./node/BrowserFetcher.js\")." }, { "kind": "Reference", "text": "BrowserFetcher", "canonicalReference": "puppeteer-core!BrowserFetcher:class" } ], "fileUrlPath": "src/puppeteer-core.ts", "isReadonly": true, "releaseTag": "Public", "name": "createBrowserFetcher", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 7 } }, { "kind": "Interface", "canonicalReference": "puppeteer-core!Credentials:interface", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface Credentials " } ], "fileUrlPath": "src/common/NetworkManager.ts", "releaseTag": "Public", "name": "Credentials", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "puppeteer-core!Credentials#password:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "password: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "password", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "puppeteer-core!Credentials#username:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "username: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "username", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "puppeteer-core!CSSCoverage:class", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class CSSCoverage " } ], "fileUrlPath": "src/common/Coverage.ts", "releaseTag": "Public", "name": "CSSCoverage", "preserveMemberOrder": false, "members": [ { "kind": "Constructor", "canonicalReference": "puppeteer-core!CSSCoverage:constructor(1)", "docComment": "/**\n * Constructs a new instance of the `CSSCoverage` class\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(client: " }, { "kind": "Reference", "text": "CDPSession", "canonicalReference": "puppeteer-core!CDPSession:class" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "client", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ] }, { "kind": "Method", "canonicalReference": "puppeteer-core!CSSCoverage#start:member(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "start(options?: " }, { "kind": "Content", "text": "{\n resetOnNavigation?: boolean;\n }" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true } ], "isOptional": false, "name": "start" }, { "kind": "Method", "canonicalReference": "puppeteer-core!CSSCoverage#stop:member(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "stop(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "CoverageEntry", "canonicalReference": "puppeteer-core!CoverageEntry:interface" }, { "kind": "Content", "text": "[]>" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "name": "stop" } ], "implementsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "puppeteer-core!CSSCoverageOptions:interface", "docComment": "/**\n * Set of configurable options for CSS coverage.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface CSSCoverageOptions " } ], "fileUrlPath": "src/common/Coverage.ts", "releaseTag": "Public", "name": "CSSCoverageOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "puppeteer-core!CSSCoverageOptions#resetOnNavigation:member", "docComment": "/**\n * Whether to reset coverage on every navigation.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "resetOnNavigation?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "resetOnNavigation", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "puppeteer-core!CustomError:class", "docComment": "/**\n * @remarks\n *\n * The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `CustomError` class.\n *\n * @deprecated\n *\n * Do not use.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class CustomError extends " }, { "kind": "Reference", "text": "Error", "canonicalReference": "!Error:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/common/Errors.ts", "releaseTag": "Public", "name": "CustomError", "preserveMemberOrder": false, "members": [], "extendsTokenRange": { "startIndex": 1, "endIndex": 2 }, "implementsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "puppeteer-core!CustomQueryHandler:interface", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface CustomQueryHandler " } ], "fileUrlPath": "src/common/QueryHandler.ts", "releaseTag": "Public", "name": "CustomQueryHandler", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "puppeteer-core!CustomQueryHandler#queryAll:member", "docComment": "/**\n * @returns Some {@link Node}s matching the given `selector` from {@link node}.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "queryAll?: " }, { "kind": "Content", "text": "(node: " }, { "kind": "Reference", "text": "Node", "canonicalReference": "!Node:interface" }, { "kind": "Content", "text": ", selector: string) => " }, { "kind": "Reference", "text": "Node", "canonicalReference": "!Node:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "queryAll", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 6 } }, { "kind": "PropertySignature", "canonicalReference": "puppeteer-core!CustomQueryHandler#queryOne:member", "docComment": "/**\n * @returns A {@link Node} matching the given `selector` from {@link node}.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "queryOne?: " }, { "kind": "Content", "text": "(node: " }, { "kind": "Reference", "text": "Node", "canonicalReference": "!Node:interface" }, { "kind": "Content", "text": ", selector: string) => " }, { "kind": "Reference", "text": "Node", "canonicalReference": "!Node:interface" }, { "kind": "Content", "text": " | null" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "queryOne", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 6 } } ], "extendsTokenRanges": [] }, { "kind": "Function", "canonicalReference": "puppeteer-core!customQueryHandlerNames:function(1)", "docComment": "/**\n * @deprecated\n *\n * Import {@link Puppeteer} and use the static method {@link Puppeteer.customQueryHandlerNames}\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function customQueryHandlerNames(): " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/common/QueryHandler.ts", "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "customQueryHandlerNames" }, { "kind": "Variable", "canonicalReference": "puppeteer-core!DEFAULT_INTERCEPT_RESOLUTION_PRIORITY:var", "docComment": "/**\n * The default cooperative request interception resolution priority\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "DEFAULT_INTERCEPT_RESOLUTION_PRIORITY = " }, { "kind": "Content", "text": "0" } ], "fileUrlPath": "src/common/HTTPRequest.ts", "initializerTokenRange": { "startIndex": 1, "endIndex": 2 }, "isReadonly": true, "releaseTag": "Public", "name": "DEFAULT_INTERCEPT_RESOLUTION_PRIORITY", "variableTypeTokenRange": { "startIndex": 0, "endIndex": 0 } }, { "kind": "Variable", "canonicalReference": "puppeteer-core!defaultArgs:var", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "defaultArgs: " }, { "kind": "Content", "text": "(options?: import(\"./node/LaunchOptions.js\")." }, { "kind": "Reference", "text": "BrowserLaunchArgumentOptions", "canonicalReference": "puppeteer-core!BrowserLaunchArgumentOptions:interface" }, { "kind": "Content", "text": ") => string[]" } ], "fileUrlPath": "src/puppeteer-core.ts", "isReadonly": true, "releaseTag": "Public", "name": "defaultArgs", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 4 } }, { "kind": "Interface", "canonicalReference": "puppeteer-core!Device:interface", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface Device " } ], "fileUrlPath": "src/common/Device.ts", "releaseTag": "Public", "name": "Device", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "puppeteer-core!Device#userAgent:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "userAgent: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "userAgent", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "puppeteer-core!Device#viewport:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "viewport: " }, { "kind": "Reference", "text": "Viewport", "canonicalReference": "puppeteer-core!Viewport:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "viewport", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Variable", "canonicalReference": "puppeteer-core!devices:var", "docComment": "/**\n * @deprecated\n *\n * Import {@link KnownDevices}\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "devices: " }, { "kind": "Reference", "text": "Readonly", "canonicalReference": "!Readonly:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<\"Blackberry PlayBook\" | \"Blackberry PlayBook landscape\" | \"BlackBerry Z30\" | \"BlackBerry Z30 landscape\" | \"Galaxy Note 3\" | \"Galaxy Note 3 landscape\" | \"Galaxy Note II\" | \"Galaxy Note II landscape\" | \"Galaxy S III\" | \"Galaxy S III landscape\" | \"Galaxy S5\" | \"Galaxy S5 landscape\" | \"Galaxy S8\" | \"Galaxy S8 landscape\" | \"Galaxy S9+\" | \"Galaxy S9+ landscape\" | \"Galaxy Tab S4\" | \"Galaxy Tab S4 landscape\" | \"iPad\" | \"iPad landscape\" | \"iPad (gen 6)\" | \"iPad (gen 6) landscape\" | \"iPad (gen 7)\" | \"iPad (gen 7) landscape\" | \"iPad Mini\" | \"iPad Mini landscape\" | \"iPad Pro\" | \"iPad Pro landscape\" | \"iPad Pro 11\" | \"iPad Pro 11 landscape\" | \"iPhone 4\" | \"iPhone 4 landscape\" | \"iPhone 5\" | \"iPhone 5 landscape\" | \"iPhone 6\" | \"iPhone 6 landscape\" | \"iPhone 6 Plus\" | \"iPhone 6 Plus landscape\" | \"iPhone 7\" | \"iPhone 7 landscape\" | \"iPhone 7 Plus\" | \"iPhone 7 Plus landscape\" | \"iPhone 8\" | \"iPhone 8 landscape\" | \"iPhone 8 Plus\" | \"iPhone 8 Plus landscape\" | \"iPhone SE\" | \"iPhone SE landscape\" | \"iPhone X\" | \"iPhone X landscape\" | \"iPhone XR\" | \"iPhone XR landscape\" | \"iPhone 11\" | \"iPhone 11 landscape\" | \"iPhone 11 Pro\" | \"iPhone 11 Pro landscape\" | \"iPhone 11 Pro Max\" | \"iPhone 11 Pro Max landscape\" | \"iPhone 12\" | \"iPhone 12 landscape\" | \"iPhone 12 Pro\" | \"iPhone 12 Pro landscape\" | \"iPhone 12 Pro Max\" | \"iPhone 12 Pro Max landscape\" | \"iPhone 12 Mini\" | \"iPhone 12 Mini landscape\" | \"iPhone 13\" | \"iPhone 13 landscape\" | \"iPhone 13 Pro\" | \"iPhone 13 Pro landscape\" | \"iPhone 13 Pro Max\" | \"iPhone 13 Pro Max landscape\" | \"iPhone 13 Mini\" | \"iPhone 13 Mini landscape\" | \"JioPhone 2\" | \"JioPhone 2 landscape\" | \"Kindle Fire HDX\" | \"Kindle Fire HDX landscape\" | \"LG Optimus L70\" | \"LG Optimus L70 landscape\" | \"Microsoft Lumia 550\" | \"Microsoft Lumia 950\" | \"Microsoft Lumia 950 landscape\" | \"Nexus 10\" | \"Nexus 10 landscape\" | \"Nexus 4\" | \"Nexus 4 landscape\" | \"Nexus 5\" | \"Nexus 5 landscape\" | \"Nexus 5X\" | \"Nexus 5X landscape\" | \"Nexus 6\" | \"Nexus 6 landscape\" | \"Nexus 6P\" | \"Nexus 6P landscape\" | \"Nexus 7\" | \"Nexus 7 landscape\" | \"Nokia Lumia 520\" | \"Nokia Lumia 520 landscape\" | \"Nokia N9\" | \"Nokia N9 landscape\" | \"Pixel 2\" | \"Pixel 2 landscape\" | \"Pixel 2 XL\" | \"Pixel 2 XL landscape\" | \"Pixel 3\" | \"Pixel 3 landscape\" | \"Pixel 4\" | \"Pixel 4 landscape\" | \"Pixel 4a (5G)\" | \"Pixel 4a (5G) landscape\" | \"Pixel 5\" | \"Pixel 5 landscape\" | \"Moto G4\" | \"Moto G4 landscape\", " }, { "kind": "Reference", "text": "Device", "canonicalReference": "puppeteer-core!Device:interface" }, { "kind": "Content", "text": ">>" } ], "fileUrlPath": "src/common/Device.ts", "isReadonly": true, "releaseTag": "Public", "name": "devices", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 7 } }, { "kind": "Class", "canonicalReference": "puppeteer-core!Dialog:class", "docComment": "/**\n * Dialog instances are dispatched by the {@link Page} via the `dialog` event.\n *\n * @remarks\n *\n * 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.\n *\n * @example\n * ```ts\n * import puppeteer from 'puppeteer';\n *\n * (async () => {\n * const browser = await puppeteer.launch();\n * const page = await browser.newPage();\n * page.on('dialog', async dialog => {\n * console.log(dialog.message());\n * await dialog.dismiss();\n * await browser.close();\n * });\n * page.evaluate(() => alert('1'));\n * })();\n * ```\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class Dialog " } ], "fileUrlPath": "src/common/Dialog.ts", "releaseTag": "Public", "name": "Dialog", "preserveMemberOrder": false, "members": [ { "kind": "Method", "canonicalReference": "puppeteer-core!Dialog#accept:member(1)", "docComment": "/**\n * @param promptText - optional text that will be entered in the dialog prompt. Has no effect if the dialog's type is not `prompt`.\n *\n * @returns A promise that resolves when the dialog has been accepted.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "accept(promptText?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "promptText", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true } ], "isOptional": false, "name": "accept" }, { "kind": "Method", "canonicalReference": "puppeteer-core!Dialog#defaultValue:member(1)", "docComment": "/**\n * @returns The default value of the prompt, or an empty string if the dialog is not a `prompt`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "defaultValue(): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "name": "defaultValue" }, { "kind": "Method", "canonicalReference": "puppeteer-core!Dialog#dismiss:member(1)", "docComment": "/**\n * @returns A promise which will resolve once the dialog has been dismissed\n */\n", "excerptTokens": [ { "kind": "Content", "text": "dismiss(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "name": "dismiss" }, { "kind": "Method", "canonicalReference": "puppeteer-core!Dialog#message:member(1)", "docComment": "/**\n * @returns The message displayed in the dialog.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "message(): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "name": "message" }, { "kind": "Method", "canonicalReference": "puppeteer-core!Dialog#type:member(1)", "docComment": "/**\n * @returns The type of the dialog.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "type(): " }, { "kind": "Reference", "text": "Protocol.Page.DialogType", "canonicalReference": "devtools-protocol!Protocol.Page.DialogType:type" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "name": "type" } ], "implementsTokenRanges": [] }, { "kind": "TypeAlias", "canonicalReference": "puppeteer-core!ElementFor:type", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type ElementFor = " }, { "kind": "Content", "text": "TagName extends keyof " }, { "kind": "Reference", "text": "HTMLElementTagNameMap", "canonicalReference": "!HTMLElementTagNameMap:interface" }, { "kind": "Content", "text": " ? " }, { "kind": "Reference", "text": "HTMLElementTagNameMap", "canonicalReference": "!HTMLElementTagNameMap:interface" }, { "kind": "Content", "text": "[TagName] : TagName extends keyof " }, { "kind": "Reference", "text": "SVGElementTagNameMap", "canonicalReference": "!SVGElementTagNameMap:interface" }, { "kind": "Content", "text": " ? " }, { "kind": "Reference", "text": "SVGElementTagNameMap", "canonicalReference": "!SVGElementTagNameMap:interface" }, { "kind": "Content", "text": "[TagName] : never" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/common/types.ts", "releaseTag": "Public", "name": "ElementFor", "typeParameters": [ { "typeParameterName": "TagName", "constraintTokenRange": { "startIndex": 1, "endIndex": 5 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "typeTokenRange": { "startIndex": 6, "endIndex": 15 } }, { "kind": "Class", "canonicalReference": "puppeteer-core!ElementHandle:class", "docComment": "/**\n * ElementHandle represents an in-page DOM element.\n *\n * @remarks\n *\n * ElementHandles can be created with the {@link Page.$} method.\n * ```ts\n * import puppeteer from 'puppeteer';\n *\n * (async () => {\n * const browser = await puppeteer.launch();\n * const page = await browser.newPage();\n * await page.goto('https://example.com');\n * const hrefElement = await page.$('a');\n * await hrefElement.click();\n * // ...\n * })();\n * ```\n *\n * ElementHandle prevents the DOM element from being garbage-collected unless the handle is {@link JSHandle.dispose | disposed}. ElementHandles are auto-disposed when their origin frame gets navigated.\n *\n * ElementHandle instances can be used as arguments in {@link Page.$eval} and {@link Page.evaluate} methods.\n *\n * 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.\n *\n * @param values - Values of options to select. If the `