forked from browserless/browserless
-
Notifications
You must be signed in to change notification settings - Fork 0
/
hints.json
1 lines (1 loc) · 111 KB
/
hints.json
1
[{"text":"$","description":"The method runs document.querySelector within the page. If no element matches the selector, the return value resolves to null.Shortcut for page.mainFrame().$(selector).The method runs document.querySelectorAll within the page. If no elements match the selector, the return value resolves to [].Shortcut for page.mainFrame().$$(selector).This method r","href":"https://github.com/GoogleChrome/puppeteer/blob/v1.18.1/docs/api.md#pageselector","args":"\n<li><code>selector</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" title=\"String\" rel=\"nofollow\">string</a>> A <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Selectors\" title=\"selector\" rel=\"nofollow\">selector</a> to query page for</li>\n<li>returns: <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise\" title=\"Promise\" rel=\"nofollow\">Promise</a><?<a href=\"#class-elementhandle\" title=\"ElementHandle\">ElementHandle</a>>></li>\n"},{"text":"$$","description":"The method runs document.querySelectorAll within the page. If no elements match the selector, the return value resolves to [].Shortcut for page.mainFrame().$$(selector).This method runs Array.from(document.querySelectorAll(selector)) within the page and passes it as the first argument to pageFunction.If pageFunction returns a Promise, then page.$$e","href":"https://github.com/GoogleChrome/puppeteer/blob/v1.18.1/docs/api.md#pageselector-1","args":"\n<li><code>selector</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" title=\"String\" rel=\"nofollow\">string</a>> A <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Selectors\" title=\"selector\" rel=\"nofollow\">selector</a> to query page for</li>\n<li>returns: <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise\" title=\"Promise\" rel=\"nofollow\">Promise</a><<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array\" title=\"Array\" rel=\"nofollow\">Array</a><<a href=\"#class-elementhandle\" title=\"ElementHandle\">ElementHandle</a>>>></li>\n"},{"text":"$$eval","description":"This method runs Array.from(document.querySelectorAll(selector)) within the page and passes it as the first argument to pageFunction.If pageFunction returns a Promise, then page.$$eval would wait for the promise to resolve and return its value.Examples:This method runs document.querySelector within the page and passes it as the first argument to pa","href":"https://github.com/GoogleChrome/puppeteer/blob/v1.18.1/docs/api.md#pageevalselector-pagefunction-args","args":"\n<li><code>selector</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" title=\"String\" rel=\"nofollow\">string</a>> A <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Selectors\" title=\"selector\" rel=\"nofollow\">selector</a> to query page for</li>\n<li><code>pageFunction</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function\" title=\"Function\" rel=\"nofollow\">function</a>(<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array\" title=\"Array\" rel=\"nofollow\">Array</a><<a href=\"https://developer.mozilla.org/en-US/docs/Web/API/element\" title=\"Element\" rel=\"nofollow\">Element</a>>)> Function to be evaluated in browser context</li>\n<li><code>...args</code> <...<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify#Description\" title=\"Serializable\" rel=\"nofollow\">Serializable</a>|<a href=\"#class-jshandle\" title=\"JSHandle\">JSHandle</a>> Arguments to pass to <code>pageFunction</code></li>\n<li>returns: <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise\" title=\"Promise\" rel=\"nofollow\">Promise</a><<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify#Description\" title=\"Serializable\" rel=\"nofollow\">Serializable</a>>> Promise which resolves to the return value of <code>pageFunction</code></li>\n"},{"text":"$eval","description":"This method runs document.querySelector within the page and passes it as the first argument to pageFunction. If there's no element matching selector, the method throws an error.If pageFunction returns a Promise, then page.$eval would wait for the promise to resolve and return its value.Examples:Shortcut for page.mainFrame().$eval(selector, pageFunc","href":"https://github.com/GoogleChrome/puppeteer/blob/v1.18.1/docs/api.md#pageevalselector-pagefunction-args-1","args":"\n<li><code>selector</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" title=\"String\" rel=\"nofollow\">string</a>> A <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Selectors\" title=\"selector\" rel=\"nofollow\">selector</a> to query page for</li>\n<li><code>pageFunction</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function\" title=\"Function\" rel=\"nofollow\">function</a>(<a href=\"https://developer.mozilla.org/en-US/docs/Web/API/element\" title=\"Element\" rel=\"nofollow\">Element</a>)> Function to be evaluated in browser context</li>\n<li><code>...args</code> <...<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify#Description\" title=\"Serializable\" rel=\"nofollow\">Serializable</a>|<a href=\"#class-jshandle\" title=\"JSHandle\">JSHandle</a>> Arguments to pass to <code>pageFunction</code></li>\n<li>returns: <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise\" title=\"Promise\" rel=\"nofollow\">Promise</a><<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify#Description\" title=\"Serializable\" rel=\"nofollow\">Serializable</a>>> Promise which resolves to the return value of <code>pageFunction</code></li>\n"},{"text":"$x","description":"The method evaluates the XPath expression.Shortcut for page.mainFrame().$x(expression)Adds a <script> tag into the page with the desired url or content.Shortcut for page.mainFrame().addScriptTag(options).Adds a <link rel=\"stylesheet\"> tag into the page with the desired url or a <style type=\"text/css\"> tag with the content.Shortcut for page.mainFram","href":"https://github.com/GoogleChrome/puppeteer/blob/v1.18.1/docs/api.md#pagexexpression","args":"\n<li><code>expression</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" title=\"String\" rel=\"nofollow\">string</a>> Expression to <a href=\"https://developer.mozilla.org/en-US/docs/Web/API/Document/evaluate\" rel=\"nofollow\">evaluate</a>.</li>\n<li>returns: <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise\" title=\"Promise\" rel=\"nofollow\">Promise</a><<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array\" title=\"Array\" rel=\"nofollow\">Array</a><<a href=\"#class-elementhandle\" title=\"ElementHandle\">ElementHandle</a>>>></li>\n"},{"text":"accessibility","description":"Adds a <script> tag into the page with the desired url or content.Shortcut for page.mainFrame().addScriptTag(options).Adds a <link rel=\"stylesheet\"> tag into the page with the desired url or a <style type=\"text/css\"> tag with the content.Shortcut for page.mainFrame().addStyleTag(options).Provide credentials for HTTP authentication.To disable authen","href":"https://github.com/GoogleChrome/puppeteer/blob/v1.18.1/docs/api.md#pageaccessibility","args":"\n<li>returns: <<a href=\"#class-accessibility\" title=\"Accessibility\">Accessibility</a>></li>\n"},{"text":"addScriptTag","description":"Adds a <script> tag into the page with the desired url or content.Shortcut for page.mainFrame().addScriptTag(options).Adds a <link rel=\"stylesheet\"> tag into the page with the desired url or a <style type=\"text/css\"> tag with the content.Shortcut for page.mainFrame().addStyleTag(options).Provide credentials for HTTP authentication.To disable authen","href":"https://github.com/GoogleChrome/puppeteer/blob/v1.18.1/docs/api.md#pageaddscripttagoptions","args":"\n<li><code>options</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object\" title=\"Object\" rel=\"nofollow\">Object</a>>\n<ul>\n<li><code>url</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" title=\"String\" rel=\"nofollow\">string</a>> URL of a script to be added.</li>\n<li><code>path</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" title=\"String\" rel=\"nofollow\">string</a>> Path to the JavaScript file to be injected into frame. If <code>path</code> is a relative path, then it is resolved relative to <a href=\"https://nodejs.org/api/process.html#process_process_cwd\" rel=\"nofollow\">current working directory</a>.</li>\n<li><code>content</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" title=\"String\" rel=\"nofollow\">string</a>> Raw JavaScript content to be injected into frame.</li>\n<li><code>type</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" title=\"String\" rel=\"nofollow\">string</a>> Script type. Use 'module' in order to load a Javascript ES6 module. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/HTML/Element/script\" rel=\"nofollow\">script</a> for more details.</li>\n</ul>\n</li>\n<li>returns: <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise\" title=\"Promise\" rel=\"nofollow\">Promise</a><<a href=\"#class-elementhandle\" title=\"ElementHandle\">ElementHandle</a>>> which resolves to the added tag when the script's onload fires or when the script content was injected into frame.</li>\n"},{"text":"addStyleTag","description":"Adds a <link rel=\"stylesheet\"> tag into the page with the desired url or a <style type=\"text/css\"> tag with the content.Shortcut for page.mainFrame().addStyleTag(options).Provide credentials for HTTP authentication.To disable authentication, pass null.Brings page to front (activates tab).Get the browser the page belongs to.Get the browser context t","href":"https://github.com/GoogleChrome/puppeteer/blob/v1.18.1/docs/api.md#pageaddstyletagoptions","args":"\n<li><code>options</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object\" title=\"Object\" rel=\"nofollow\">Object</a>>\n<ul>\n<li><code>url</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" title=\"String\" rel=\"nofollow\">string</a>> URL of the <code><link></code> tag.</li>\n<li><code>path</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" title=\"String\" rel=\"nofollow\">string</a>> Path to the CSS file to be injected into frame. If <code>path</code> is a relative path, then it is resolved relative to <a href=\"https://nodejs.org/api/process.html#process_process_cwd\" rel=\"nofollow\">current working directory</a>.</li>\n<li><code>content</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" title=\"String\" rel=\"nofollow\">string</a>> Raw CSS content to be injected into frame.</li>\n</ul>\n</li>\n<li>returns: <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise\" title=\"Promise\" rel=\"nofollow\">Promise</a><<a href=\"#class-elementhandle\" title=\"ElementHandle\">ElementHandle</a>>> which resolves to the added tag when the stylesheet's onload fires or when the CSS content was injected into frame.</li>\n"},{"text":"authenticate","description":"Provide credentials for HTTP authentication.To disable authentication, pass null.Brings page to front (activates tab).Get the browser the page belongs to.Get the browser context that the page belongs to.This method fetches an element with selector, scrolls it into view if needed, and then uses page.mouse to click in the center of the element. If th","href":"https://github.com/GoogleChrome/puppeteer/blob/v1.18.1/docs/api.md#pageauthenticatecredentials","args":"\n<li><code>credentials</code> <?<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object\" title=\"Object\" rel=\"nofollow\">Object</a>>\n<ul>\n<li><code>username</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" title=\"String\" rel=\"nofollow\">string</a>></li>\n<li><code>password</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" title=\"String\" rel=\"nofollow\">string</a>></li>\n</ul>\n</li>\n<li>returns: <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise\" title=\"Promise\" rel=\"nofollow\">Promise</a>></li>\n"},{"text":"bringToFront","description":"Brings page to front (activates tab).Get the browser the page belongs to.Get the browser context that the page belongs to.This method fetches an element with selector, scrolls it into view if needed, and then uses page.mouse to click in the center of the element. If there's no element matching selector, the method throws an error.Bear in mind that ","href":"https://github.com/GoogleChrome/puppeteer/blob/v1.18.1/docs/api.md#pagebringtofront","args":"\n<li>returns: <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise\" title=\"Promise\" rel=\"nofollow\">Promise</a>></li>\n"},{"text":"browser","description":"Get the browser the page belongs to.Get the browser context that the page belongs to.This method fetches an element with selector, scrolls it into view if needed, and then uses page.mouse to click in the center of the element. If there's no element matching selector, the method throws an error.Bear in mind that if click() triggers a navigation even","href":"https://github.com/GoogleChrome/puppeteer/blob/v1.18.1/docs/api.md#pagebrowser","args":"\n<li>returns: <<a href=\"#class-browser\" title=\"Browser\">Browser</a>></li>\n"},{"text":"browserContext","description":"Get the browser context that the page belongs to.This method fetches an element with selector, scrolls it into view if needed, and then uses page.mouse to click in the center of the element. If there's no element matching selector, the method throws an error.Bear in mind that if click() triggers a navigation event and there's a separate page.waitFo","href":"https://github.com/GoogleChrome/puppeteer/blob/v1.18.1/docs/api.md#pagebrowsercontext","args":"\n<li>returns: <<a href=\"#class-browsercontext\" title=\"BrowserContext\">BrowserContext</a>></li>\n"},{"text":"click","description":"This method fetches an element with selector, scrolls it into view if needed, and then uses page.mouse to click in the center of the element. If there's no element matching selector, the method throws an error.Bear in mind that if click() triggers a navigation event and there's a separate page.waitForNavigation() promise to be resolved, you may end","href":"https://github.com/GoogleChrome/puppeteer/blob/v1.18.1/docs/api.md#pageclickselector-options","args":"\n<li><code>selector</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" title=\"String\" rel=\"nofollow\">string</a>> A <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Selectors\" title=\"selector\" rel=\"nofollow\">selector</a> to search for element to click. If there are multiple elements satisfying the selector, the first will be clicked.</li>\n<li><code>options</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object\" title=\"Object\" rel=\"nofollow\">Object</a>>\n<ul>\n<li><code>button</code> <\"left\"|\"right\"|\"middle\"> Defaults to <code>left</code>.</li>\n<li><code>clickCount</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type\" title=\"Number\" rel=\"nofollow\">number</a>> defaults to 1. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/API/UIEvent/detail\" title=\"UIEvent.detail\" rel=\"nofollow\">UIEvent.detail</a>.</li>\n<li><code>delay</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type\" title=\"Number\" rel=\"nofollow\">number</a>> Time to wait between <code>mousedown</code> and <code>mouseup</code> in milliseconds. Defaults to 0.</li>\n</ul>\n</li>\n<li>returns: <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise\" title=\"Promise\" rel=\"nofollow\">Promise</a>> Promise which resolves when the element matching <code>selector</code> is successfully clicked. The Promise will be rejected if there is no element matching <code>selector</code>.</li>\n"},{"text":"close","description":"By default, page.close() does not run beforeunload handlers.Gets the full HTML contents of the page, including the doctype.If no URLs are specified, this method returns cookies for the current page URL. If URLs are specified, only cookies for those URLs are returned.Emulates given device metrics and user agent. This method is a shortcut for calling","href":"https://github.com/GoogleChrome/puppeteer/blob/v1.18.1/docs/api.md#pagecloseoptions","args":"\n<li><code>options</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object\" title=\"Object\" rel=\"nofollow\">Object</a>>\n<ul>\n<li><code>runBeforeUnload</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type\" title=\"Boolean\" rel=\"nofollow\">boolean</a>> Defaults to <code>false</code>. Whether to run the\n<a href=\"https://developer.mozilla.org/en-US/docs/Web/Events/beforeunload\" rel=\"nofollow\">before unload</a>\npage handlers.</li>\n</ul>\n</li>\n<li>returns: <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise\" title=\"Promise\" rel=\"nofollow\">Promise</a>></li>\n"},{"text":"content","description":"Gets the full HTML contents of the page, including the doctype.If no URLs are specified, this method returns cookies for the current page URL. If URLs are specified, only cookies for those URLs are returned.Emulates given device metrics and user agent. This method is a shortcut for calling two methods:To aid emulation, puppeteer provides a list of ","href":"https://github.com/GoogleChrome/puppeteer/blob/v1.18.1/docs/api.md#pagecontent","args":"\n<li>returns: <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise\" title=\"Promise\" rel=\"nofollow\">Promise</a><<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" title=\"String\" rel=\"nofollow\">string</a>>></li>\n"},{"text":"cookies","description":"If no URLs are specified, this method returns cookies for the current page URL. If URLs are specified, only cookies for those URLs are returned.Emulates given device metrics and user agent. This method is a shortcut for calling two methods:To aid emulation, puppeteer provides a list of device descriptors which can be obtained via the puppeteer.devi","href":"https://github.com/GoogleChrome/puppeteer/blob/v1.18.1/docs/api.md#pagecookiesurls","args":"\n<li><code>...urls</code> <...<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" title=\"String\" rel=\"nofollow\">string</a>></li>\n<li>returns: <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise\" title=\"Promise\" rel=\"nofollow\">Promise</a><<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array\" title=\"Array\" rel=\"nofollow\">Array</a><<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object\" title=\"Object\" rel=\"nofollow\">Object</a>>>>\n<ul>\n<li><code>name</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" title=\"String\" rel=\"nofollow\">string</a>></li>\n<li><code>value</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" title=\"String\" rel=\"nofollow\">string</a>></li>\n<li><code>domain</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" title=\"String\" rel=\"nofollow\">string</a>></li>\n<li><code>path</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" title=\"String\" rel=\"nofollow\">string</a>></li>\n<li><code>expires</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type\" title=\"Number\" rel=\"nofollow\">number</a>> Unix time in seconds.</li>\n<li><code>size</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type\" title=\"Number\" rel=\"nofollow\">number</a>></li>\n<li><code>httpOnly</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type\" title=\"Boolean\" rel=\"nofollow\">boolean</a>></li>\n<li><code>secure</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type\" title=\"Boolean\" rel=\"nofollow\">boolean</a>></li>\n<li><code>session</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type\" title=\"Boolean\" rel=\"nofollow\">boolean</a>></li>\n<li><code>sameSite</code> <\"Strict\"|\"Lax\"|\"Extended\"|\"None\"></li>\n</ul>\n</li>\n"},{"text":"coverage","description":"Emulates given device metrics and user agent. This method is a shortcut for calling two methods:To aid emulation, puppeteer provides a list of device descriptors which can be obtained via the puppeteer.devices.page.emulate will resize the page. A lot of websites don't expect phones to change size, so you should emulate before navigating to the page","href":"https://github.com/GoogleChrome/puppeteer/blob/v1.18.1/docs/api.md#pagecoverage","args":"\n<li>returns: <<a href=\"#class-coverage\" title=\"Coverage\">Coverage</a>></li>\n"},{"text":"deleteCookie","description":"Emulates given device metrics and user agent. This method is a shortcut for calling two methods:To aid emulation, puppeteer provides a list of device descriptors which can be obtained via the puppeteer.devices.page.emulate will resize the page. A lot of websites don't expect phones to change size, so you should emulate before navigating to the page","href":"https://github.com/GoogleChrome/puppeteer/blob/v1.18.1/docs/api.md#pagedeletecookiecookies","args":"\n<li><code>...cookies</code> <...<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object\" title=\"Object\" rel=\"nofollow\">Object</a>>\n<ul>\n<li><code>name</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" title=\"String\" rel=\"nofollow\">string</a>> <strong>required</strong></li>\n<li><code>url</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" title=\"String\" rel=\"nofollow\">string</a>></li>\n<li><code>domain</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" title=\"String\" rel=\"nofollow\">string</a>></li>\n<li><code>path</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" title=\"String\" rel=\"nofollow\">string</a>></li>\n</ul>\n</li>\n<li>returns: <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise\" title=\"Promise\" rel=\"nofollow\">Promise</a>></li>\n"},{"text":"emulate","description":"Emulates given device metrics and user agent. This method is a shortcut for calling two methods:To aid emulation, puppeteer provides a list of device descriptors which can be obtained via the puppeteer.devices.page.emulate will resize the page. A lot of websites don't expect phones to change size, so you should emulate before navigating to the page","href":"https://github.com/GoogleChrome/puppeteer/blob/v1.18.1/docs/api.md#pageemulateoptions","args":"\n<li><code>options</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object\" title=\"Object\" rel=\"nofollow\">Object</a>>\n<ul>\n<li><code>viewport</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object\" title=\"Object\" rel=\"nofollow\">Object</a>>\n<ul>\n<li><code>width</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type\" title=\"Number\" rel=\"nofollow\">number</a>> page width in pixels.</li>\n<li><code>height</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type\" title=\"Number\" rel=\"nofollow\">number</a>> page height in pixels.</li>\n<li><code>deviceScaleFactor</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type\" title=\"Number\" rel=\"nofollow\">number</a>> Specify device scale factor (can be thought of as dpr). Defaults to <code>1</code>.</li>\n<li><code>isMobile</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type\" title=\"Boolean\" rel=\"nofollow\">boolean</a>> Whether the <code>meta viewport</code> tag is taken into account. Defaults to <code>false</code>.</li>\n<li><code>hasTouch</code><<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type\" title=\"Boolean\" rel=\"nofollow\">boolean</a>> Specifies if viewport supports touch events. Defaults to <code>false</code></li>\n<li><code>isLandscape</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type\" title=\"Boolean\" rel=\"nofollow\">boolean</a>> Specifies if viewport is in landscape mode. Defaults to <code>false</code>.</li>\n</ul>\n</li>\n<li><code>userAgent</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" title=\"String\" rel=\"nofollow\">string</a>></li>\n</ul>\n</li>\n<li>returns: <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise\" title=\"Promise\" rel=\"nofollow\">Promise</a>></li>\n"},{"text":"emulateMedia","description":"If the function passed to the page.evaluate returns a Promise, then page.evaluate would wait for the promise to resolve and return its value.If the function passed to the page.evaluate returns a non-Serializable value, then page.evaluate resolves to undefined. DevTools Protocol also supports transferring some additional values that are not serializ","href":"https://github.com/GoogleChrome/puppeteer/blob/v1.18.1/docs/api.md#pageemulatemediamediatype","args":"\n<li><code>mediaType</code> <?<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" title=\"String\" rel=\"nofollow\">string</a>> Changes the CSS media type of the page. The only allowed values are <code>'screen'</code>, <code>'print'</code> and <code>null</code>. Passing <code>null</code> disables media emulation.</li>\n<li>returns: <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise\" title=\"Promise\" rel=\"nofollow\">Promise</a>></li>\n"},{"text":"evaluate","description":"If the function passed to the page.evaluate returns a Promise, then page.evaluate would wait for the promise to resolve and return its value.If the function passed to the page.evaluate returns a non-Serializable value, then page.evaluate resolves to undefined. DevTools Protocol also supports transferring some additional values that are not serializ","href":"https://github.com/GoogleChrome/puppeteer/blob/v1.18.1/docs/api.md#pageevaluatepagefunction-args","args":"\n<li><code>pageFunction</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function\" title=\"Function\" rel=\"nofollow\">function</a>|<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" title=\"String\" rel=\"nofollow\">string</a>> Function to be evaluated in the page context</li>\n<li><code>...args</code> <...<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify#Description\" title=\"Serializable\" rel=\"nofollow\">Serializable</a>|<a href=\"#class-jshandle\" title=\"JSHandle\">JSHandle</a>> Arguments to pass to <code>pageFunction</code></li>\n<li>returns: <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise\" title=\"Promise\" rel=\"nofollow\">Promise</a><<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify#Description\" title=\"Serializable\" rel=\"nofollow\">Serializable</a>>> Promise which resolves to the return value of <code>pageFunction</code></li>\n"},{"text":"evaluateHandle","description":"The only difference between page.evaluate and page.evaluateHandle is that page.evaluateHandle returns in-page object (JSHandle).If the function passed to the page.evaluateHandle returns a Promise, then page.evaluateHandle would wait for the promise to resolve and return its value.A string can also be passed in instead of a function:JSHandle instanc","href":"https://github.com/GoogleChrome/puppeteer/blob/v1.18.1/docs/api.md#pageevaluatehandlepagefunction-args","args":"\n<li><code>pageFunction</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function\" title=\"Function\" rel=\"nofollow\">function</a>|<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" title=\"String\" rel=\"nofollow\">string</a>> Function to be evaluated in the page context</li>\n<li><code>...args</code> <...<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify#Description\" title=\"Serializable\" rel=\"nofollow\">Serializable</a>|<a href=\"#class-jshandle\" title=\"JSHandle\">JSHandle</a>> Arguments to pass to <code>pageFunction</code></li>\n<li>returns: <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise\" title=\"Promise\" rel=\"nofollow\">Promise</a><<a href=\"#class-jshandle\" title=\"JSHandle\">JSHandle</a>>> Promise which resolves to the return value of <code>pageFunction</code> as in-page object (JSHandle)</li>\n"},{"text":"evaluateOnNewDocument","description":"Adds a function which would be invoked in one of the following scenarios:The function is invoked after the document was created but before any of its scripts were run. This is useful to amend the JavaScript environment, e.g. to seed Math.random.An example of overriding the navigator.languages property before the page loads:The method adds a functi","href":"https://github.com/GoogleChrome/puppeteer/blob/v1.18.1/docs/api.md#pageevaluateonnewdocumentpagefunction-args","args":"\n<li><code>pageFunction</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function\" title=\"Function\" rel=\"nofollow\">function</a>|<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" title=\"String\" rel=\"nofollow\">string</a>> Function to be evaluated in browser context</li>\n<li><code>...args</code> <...<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify#Description\" title=\"Serializable\" rel=\"nofollow\">Serializable</a>> Arguments to pass to <code>pageFunction</code></li>\n<li>returns: <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise\" title=\"Promise\" rel=\"nofollow\">Promise</a>></li>\n"},{"text":"exposeFunction","description":"The method adds a function called name on the page's window object. When called, the function executes puppeteerFunction in node.js and returns a Promise which resolves to the return value of puppeteerFunction.If the puppeteerFunction returns a Promise, it will be awaited.An example of adding an md5 function into the page:An example of adding a win","href":"https://github.com/GoogleChrome/puppeteer/blob/v1.18.1/docs/api.md#pageexposefunctionname-puppeteerfunction","args":"\n<li><code>name</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" title=\"String\" rel=\"nofollow\">string</a>> Name of the function on the window object</li>\n<li><code>puppeteerFunction</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function\" title=\"Function\" rel=\"nofollow\">function</a>> Callback function which will be called in Puppeteer's context.</li>\n<li>returns: <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise\" title=\"Promise\" rel=\"nofollow\">Promise</a>></li>\n"},{"text":"focus","description":"This method fetches an element with selector and focuses it. If there's no element matching selector, the method throws an error.Shortcut for page.mainFrame().focus(selector).Navigate to the previous page in history.Navigate to the next page in history.page.goto will throw an error if:page.goto will not throw an error when any valid HTTP status cod","href":"https://github.com/GoogleChrome/puppeteer/blob/v1.18.1/docs/api.md#pagefocusselector","args":"\n<li><code>selector</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" title=\"String\" rel=\"nofollow\">string</a>> A <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Selectors\" title=\"selector\" rel=\"nofollow\">selector</a> of an element to focus. If there are multiple elements satisfying the selector, the first will be focused.</li>\n<li>returns: <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise\" title=\"Promise\" rel=\"nofollow\">Promise</a>> Promise which resolves when the element matching <code>selector</code> is successfully focused. The promise will be rejected if there is no element matching <code>selector</code>.</li>\n"},{"text":"frames","description":"Navigate to the previous page in history.Navigate to the next page in history.page.goto will throw an error if:page.goto will not throw an error when any valid HTTP status code is returned by the remote server, including 404 \"Not Found\" and 500 \"Internal Server Error\". The status code for such responses can be retrieved by calling response.status(","href":"https://github.com/GoogleChrome/puppeteer/blob/v1.18.1/docs/api.md#pageframes","args":"\n<li>returns: <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array\" title=\"Array\" rel=\"nofollow\">Array</a><<a href=\"#class-frame\" title=\"Frame\">Frame</a>>> An array of all frames attached to the page.</li>\n"},{"text":"goBack","description":"Navigate to the previous page in history.Navigate to the next page in history.page.goto will throw an error if:page.goto will not throw an error when any valid HTTP status code is returned by the remote server, including 404 \"Not Found\" and 500 \"Internal Server Error\". The status code for such responses can be retrieved by calling response.status(","href":"https://github.com/GoogleChrome/puppeteer/blob/v1.18.1/docs/api.md#pagegobackoptions","args":"\n<li><code>options</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object\" title=\"Object\" rel=\"nofollow\">Object</a>> Navigation parameters which might have the following properties:\n<ul>\n<li><code>timeout</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type\" title=\"Number\" rel=\"nofollow\">number</a>> Maximum navigation time in milliseconds, defaults to 30 seconds, pass <code>0</code> to disable timeout. The default value can be changed by using the <a href=\"#pagesetdefaultnavigationtimeouttimeout\">page.setDefaultNavigationTimeout(timeout)</a> or <a href=\"#pagesetdefaulttimeouttimeout\">page.setDefaultTimeout(timeout)</a> methods.</li>\n<li><code>waitUntil</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" title=\"String\" rel=\"nofollow\">string</a>|<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array\" title=\"Array\" rel=\"nofollow\">Array</a><<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" title=\"String\" rel=\"nofollow\">string</a>>> When to consider navigation succeeded, defaults to <code>load</code>. Given an array of event strings, navigation is considered to be successful after all events have been fired. Events can be either:\n<ul>\n<li><code>load</code> - consider navigation to be finished when the <code>load</code> event is fired.</li>\n<li><code>domcontentloaded</code> - consider navigation to be finished when the <code>DOMContentLoaded</code> event is fired.</li>\n<li><code>networkidle0</code> - consider navigation to be finished when there are no more than 0 network connections for at least <code>500</code> ms.</li>\n<li><code>networkidle2</code> - consider navigation to be finished when there are no more than 2 network connections for at least <code>500</code> ms.</li>\n</ul>\n</li>\n</ul>\n</li>\n<li>returns: <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise\" title=\"Promise\" rel=\"nofollow\">Promise</a><?<a href=\"#class-response\" title=\"Response\">Response</a>>> Promise which resolves to the main resource response. In case of multiple redirects, the navigation will resolve with the response of the last redirect. If\ncan not go back, resolves to <code>null</code>.</li>\n"},{"text":"goForward","description":"Navigate to the next page in history.page.goto will throw an error if:page.goto will not throw an error when any valid HTTP status code is returned by the remote server, including 404 \"Not Found\" and 500 \"Internal Server Error\". The status code for such responses can be retrieved by calling response.status().Shortcut for page.mainFrame().goto(url,","href":"https://github.com/GoogleChrome/puppeteer/blob/v1.18.1/docs/api.md#pagegoforwardoptions","args":"\n<li><code>options</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object\" title=\"Object\" rel=\"nofollow\">Object</a>> Navigation parameters which might have the following properties:\n<ul>\n<li><code>timeout</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type\" title=\"Number\" rel=\"nofollow\">number</a>> Maximum navigation time in milliseconds, defaults to 30 seconds, pass <code>0</code> to disable timeout. The default value can be changed by using the <a href=\"#pagesetdefaultnavigationtimeouttimeout\">page.setDefaultNavigationTimeout(timeout)</a> or <a href=\"#pagesetdefaulttimeouttimeout\">page.setDefaultTimeout(timeout)</a> methods.</li>\n<li><code>waitUntil</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" title=\"String\" rel=\"nofollow\">string</a>|<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array\" title=\"Array\" rel=\"nofollow\">Array</a><<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" title=\"String\" rel=\"nofollow\">string</a>>> When to consider navigation succeeded, defaults to <code>load</code>. Given an array of event strings, navigation is considered to be successful after all events have been fired. Events can be either:\n<ul>\n<li><code>load</code> - consider navigation to be finished when the <code>load</code> event is fired.</li>\n<li><code>domcontentloaded</code> - consider navigation to be finished when the <code>DOMContentLoaded</code> event is fired.</li>\n<li><code>networkidle0</code> - consider navigation to be finished when there are no more than 0 network connections for at least <code>500</code> ms.</li>\n<li><code>networkidle2</code> - consider navigation to be finished when there are no more than 2 network connections for at least <code>500</code> ms.</li>\n</ul>\n</li>\n</ul>\n</li>\n<li>returns: <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise\" title=\"Promise\" rel=\"nofollow\">Promise</a><?<a href=\"#class-response\" title=\"Response\">Response</a>>> Promise which resolves to the main resource response. In case of multiple redirects, the navigation will resolve with the response of the last redirect. If\ncan not go forward, resolves to <code>null</code>.</li>\n"},{"text":"goto","description":"page.goto will throw an error if:page.goto will not throw an error when any valid HTTP status code is returned by the remote server, including 404 \"Not Found\" and 500 \"Internal Server Error\". The status code for such responses can be retrieved by calling response.status().Shortcut for page.mainFrame().goto(url, options)This method fetches an eleme","href":"https://github.com/GoogleChrome/puppeteer/blob/v1.18.1/docs/api.md#pagegotourl-options","args":"\n<li><code>url</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" title=\"String\" rel=\"nofollow\">string</a>> URL to navigate page to. The url should include scheme, e.g. <code>https://</code>.</li>\n<li><code>options</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object\" title=\"Object\" rel=\"nofollow\">Object</a>> Navigation parameters which might have the following properties:\n<ul>\n<li><code>timeout</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type\" title=\"Number\" rel=\"nofollow\">number</a>> Maximum navigation time in milliseconds, defaults to 30 seconds, pass <code>0</code> to disable timeout. The default value can be changed by using the <a href=\"#pagesetdefaultnavigationtimeouttimeout\">page.setDefaultNavigationTimeout(timeout)</a> or <a href=\"#pagesetdefaulttimeouttimeout\">page.setDefaultTimeout(timeout)</a> methods.</li>\n<li><code>waitUntil</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" title=\"String\" rel=\"nofollow\">string</a>|<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array\" title=\"Array\" rel=\"nofollow\">Array</a><<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" title=\"String\" rel=\"nofollow\">string</a>>> When to consider navigation succeeded, defaults to <code>load</code>. Given an array of event strings, navigation is considered to be successful after all events have been fired. Events can be either:\n<ul>\n<li><code>load</code> - consider navigation to be finished when the <code>load</code> event is fired.</li>\n<li><code>domcontentloaded</code> - consider navigation to be finished when the <code>DOMContentLoaded</code> event is fired.</li>\n<li><code>networkidle0</code> - consider navigation to be finished when there are no more than 0 network connections for at least <code>500</code> ms.</li>\n<li><code>networkidle2</code> - consider navigation to be finished when there are no more than 2 network connections for at least <code>500</code> ms.</li>\n</ul>\n</li>\n<li><code>referer</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" title=\"String\" rel=\"nofollow\">string</a>> Referer header value. If provided it will take preference over the referer header value set by <a href=\"#pagesetextrahttpheadersheaders\">page.setExtraHTTPHeaders()</a>.</li>\n</ul>\n</li>\n<li>returns: <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise\" title=\"Promise\" rel=\"nofollow\">Promise</a><?<a href=\"#class-response\" title=\"Response\">Response</a>>> Promise which resolves to the main resource response. In case of multiple redirects, the navigation will resolve with the response of the last redirect.</li>\n"},{"text":"hover","description":"This method fetches an element with selector, scrolls it into view if needed, and then uses page.mouse to hover over the center of the element. If there's no element matching selector, the method throws an error.Shortcut for page.mainFrame().hover(selector).Indicates that the page has been closed.Page is guaranteed to have a main frame which persis","href":"https://github.com/GoogleChrome/puppeteer/blob/v1.18.1/docs/api.md#pagehoverselector","args":"\n<li><code>selector</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" title=\"String\" rel=\"nofollow\">string</a>> A <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Selectors\" title=\"selector\" rel=\"nofollow\">selector</a> to search for element to hover. If there are multiple elements satisfying the selector, the first will be hovered.</li>\n<li>returns: <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise\" title=\"Promise\" rel=\"nofollow\">Promise</a>> Promise which resolves when the element matching <code>selector</code> is successfully hovered. Promise gets rejected if there's no element matching <code>selector</code>.</li>\n"},{"text":"isClosed","description":"Indicates that the page has been closed.Page is guaranteed to have a main frame which persists during navigations.page.pdf() generates a pdf of the page with print css media. To generate a pdf with screen media, call page.emulateMedia('screen') before calling page.pdf():The width, height, and margin options accept values labeled with units. Unlabel","href":"https://github.com/GoogleChrome/puppeteer/blob/v1.18.1/docs/api.md#pageisclosed","args":"\n<li>returns: <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type\" title=\"Boolean\" rel=\"nofollow\">boolean</a>></li>\n"},{"text":"keyboard","description":"Page is guaranteed to have a main frame which persists during navigations.page.pdf() generates a pdf of the page with print css media. To generate a pdf with screen media, call page.emulateMedia('screen') before calling page.pdf():The width, height, and margin options accept values labeled with units. Unlabeled values are treated as pixels.A few ex","href":"https://github.com/GoogleChrome/puppeteer/blob/v1.18.1/docs/api.md#pagekeyboard","args":"\n<li>returns: <<a href=\"#class-keyboard\" title=\"Keyboard\">Keyboard</a>></li>\n"},{"text":"mainFrame","description":"Page is guaranteed to have a main frame which persists during navigations.page.pdf() generates a pdf of the page with print css media. To generate a pdf with screen media, call page.emulateMedia('screen') before calling page.pdf():The width, height, and margin options accept values labeled with units. Unlabeled values are treated as pixels.A few ex","href":"https://github.com/GoogleChrome/puppeteer/blob/v1.18.1/docs/api.md#pagemainframe","args":"\n<li>returns: <<a href=\"#class-frame\" title=\"Frame\">Frame</a>> The page's main frame.</li>\n"},{"text":"metrics","description":"page.pdf() generates a pdf of the page with print css media. To generate a pdf with screen media, call page.emulateMedia('screen') before calling page.pdf():The width, height, and margin options accept values labeled with units. Unlabeled values are treated as pixels.A few examples:All possible units are:The format options are:The method iterates t","href":"https://github.com/GoogleChrome/puppeteer/blob/v1.18.1/docs/api.md#pagemetrics","args":"\n<li>returns: <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise\" title=\"Promise\" rel=\"nofollow\">Promise</a><<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object\" title=\"Object\" rel=\"nofollow\">Object</a>>> Object containing metrics as key/value pairs.\n<ul>\n<li><code>Timestamp</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type\" title=\"Number\" rel=\"nofollow\">number</a>> The timestamp when the metrics sample was taken.</li>\n<li><code>Documents</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type\" title=\"Number\" rel=\"nofollow\">number</a>> Number of documents in the page.</li>\n<li><code>Frames</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type\" title=\"Number\" rel=\"nofollow\">number</a>> Number of frames in the page.</li>\n<li><code>JSEventListeners</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type\" title=\"Number\" rel=\"nofollow\">number</a>> Number of events in the page.</li>\n<li><code>Nodes</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type\" title=\"Number\" rel=\"nofollow\">number</a>> Number of DOM nodes in the page.</li>\n<li><code>LayoutCount</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type\" title=\"Number\" rel=\"nofollow\">number</a>> Total number of full or partial page layout.</li>\n<li><code>RecalcStyleCount</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type\" title=\"Number\" rel=\"nofollow\">number</a>> Total number of page style recalculations.</li>\n<li><code>LayoutDuration</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type\" title=\"Number\" rel=\"nofollow\">number</a>> Combined durations of all page layouts.</li>\n<li><code>RecalcStyleDuration</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type\" title=\"Number\" rel=\"nofollow\">number</a>> Combined duration of all page style recalculations.</li>\n<li><code>ScriptDuration</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type\" title=\"Number\" rel=\"nofollow\">number</a>> Combined duration of JavaScript execution.</li>\n<li><code>TaskDuration</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type\" title=\"Number\" rel=\"nofollow\">number</a>> Combined duration of all tasks performed by the browser.</li>\n<li><code>JSHeapUsedSize</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type\" title=\"Number\" rel=\"nofollow\">number</a>> Used JavaScript heap size.</li>\n<li><code>JSHeapTotalSize</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type\" title=\"Number\" rel=\"nofollow\">number</a>> Total JavaScript heap size.</li>\n</ul>\n</li>\n"},{"text":"mouse","description":"page.pdf() generates a pdf of the page with print css media. To generate a pdf with screen media, call page.emulateMedia('screen') before calling page.pdf():The width, height, and margin options accept values labeled with units. Unlabeled values are treated as pixels.A few examples:All possible units are:The format options are:The method iterates t","href":"https://github.com/GoogleChrome/puppeteer/blob/v1.18.1/docs/api.md#pagemouse","args":"\n<li>returns: <<a href=\"#class-mouse\" title=\"Mouse\">Mouse</a>></li>\n"},{"text":"pdf","description":"page.pdf() generates a pdf of the page with print css media. To generate a pdf with screen media, call page.emulateMedia('screen') before calling page.pdf():The width, height, and margin options accept values labeled with units. Unlabeled values are treated as pixels.A few examples:All possible units are:The format options are:The method iterates t","href":"https://github.com/GoogleChrome/puppeteer/blob/v1.18.1/docs/api.md#pagepdfoptions","args":"\n<li><code>options</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object\" title=\"Object\" rel=\"nofollow\">Object</a>> Options object which might have the following properties:\n<ul>\n<li><code>path</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" title=\"String\" rel=\"nofollow\">string</a>> The file path to save the PDF to. If <code>path</code> is a relative path, then it is resolved relative to <a href=\"https://nodejs.org/api/process.html#process_process_cwd\" rel=\"nofollow\">current working directory</a>. If no path is provided, the PDF won't be saved to the disk.</li>\n<li><code>scale</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type\" title=\"Number\" rel=\"nofollow\">number</a>> Scale of the webpage rendering. Defaults to <code>1</code>. Scale amount must be between 0.1 and 2.</li>\n<li><code>displayHeaderFooter</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type\" title=\"Boolean\" rel=\"nofollow\">boolean</a>> Display header and footer. Defaults to <code>false</code>.</li>\n<li><code>headerTemplate</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" title=\"String\" rel=\"nofollow\">string</a>> HTML template for the print header. Should be valid HTML markup with following classes used to inject printing values into them:\n<ul>\n<li><code>date</code> formatted print date</li>\n<li><code>title</code> document title</li>\n<li><code>url</code> document location</li>\n<li><code>pageNumber</code> current page number</li>\n<li><code>totalPages</code> total pages in the document</li>\n</ul>\n</li>\n<li><code>footerTemplate</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" title=\"String\" rel=\"nofollow\">string</a>> HTML template for the print footer. Should use the same format as the <code>headerTemplate</code>.</li>\n<li><code>printBackground</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type\" title=\"Boolean\" rel=\"nofollow\">boolean</a>> Print background graphics. Defaults to <code>false</code>.</li>\n<li><code>landscape</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type\" title=\"Boolean\" rel=\"nofollow\">boolean</a>> Paper orientation. Defaults to <code>false</code>.</li>\n<li><code>pageRanges</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" title=\"String\" rel=\"nofollow\">string</a>> Paper ranges to print, e.g., '1-5, 8, 11-13'. Defaults to the empty string, which means print all pages.</li>\n<li><code>format</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" title=\"String\" rel=\"nofollow\">string</a>> Paper format. If set, takes priority over <code>width</code> or <code>height</code> options. Defaults to 'Letter'.</li>\n<li><code>width</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" title=\"String\" rel=\"nofollow\">string</a>|<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type\" title=\"Number\" rel=\"nofollow\">number</a>> Paper width, accepts values labeled with units.</li>\n<li><code>height</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" title=\"String\" rel=\"nofollow\">string</a>|<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type\" title=\"Number\" rel=\"nofollow\">number</a>> Paper height, accepts values labeled with units.</li>\n<li><code>margin</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object\" title=\"Object\" rel=\"nofollow\">Object</a>> Paper margins, defaults to none.\n<ul>\n<li><code>top</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" title=\"String\" rel=\"nofollow\">string</a>|<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type\" title=\"Number\" rel=\"nofollow\">number</a>> Top margin, accepts values labeled with units.</li>\n<li><code>right</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" title=\"String\" rel=\"nofollow\">string</a>|<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type\" title=\"Number\" rel=\"nofollow\">number</a>> Right margin, accepts values labeled with units.</li>\n<li><code>bottom</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" title=\"String\" rel=\"nofollow\">string</a>|<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type\" title=\"Number\" rel=\"nofollow\">number</a>> Bottom margin, accepts values labeled with units.</li>\n<li><code>left</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" title=\"String\" rel=\"nofollow\">string</a>|<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type\" title=\"Number\" rel=\"nofollow\">number</a>> Left margin, accepts values labeled with units.</li>\n</ul>\n</li>\n<li><code>preferCSSPageSize</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type\" title=\"Boolean\" rel=\"nofollow\">boolean</a>> Give any CSS <code>@page</code> size declared in the page priority over what is declared in <code>width</code> and <code>height</code> or <code>format</code> options. Defaults to <code>false</code>, which will scale the content to fit the paper size.</li>\n</ul>\n</li>\n<li>returns: <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise\" title=\"Promise\" rel=\"nofollow\">Promise</a><<a href=\"https://nodejs.org/api/buffer.html#buffer_class_buffer\" title=\"Buffer\" rel=\"nofollow\">Buffer</a>>> Promise which resolves with PDF buffer.</li>\n"},{"text":"queryObjects","description":"The method iterates the JavaScript heap and finds all the objects with the given prototype.Shortcut for page.mainFrame().executionContext().queryObjects(prototypeHandle).Triggers a change and input event once all the provided options have been selected. If there's no <select> element matching selector, the method throws an error.Shortcut for page.m","href":"https://github.com/GoogleChrome/puppeteer/blob/v1.18.1/docs/api.md#pagequeryobjectsprototypehandle","args":"\n<li><code>prototypeHandle</code> <<a href=\"#class-jshandle\" title=\"JSHandle\">JSHandle</a>> A handle to the object prototype.</li>\n<li>returns: <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise\" title=\"Promise\" rel=\"nofollow\">Promise</a><<a href=\"#class-jshandle\" title=\"JSHandle\">JSHandle</a>>> Promise which resolves to a handle to an array of objects with this prototype.</li>\n"},{"text":"reload","description":"Triggers a change and input event once all the provided options have been selected. If there's no <select> element matching selector, the method throws an error.Shortcut for page.mainFrame().select()Toggles bypassing page's Content-Security-Policy.Toggles ignoring cache for each request based on the enabled state. By default, caching is enabled.Thi","href":"https://github.com/GoogleChrome/puppeteer/blob/v1.18.1/docs/api.md#pagereloadoptions","args":"\n<li><code>options</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object\" title=\"Object\" rel=\"nofollow\">Object</a>> Navigation parameters which might have the following properties:\n<ul>\n<li><code>timeout</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type\" title=\"Number\" rel=\"nofollow\">number</a>> Maximum navigation time in milliseconds, defaults to 30 seconds, pass <code>0</code> to disable timeout. The default value can be changed by using the <a href=\"#pagesetdefaultnavigationtimeouttimeout\">page.setDefaultNavigationTimeout(timeout)</a> or <a href=\"#pagesetdefaulttimeouttimeout\">page.setDefaultTimeout(timeout)</a> methods.</li>\n<li><code>waitUntil</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" title=\"String\" rel=\"nofollow\">string</a>|<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array\" title=\"Array\" rel=\"nofollow\">Array</a><<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" title=\"String\" rel=\"nofollow\">string</a>>> When to consider navigation succeeded, defaults to <code>load</code>. Given an array of event strings, navigation is considered to be successful after all events have been fired. Events can be either:\n<ul>\n<li><code>load</code> - consider navigation to be finished when the <code>load</code> event is fired.</li>\n<li><code>domcontentloaded</code> - consider navigation to be finished when the <code>DOMContentLoaded</code> event is fired.</li>\n<li><code>networkidle0</code> - consider navigation to be finished when there are no more than 0 network connections for at least <code>500</code> ms.</li>\n<li><code>networkidle2</code> - consider navigation to be finished when there are no more than 2 network connections for at least <code>500</code> ms.</li>\n</ul>\n</li>\n</ul>\n</li>\n<li>returns: <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise\" title=\"Promise\" rel=\"nofollow\">Promise</a><<a href=\"#class-response\" title=\"Response\">Response</a>>> Promise which resolves to the main resource response. In case of multiple redirects, the navigation will resolve with the response of the last redirect.</li>\n"},{"text":"screenshot","description":"Triggers a change and input event once all the provided options have been selected. If there's no <select> element matching selector, the method throws an error.Shortcut for page.mainFrame().select()Toggles bypassing page's Content-Security-Policy.Toggles ignoring cache for each request based on the enabled state. By default, caching is enabled.Thi","href":"https://github.com/GoogleChrome/puppeteer/blob/v1.18.1/docs/api.md#pagescreenshotoptions","args":"\n<li><code>options</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object\" title=\"Object\" rel=\"nofollow\">Object</a>> Options object which might have the following properties:\n<ul>\n<li><code>path</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" title=\"String\" rel=\"nofollow\">string</a>> The file path to save the image to. The screenshot type will be inferred from file extension. If <code>path</code> is a relative path, then it is resolved relative to <a href=\"https://nodejs.org/api/process.html#process_process_cwd\" rel=\"nofollow\">current working directory</a>. If no path is provided, the image won't be saved to the disk.</li>\n<li><code>type</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" title=\"String\" rel=\"nofollow\">string</a>> Specify screenshot type, can be either <code>jpeg</code> or <code>png</code>. Defaults to 'png'.</li>\n<li><code>quality</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type\" title=\"Number\" rel=\"nofollow\">number</a>> The quality of the image, between 0-100. Not applicable to <code>png</code> images.</li>\n<li><code>fullPage</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type\" title=\"Boolean\" rel=\"nofollow\">boolean</a>> When true, takes a screenshot of the full scrollable page. Defaults to <code>false</code>.</li>\n<li><code>clip</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object\" title=\"Object\" rel=\"nofollow\">Object</a>> An object which specifies clipping region of the page. Should have the following fields:\n<ul>\n<li><code>x</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type\" title=\"Number\" rel=\"nofollow\">number</a>> x-coordinate of top-left corner of clip area</li>\n<li><code>y</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type\" title=\"Number\" rel=\"nofollow\">number</a>> y-coordinate of top-left corner of clip area</li>\n<li><code>width</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type\" title=\"Number\" rel=\"nofollow\">number</a>> width of clipping area</li>\n<li><code>height</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type\" title=\"Number\" rel=\"nofollow\">number</a>> height of clipping area</li>\n</ul>\n</li>\n<li><code>omitBackground</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type\" title=\"Boolean\" rel=\"nofollow\">boolean</a>> Hides default white background and allows capturing screenshots with transparency. Defaults to <code>false</code>.</li>\n<li><code>encoding</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" title=\"String\" rel=\"nofollow\">string</a>> The encoding of the image, can be either <code>base64</code> or <code>binary</code>. Defaults to <code>binary</code>.</li>\n</ul>\n</li>\n<li>returns: <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise\" title=\"Promise\" rel=\"nofollow\">Promise</a><<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" title=\"String\" rel=\"nofollow\">string</a>|<a href=\"https://nodejs.org/api/buffer.html#buffer_class_buffer\" title=\"Buffer\" rel=\"nofollow\">Buffer</a>>> Promise which resolves to buffer or a base64 string (depending on the value of <code>encoding</code>) with captured screenshot.</li>\n"},{"text":"select","description":"Triggers a change and input event once all the provided options have been selected. If there's no <select> element matching selector, the method throws an error.Shortcut for page.mainFrame().select()Toggles bypassing page's Content-Security-Policy.Toggles ignoring cache for each request based on the enabled state. By default, caching is enabled.Thi","href":"https://github.com/GoogleChrome/puppeteer/blob/v1.18.1/docs/api.md#pageselectselector-values","args":"\n<li><code>selector</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" title=\"String\" rel=\"nofollow\">string</a>> A <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Selectors\" title=\"selector\" rel=\"nofollow\">selector</a> to query page for</li>\n<li><code>...values</code> <...<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" title=\"String\" rel=\"nofollow\">string</a>> Values of options to select. If the <code><select></code> has the <code>multiple</code> attribute, all values are considered, otherwise only the first one is taken into account.</li>\n<li>returns: <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise\" title=\"Promise\" rel=\"nofollow\">Promise</a><<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array\" title=\"Array\" rel=\"nofollow\">Array</a><<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" title=\"String\" rel=\"nofollow\">string</a>>>> An array of option values that have been successfully selected.</li>\n"},{"text":"setBypassCSP","description":"Toggles bypassing page's Content-Security-Policy.Toggles ignoring cache for each request based on the enabled state. By default, caching is enabled.This setting will change the default maximum navigation time for the following methods and related shortcuts:This setting will change the default maximum time for the following methods and related short","href":"https://github.com/GoogleChrome/puppeteer/blob/v1.18.1/docs/api.md#pagesetbypasscspenabled","args":"\n<li><code>enabled</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type\" title=\"Boolean\" rel=\"nofollow\">boolean</a>> sets bypassing of page's Content-Security-Policy.</li>\n<li>returns: <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise\" title=\"Promise\" rel=\"nofollow\">Promise</a>></li>\n"},{"text":"setCacheEnabled","description":"Toggles ignoring cache for each request based on the enabled state. By default, caching is enabled.This setting will change the default maximum navigation time for the following methods and related shortcuts:This setting will change the default maximum time for the following methods and related shortcuts:The extra HTTP headers will be sent with eve","href":"https://github.com/GoogleChrome/puppeteer/blob/v1.18.1/docs/api.md#pagesetcacheenabledenabled","args":"\n<li><code>enabled</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type\" title=\"Boolean\" rel=\"nofollow\">boolean</a>> sets the <code>enabled</code> state of the cache.</li>\n<li>returns: <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise\" title=\"Promise\" rel=\"nofollow\">Promise</a>></li>\n"},{"text":"setContent","description":"This setting will change the default maximum navigation time for the following methods and related shortcuts:This setting will change the default maximum time for the following methods and related shortcuts:The extra HTTP headers will be sent with every request the page initiates.Sets the page's geolocation.Activating request interception enables r","href":"https://github.com/GoogleChrome/puppeteer/blob/v1.18.1/docs/api.md#pagesetcontenthtml-options","args":"\n<li><code>html</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" title=\"String\" rel=\"nofollow\">string</a>> HTML markup to assign to the page.</li>\n<li><code>options</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object\" title=\"Object\" rel=\"nofollow\">Object</a>> Parameters which might have the following properties:\n<ul>\n<li><code>timeout</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type\" title=\"Number\" rel=\"nofollow\">number</a>> Maximum time in milliseconds for resources to load, defaults to 30 seconds, pass <code>0</code> to disable timeout. The default value can be changed by using the <a href=\"#pagesetdefaultnavigationtimeouttimeout\">page.setDefaultNavigationTimeout(timeout)</a> or <a href=\"#pagesetdefaulttimeouttimeout\">page.setDefaultTimeout(timeout)</a> methods.</li>\n<li><code>waitUntil</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" title=\"String\" rel=\"nofollow\">string</a>|<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array\" title=\"Array\" rel=\"nofollow\">Array</a><<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" title=\"String\" rel=\"nofollow\">string</a>>> When to consider setting markup succeeded, defaults to <code>load</code>. Given an array of event strings, setting content is considered to be successful after all events have been fired. Events can be either:\n<ul>\n<li><code>load</code> - consider setting content to be finished when the <code>load</code> event is fired.</li>\n<li><code>domcontentloaded</code> - consider setting content to be finished when the <code>DOMContentLoaded</code> event is fired.</li>\n<li><code>networkidle0</code> - consider setting content to be finished when there are no more than 0 network connections for at least <code>500</code> ms.</li>\n<li><code>networkidle2</code> - consider setting content to be finished when there are no more than 2 network connections for at least <code>500</code> ms.</li>\n</ul>\n</li>\n</ul>\n</li>\n<li>returns: <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise\" title=\"Promise\" rel=\"nofollow\">Promise</a>></li>\n"},{"text":"setCookie","description":"This setting will change the default maximum navigation time for the following methods and related shortcuts:This setting will change the default maximum time for the following methods and related shortcuts:The extra HTTP headers will be sent with every request the page initiates.Sets the page's geolocation.Activating request interception enables r","href":"https://github.com/GoogleChrome/puppeteer/blob/v1.18.1/docs/api.md#pagesetcookiecookies","args":"\n<li><code>...cookies</code> <...<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object\" title=\"Object\" rel=\"nofollow\">Object</a>>\n<ul>\n<li><code>name</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" title=\"String\" rel=\"nofollow\">string</a>> <strong>required</strong></li>\n<li><code>value</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" title=\"String\" rel=\"nofollow\">string</a>> <strong>required</strong></li>\n<li><code>url</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" title=\"String\" rel=\"nofollow\">string</a>></li>\n<li><code>domain</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" title=\"String\" rel=\"nofollow\">string</a>></li>\n<li><code>path</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" title=\"String\" rel=\"nofollow\">string</a>></li>\n<li><code>expires</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type\" title=\"Number\" rel=\"nofollow\">number</a>> Unix time in seconds.</li>\n<li><code>httpOnly</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type\" title=\"Boolean\" rel=\"nofollow\">boolean</a>></li>\n<li><code>secure</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type\" title=\"Boolean\" rel=\"nofollow\">boolean</a>></li>\n<li><code>sameSite</code> <\"Strict\"|\"Lax\"></li>\n</ul>\n</li>\n<li>returns: <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise\" title=\"Promise\" rel=\"nofollow\">Promise</a>></li>\n"},{"text":"setDefaultNavigationTimeout","description":"This setting will change the default maximum navigation time for the following methods and related shortcuts:This setting will change the default maximum time for the following methods and related shortcuts:The extra HTTP headers will be sent with every request the page initiates.Sets the page's geolocation.Activating request interception enables r","href":"https://github.com/GoogleChrome/puppeteer/blob/v1.18.1/docs/api.md#pagesetdefaultnavigationtimeouttimeout","args":"\n<li><code>timeout</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type\" title=\"Number\" rel=\"nofollow\">number</a>> Maximum navigation time in milliseconds</li>\n"},{"text":"setDefaultTimeout","description":"This setting will change the default maximum time for the following methods and related shortcuts:The extra HTTP headers will be sent with every request the page initiates.Sets the page's geolocation.Activating request interception enables request.abort, request.continue and request.respond methods. This provides the capability to modify network r","href":"https://github.com/GoogleChrome/puppeteer/blob/v1.18.1/docs/api.md#pagesetdefaulttimeouttimeout","args":"\n<li><code>timeout</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type\" title=\"Number\" rel=\"nofollow\">number</a>> Maximum time in milliseconds</li>\n"},{"text":"setExtraHTTPHeaders","description":"The extra HTTP headers will be sent with every request the page initiates.Sets the page's geolocation.Activating request interception enables request.abort, request.continue and request.respond methods. This provides the capability to modify network requests that are made by a page.Once request interception is enabled, every request will stall unl","href":"https://github.com/GoogleChrome/puppeteer/blob/v1.18.1/docs/api.md#pagesetextrahttpheadersheaders","args":"\n<li><code>headers</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object\" title=\"Object\" rel=\"nofollow\">Object</a>> An object containing additional HTTP headers to be sent with every request. All header values must be strings.</li>\n<li>returns: <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise\" title=\"Promise\" rel=\"nofollow\">Promise</a>></li>\n"},{"text":"setGeolocation","description":"Sets the page's geolocation.Activating request interception enables request.abort, request.continue and request.respond methods. This provides the capability to modify network requests that are made by a page.Once request interception is enabled, every request will stall unless it's continued, responded or aborted. An example of a naïve request in","href":"https://github.com/GoogleChrome/puppeteer/blob/v1.18.1/docs/api.md#pagesetgeolocationoptions","args":"\n<li><code>options</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object\" title=\"Object\" rel=\"nofollow\">Object</a>>\n<ul>\n<li><code>latitude</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type\" title=\"Number\" rel=\"nofollow\">number</a>> Latitude between -90 and 90.</li>\n<li><code>longitude</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type\" title=\"Number\" rel=\"nofollow\">number</a>> Longitude between -180 and 180.</li>\n<li><code>accuracy</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type\" title=\"Number\" rel=\"nofollow\">number</a>> Optional non-negative accuracy value.</li>\n</ul>\n</li>\n<li>returns: <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise\" title=\"Promise\" rel=\"nofollow\">Promise</a>></li>\n"},{"text":"setJavaScriptEnabled","description":"Activating request interception enables request.abort, request.continue and request.respond methods. This provides the capability to modify network requests that are made by a page.Once request interception is enabled, every request will stall unless it's continued, responded or aborted. An example of a naïve request interceptor that aborts all im","href":"https://github.com/GoogleChrome/puppeteer/blob/v1.18.1/docs/api.md#pagesetjavascriptenabledenabled","args":"\n<li><code>enabled</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type\" title=\"Boolean\" rel=\"nofollow\">boolean</a>> Whether or not to enable JavaScript on the page.</li>\n<li>returns: <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise\" title=\"Promise\" rel=\"nofollow\">Promise</a>></li>\n"},{"text":"setOfflineMode","description":"Activating request interception enables request.abort, request.continue and request.respond methods. This provides the capability to modify network requests that are made by a page.Once request interception is enabled, every request will stall unless it's continued, responded or aborted. An example of a naïve request interceptor that aborts all im","href":"https://github.com/GoogleChrome/puppeteer/blob/v1.18.1/docs/api.md#pagesetofflinemodeenabled","args":"\n<li><code>enabled</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type\" title=\"Boolean\" rel=\"nofollow\">boolean</a>> When <code>true</code>, enables offline mode for the page.</li>\n<li>returns: <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise\" title=\"Promise\" rel=\"nofollow\">Promise</a>></li>\n"},{"text":"setRequestInterception","description":"Activating request interception enables request.abort, request.continue and request.respond methods. This provides the capability to modify network requests that are made by a page.Once request interception is enabled, every request will stall unless it's continued, responded or aborted. An example of a naïve request interceptor that aborts all im","href":"https://github.com/GoogleChrome/puppeteer/blob/v1.18.1/docs/api.md#pagesetrequestinterceptionvalue","args":"\n<li><code>value</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type\" title=\"Boolean\" rel=\"nofollow\">boolean</a>> Whether to enable request interception.</li>\n<li>returns: <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise\" title=\"Promise\" rel=\"nofollow\">Promise</a>></li>\n"},{"text":"setUserAgent","description":"In the case of multiple pages in a single browser, each page can have its own viewport size.page.setViewport will resize the page. A lot of websites don't expect phones to change size, so you should set the viewport before navigating to the page.This method fetches an element with selector, scrolls it into view if needed, and then uses page.touchsc","href":"https://github.com/GoogleChrome/puppeteer/blob/v1.18.1/docs/api.md#pagesetuseragentuseragent","args":"\n<li><code>userAgent</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" title=\"String\" rel=\"nofollow\">string</a>> Specific user agent to use in this page</li>\n<li>returns: <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise\" title=\"Promise\" rel=\"nofollow\">Promise</a>> Promise which resolves when the user agent is set.</li>\n"},{"text":"setViewport","description":"In the case of multiple pages in a single browser, each page can have its own viewport size.page.setViewport will resize the page. A lot of websites don't expect phones to change size, so you should set the viewport before navigating to the page.This method fetches an element with selector, scrolls it into view if needed, and then uses page.touchsc","href":"https://github.com/GoogleChrome/puppeteer/blob/v1.18.1/docs/api.md#pagesetviewportviewport","args":"\n<li><code>viewport</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object\" title=\"Object\" rel=\"nofollow\">Object</a>>\n<ul>\n<li><code>width</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type\" title=\"Number\" rel=\"nofollow\">number</a>> page width in pixels. <strong>required</strong></li>\n<li><code>height</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type\" title=\"Number\" rel=\"nofollow\">number</a>> page height in pixels. <strong>required</strong></li>\n<li><code>deviceScaleFactor</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type\" title=\"Number\" rel=\"nofollow\">number</a>> Specify device scale factor (can be thought of as dpr). Defaults to <code>1</code>.</li>\n<li><code>isMobile</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type\" title=\"Boolean\" rel=\"nofollow\">boolean</a>> Whether the <code>meta viewport</code> tag is taken into account. Defaults to <code>false</code>.</li>\n<li><code>hasTouch</code><<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type\" title=\"Boolean\" rel=\"nofollow\">boolean</a>> Specifies if viewport supports touch events. Defaults to <code>false</code></li>\n<li><code>isLandscape</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type\" title=\"Boolean\" rel=\"nofollow\">boolean</a>> Specifies if viewport is in landscape mode. Defaults to <code>false</code>.</li>\n</ul>\n</li>\n<li>returns: <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise\" title=\"Promise\" rel=\"nofollow\">Promise</a>></li>\n"},{"text":"tap","description":"This method fetches an element with selector, scrolls it into view if needed, and then uses page.touchscreen to tap in the center of the element. If there's no element matching selector, the method throws an error.Shortcut for page.mainFrame().tap(selector).Shortcut for page.mainFrame().title().Sends a keydown, keypress/input, and keyup event for e","href":"https://github.com/GoogleChrome/puppeteer/blob/v1.18.1/docs/api.md#pagetapselector","args":"\n<li><code>selector</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" title=\"String\" rel=\"nofollow\">string</a>> A <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Selectors\" title=\"selector\" rel=\"nofollow\">selector</a> to search for element to tap. If there are multiple elements satisfying the selector, the first will be tapped.</li>\n<li>returns: <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise\" title=\"Promise\" rel=\"nofollow\">Promise</a>></li>\n"},{"text":"target","description":"Shortcut for page.mainFrame().title().Sends a keydown, keypress/input, and keyup event for each character in the text.To press a special key, like Control or ArrowDown, use keyboard.press.Shortcut for page.mainFrame().type(selector, text[, options]).This is a shortcut for page.mainFrame().url()This method behaves differently with respect to the typ","href":"https://github.com/GoogleChrome/puppeteer/blob/v1.18.1/docs/api.md#pagetarget","args":"\n<li>returns: <<a href=\"#class-target\" title=\"Target\">Target</a>> a target this page was created from.</li>\n"},{"text":"title","description":"Shortcut for page.mainFrame().title().Sends a keydown, keypress/input, and keyup event for each character in the text.To press a special key, like Control or ArrowDown, use keyboard.press.Shortcut for page.mainFrame().type(selector, text[, options]).This is a shortcut for page.mainFrame().url()This method behaves differently with respect to the typ","href":"https://github.com/GoogleChrome/puppeteer/blob/v1.18.1/docs/api.md#pagetitle","args":"\n<li>returns: <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise\" title=\"Promise\" rel=\"nofollow\">Promise</a><<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" title=\"String\" rel=\"nofollow\">string</a>>> The page's title.</li>\n"},{"text":"touchscreen","description":"Sends a keydown, keypress/input, and keyup event for each character in the text.To press a special key, like Control or ArrowDown, use keyboard.press.Shortcut for page.mainFrame().type(selector, text[, options]).This is a shortcut for page.mainFrame().url()This method behaves differently with respect to the type of the first parameter:To pass argum","href":"https://github.com/GoogleChrome/puppeteer/blob/v1.18.1/docs/api.md#pagetouchscreen","args":"\n<li>returns: <<a href=\"#class-touchscreen\" title=\"Touchscreen\">Touchscreen</a>></li>\n"},{"text":"tracing","description":"Sends a keydown, keypress/input, and keyup event for each character in the text.To press a special key, like Control or ArrowDown, use keyboard.press.Shortcut for page.mainFrame().type(selector, text[, options]).This is a shortcut for page.mainFrame().url()This method behaves differently with respect to the type of the first parameter:To pass argum","href":"https://github.com/GoogleChrome/puppeteer/blob/v1.18.1/docs/api.md#pagetracing","args":"\n<li>returns: <<a href=\"#class-tracing\" title=\"Tracing\">Tracing</a>></li>\n"},{"text":"type","description":"Sends a keydown, keypress/input, and keyup event for each character in the text.To press a special key, like Control or ArrowDown, use keyboard.press.Shortcut for page.mainFrame().type(selector, text[, options]).This is a shortcut for page.mainFrame().url()This method behaves differently with respect to the type of the first parameter:To pass argum","href":"https://github.com/GoogleChrome/puppeteer/blob/v1.18.1/docs/api.md#pagetypeselector-text-options","args":"\n<li><code>selector</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" title=\"String\" rel=\"nofollow\">string</a>> A <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Selectors\" title=\"selector\" rel=\"nofollow\">selector</a> of an element to type into. If there are multiple elements satisfying the selector, the first will be used.</li>\n<li><code>text</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" title=\"String\" rel=\"nofollow\">string</a>> A text to type into a focused element.</li>\n<li><code>options</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object\" title=\"Object\" rel=\"nofollow\">Object</a>>\n<ul>\n<li><code>delay</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type\" title=\"Number\" rel=\"nofollow\">number</a>> Time to wait between key presses in milliseconds. Defaults to 0.</li>\n</ul>\n</li>\n<li>returns: <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise\" title=\"Promise\" rel=\"nofollow\">Promise</a>></li>\n"},{"text":"url","description":"This is a shortcut for page.mainFrame().url()This method behaves differently with respect to the type of the first parameter:To pass arguments from node.js to the predicate of page.waitFor function:Shortcut for page.mainFrame().waitFor(selectorOrFunctionOrTimeout[, options[, ...args]]).The waitForFunction can be used to observe viewport size change","href":"https://github.com/GoogleChrome/puppeteer/blob/v1.18.1/docs/api.md#pageurl","args":"\n<li>returns: <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" title=\"String\" rel=\"nofollow\">string</a>></li>\n"},{"text":"viewport","description":"This method behaves differently with respect to the type of the first parameter:To pass arguments from node.js to the predicate of page.waitFor function:Shortcut for page.mainFrame().waitFor(selectorOrFunctionOrTimeout[, options[, ...args]]).The waitForFunction can be used to observe viewport size change:To pass arguments from node.js to the predic","href":"https://github.com/GoogleChrome/puppeteer/blob/v1.18.1/docs/api.md#pageviewport","args":"\n<li>returns: <?<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object\" title=\"Object\" rel=\"nofollow\">Object</a>>\n<ul>\n<li><code>width</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type\" title=\"Number\" rel=\"nofollow\">number</a>> page width in pixels.</li>\n<li><code>height</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type\" title=\"Number\" rel=\"nofollow\">number</a>> page height in pixels.</li>\n<li><code>deviceScaleFactor</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type\" title=\"Number\" rel=\"nofollow\">number</a>> Specify device scale factor (can be though of as dpr). Defaults to <code>1</code>.</li>\n<li><code>isMobile</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type\" title=\"Boolean\" rel=\"nofollow\">boolean</a>> Whether the <code>meta viewport</code> tag is taken into account. Defaults to <code>false</code>.</li>\n<li><code>hasTouch</code><<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type\" title=\"Boolean\" rel=\"nofollow\">boolean</a>> Specifies if viewport supports touch events. Defaults to <code>false</code></li>\n<li><code>isLandscape</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type\" title=\"Boolean\" rel=\"nofollow\">boolean</a>> Specifies if viewport is in landscape mode. Defaults to <code>false</code>.</li>\n</ul>\n</li>\n"},{"text":"waitFor","description":"This method behaves differently with respect to the type of the first parameter:To pass arguments from node.js to the predicate of page.waitFor function:Shortcut for page.mainFrame().waitFor(selectorOrFunctionOrTimeout[, options[, ...args]]).The waitForFunction can be used to observe viewport size change:To pass arguments from node.js to the predic","href":"https://github.com/GoogleChrome/puppeteer/blob/v1.18.1/docs/api.md#pagewaitforselectororfunctionortimeout-options-args","args":"\n<li><code>selectorOrFunctionOrTimeout</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" title=\"String\" rel=\"nofollow\">string</a>|<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type\" title=\"Number\" rel=\"nofollow\">number</a>|<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function\" title=\"Function\" rel=\"nofollow\">function</a>> A <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Selectors\" title=\"selector\" rel=\"nofollow\">selector</a>, predicate or timeout to wait for</li>\n<li><code>options</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object\" title=\"Object\" rel=\"nofollow\">Object</a>> Optional waiting parameters</li>\n<li><code>...args</code> <...<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify#Description\" title=\"Serializable\" rel=\"nofollow\">Serializable</a>|<a href=\"#class-jshandle\" title=\"JSHandle\">JSHandle</a>> Arguments to pass to <code>pageFunction</code></li>\n<li>returns: <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise\" title=\"Promise\" rel=\"nofollow\">Promise</a><<a href=\"#class-jshandle\" title=\"JSHandle\">JSHandle</a>>> Promise which resolves to a JSHandle of the success value</li>\n"},{"text":"waitForFunction","description":"The waitForFunction can be used to observe viewport size change:To pass arguments from node.js to the predicate of page.waitForFunction function:Shortcut for page.mainFrame().waitForFunction(pageFunction[, options[, ...args]]).This resolves when the page navigates to a new URL or reloads. It is useful for when you run code which will indirectly cau","href":"https://github.com/GoogleChrome/puppeteer/blob/v1.18.1/docs/api.md#pagewaitforfunctionpagefunction-options-args","args":"\n<li><code>pageFunction</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function\" title=\"Function\" rel=\"nofollow\">function</a>|<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" title=\"String\" rel=\"nofollow\">string</a>> Function to be evaluated in browser context</li>\n<li><code>options</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object\" title=\"Object\" rel=\"nofollow\">Object</a>> Optional waiting parameters\n<ul>\n<li><code>polling</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" title=\"String\" rel=\"nofollow\">string</a>|<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type\" title=\"Number\" rel=\"nofollow\">number</a>> An interval at which the <code>pageFunction</code> is executed, defaults to <code>raf</code>. If <code>polling</code> is a number, then it is treated as an interval in milliseconds at which the function would be executed. If <code>polling</code> is a string, then it can be one of the following values:\n<ul>\n<li><code>raf</code> - to constantly execute <code>pageFunction</code> in <code>requestAnimationFrame</code> callback. This is the tightest polling mode which is suitable to observe styling changes.</li>\n<li><code>mutation</code> - to execute <code>pageFunction</code> on every DOM mutation.</li>\n</ul>\n</li>\n<li><code>timeout</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type\" title=\"Number\" rel=\"nofollow\">number</a>> maximum time to wait for in milliseconds. Defaults to <code>30000</code> (30 seconds). Pass <code>0</code> to disable timeout. The default value can be changed by using the <a href=\"#pagesetdefaulttimeouttimeout\">page.setDefaultTimeout(timeout)</a> method.</li>\n</ul>\n</li>\n<li><code>...args</code> <...<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify#Description\" title=\"Serializable\" rel=\"nofollow\">Serializable</a>|<a href=\"#class-jshandle\" title=\"JSHandle\">JSHandle</a>> Arguments to pass to <code>pageFunction</code></li>\n<li>returns: <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise\" title=\"Promise\" rel=\"nofollow\">Promise</a><<a href=\"#class-jshandle\" title=\"JSHandle\">JSHandle</a>>> Promise which resolves when the <code>pageFunction</code> returns a truthy value. It resolves to a JSHandle of the truthy value.</li>\n"},{"text":"waitForNavigation","description":"This resolves when the page navigates to a new URL or reloads. It is useful for when you run code which will indirectly cause the page to navigate. Consider this example:NOTE Usage of the History API to change the URL is considered a navigation.Shortcut for page.mainFrame().waitForNavigation(options).Wait for the selector to appear in page. If at t","href":"https://github.com/GoogleChrome/puppeteer/blob/v1.18.1/docs/api.md#pagewaitfornavigationoptions","args":"\n<li><code>options</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object\" title=\"Object\" rel=\"nofollow\">Object</a>> Navigation parameters which might have the following properties:\n<ul>\n<li><code>timeout</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type\" title=\"Number\" rel=\"nofollow\">number</a>> Maximum navigation time in milliseconds, defaults to 30 seconds, pass <code>0</code> to disable timeout. The default value can be changed by using the <a href=\"#pagesetdefaultnavigationtimeouttimeout\">page.setDefaultNavigationTimeout(timeout)</a> or <a href=\"#pagesetdefaulttimeouttimeout\">page.setDefaultTimeout(timeout)</a> methods.</li>\n<li><code>waitUntil</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" title=\"String\" rel=\"nofollow\">string</a>|<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array\" title=\"Array\" rel=\"nofollow\">Array</a><<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" title=\"String\" rel=\"nofollow\">string</a>>> When to consider navigation succeeded, defaults to <code>load</code>. Given an array of event strings, navigation is considered to be successful after all events have been fired. Events can be either:\n<ul>\n<li><code>load</code> - consider navigation to be finished when the <code>load</code> event is fired.</li>\n<li><code>domcontentloaded</code> - consider navigation to be finished when the <code>DOMContentLoaded</code> event is fired.</li>\n<li><code>networkidle0</code> - consider navigation to be finished when there are no more than 0 network connections for at least <code>500</code> ms.</li>\n<li><code>networkidle2</code> - consider navigation to be finished when there are no more than 2 network connections for at least <code>500</code> ms.</li>\n</ul>\n</li>\n</ul>\n</li>\n<li>returns: <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise\" title=\"Promise\" rel=\"nofollow\">Promise</a><?<a href=\"#class-response\" title=\"Response\">Response</a>>> Promise which resolves to the main resource response. In case of multiple redirects, the navigation will resolve with the response of the last redirect. In case of navigation to a different anchor or navigation due to History API usage, the navigation will resolve with <code>null</code>.</li>\n"},{"text":"waitForRequest","description":"Wait for the selector to appear in page. If at the moment of calling the method the selector already exists, the method will return immediately. If the selector doesn't appear after the timeout milliseconds of waiting, the function will throw.This method works across navigations:Shortcut for page.mainFrame().waitForSelector(selector[, options]).Wai","href":"https://github.com/GoogleChrome/puppeteer/blob/v1.18.1/docs/api.md#pagewaitforrequesturlorpredicate-options","args":"\n<li><code>urlOrPredicate</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" title=\"String\" rel=\"nofollow\">string</a>|<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function\" title=\"Function\" rel=\"nofollow\">Function</a>> A URL or predicate to wait for.</li>\n<li><code>options</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object\" title=\"Object\" rel=\"nofollow\">Object</a>> Optional waiting parameters\n<ul>\n<li><code>timeout</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type\" title=\"Number\" rel=\"nofollow\">number</a>> Maximum wait time in milliseconds, defaults to 30 seconds, pass <code>0</code> to disable the timeout. The default value can be changed by using the <a href=\"#pagesetdefaulttimeouttimeout\">page.setDefaultTimeout(timeout)</a> method.</li>\n</ul>\n</li>\n<li>returns: <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise\" title=\"Promise\" rel=\"nofollow\">Promise</a><<a href=\"#class-request\" title=\"Request\">Request</a>>> Promise which resolves to the matched request.</li>\n"},{"text":"waitForResponse","description":"Wait for the selector to appear in page. If at the moment of calling the method the selector already exists, the method will return immediately. If the selector doesn't appear after the timeout milliseconds of waiting, the function will throw.This method works across navigations:Shortcut for page.mainFrame().waitForSelector(selector[, options]).Wai","href":"https://github.com/GoogleChrome/puppeteer/blob/v1.18.1/docs/api.md#pagewaitforresponseurlorpredicate-options","args":"\n<li><code>urlOrPredicate</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" title=\"String\" rel=\"nofollow\">string</a>|<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function\" title=\"Function\" rel=\"nofollow\">Function</a>> A URL or predicate to wait for.</li>\n<li><code>options</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object\" title=\"Object\" rel=\"nofollow\">Object</a>> Optional waiting parameters\n<ul>\n<li><code>timeout</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type\" title=\"Number\" rel=\"nofollow\">number</a>> Maximum wait time in milliseconds, defaults to 30 seconds, pass <code>0</code> to disable the timeout. The default value can be changed by using the <a href=\"#pagesetdefaulttimeouttimeout\">page.setDefaultTimeout(timeout)</a> method.</li>\n</ul>\n</li>\n<li>returns: <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise\" title=\"Promise\" rel=\"nofollow\">Promise</a><<a href=\"#class-response\" title=\"Response\">Response</a>>> Promise which resolves to the matched response.</li>\n"},{"text":"waitForSelector","description":"Wait for the selector to appear in page. If at the moment of calling the method the selector already exists, the method will return immediately. If the selector doesn't appear after the timeout milliseconds of waiting, the function will throw.This method works across navigations:Shortcut for page.mainFrame().waitForSelector(selector[, options]).Wai","href":"https://github.com/GoogleChrome/puppeteer/blob/v1.18.1/docs/api.md#pagewaitforselectorselector-options","args":"\n<li><code>selector</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" title=\"String\" rel=\"nofollow\">string</a>> A <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Selectors\" title=\"selector\" rel=\"nofollow\">selector</a> of an element to wait for</li>\n<li><code>options</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object\" title=\"Object\" rel=\"nofollow\">Object</a>> Optional waiting parameters\n<ul>\n<li><code>visible</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type\" title=\"Boolean\" rel=\"nofollow\">boolean</a>> wait for element to be present in DOM and to be visible, i.e. to not have <code>display: none</code> or <code>visibility: hidden</code> CSS properties. Defaults to <code>false</code>.</li>\n<li><code>hidden</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type\" title=\"Boolean\" rel=\"nofollow\">boolean</a>> wait for element to not be found in the DOM or to be hidden, i.e. have <code>display: none</code> or <code>visibility: hidden</code> CSS properties. Defaults to <code>false</code>.</li>\n<li><code>timeout</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type\" title=\"Number\" rel=\"nofollow\">number</a>> maximum time to wait for in milliseconds. Defaults to <code>30000</code> (30 seconds). Pass <code>0</code> to disable timeout. The default value can be changed by using the <a href=\"#pagesetdefaulttimeouttimeout\">page.setDefaultTimeout(timeout)</a> method.</li>\n</ul>\n</li>\n<li>returns: <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise\" title=\"Promise\" rel=\"nofollow\">Promise</a><?<a href=\"#class-elementhandle\" title=\"ElementHandle\">ElementHandle</a>>> Promise which resolves when element specified by selector string is added to DOM. Resolves to <code>null</code> if waiting for <code>hidden: true</code> and selector is not found in DOM.</li>\n"},{"text":"waitForXPath","description":"Wait for the xpath to appear in page. If at the moment of calling the method the xpath already exists, the method will return immediately. If the xpath doesn't appear after the timeout milliseconds of waiting, the function will throw.This method works across navigations:Shortcut for page.mainFrame().waitForXPath(xpath[, options]).The Worker class r","href":"https://github.com/GoogleChrome/puppeteer/blob/v1.18.1/docs/api.md#pagewaitforxpathxpath-options","args":"\n<li><code>xpath</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" title=\"String\" rel=\"nofollow\">string</a>> A <a href=\"https://developer.mozilla.org/en-US/docs/Web/XPath\" title=\"xpath\" rel=\"nofollow\">xpath</a> of an element to wait for</li>\n<li><code>options</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object\" title=\"Object\" rel=\"nofollow\">Object</a>> Optional waiting parameters\n<ul>\n<li><code>visible</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type\" title=\"Boolean\" rel=\"nofollow\">boolean</a>> wait for element to be present in DOM and to be visible, i.e. to not have <code>display: none</code> or <code>visibility: hidden</code> CSS properties. Defaults to <code>false</code>.</li>\n<li><code>hidden</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type\" title=\"Boolean\" rel=\"nofollow\">boolean</a>> wait for element to not be found in the DOM or to be hidden, i.e. have <code>display: none</code> or <code>visibility: hidden</code> CSS properties. Defaults to <code>false</code>.</li>\n<li><code>timeout</code> <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type\" title=\"Number\" rel=\"nofollow\">number</a>> maximum time to wait for in milliseconds. Defaults to <code>30000</code> (30 seconds). Pass <code>0</code> to disable timeout. The default value can be changed by using the <a href=\"#pagesetdefaulttimeouttimeout\">page.setDefaultTimeout(timeout)</a> method.</li>\n</ul>\n</li>\n<li>returns: <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise\" title=\"Promise\" rel=\"nofollow\">Promise</a><?<a href=\"#class-elementhandle\" title=\"ElementHandle\">ElementHandle</a>>> Promise which resolves when element specified by xpath string is added to DOM. Resolves to <code>null</code> if waiting for <code>hidden: true</code> and xpath is not found in DOM.</li>\n"},{"text":"workers","description":"The Worker class represents a WebWorker. The events workercreated and workerdestroyed are emitted on the page object to signal the worker lifecycle.If the function passed to the worker.evaluate returns a Promise, then worker.evaluate would wait for the promise to resolve and return its value.If the function passed to the worker.evaluate returns a n","href":"https://github.com/GoogleChrome/puppeteer/blob/v1.18.1/docs/api.md#pageworkers","args":"\n<li>returns: <<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array\" title=\"Array\" rel=\"nofollow\">Array</a><<a href=\"#class-worker\" title=\"Worker\">Worker</a>>>\nThis method returns all of the dedicated <a href=\"https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API\" rel=\"nofollow\">WebWorkers</a> associated with the page.</li>\n"}]