puppeteer/assets/js/33e3546d.8e066089.js

"use strict";(self.webpackChunkwebsite=self.webpackChunkwebsite||[]).push([[54618],{3905:function(e,t,r){r.d(t,{Zo:function(){return s},kt:function(){return d}});var n=r(67294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function p(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function o(e){for(var t=1;t<arguments.length;t++){var r=null!=arguments[t]?arguments[t]:{};t%2?p(Object(r),!0).forEach((function(t){a(e,t,r[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(r)):p(Object(r)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(r,t))}))}return e}function i(e,t){if(null==e)return{};var r,n,a=function(e,t){if(null==e)return{};var r,n,a={},p=Object.keys(e);for(n=0;n<p.length;n++)r=p[n],t.indexOf(r)>=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var p=Object.getOwnPropertySymbols(e);for(n=0;n<p.length;n++)r=p[n],t.indexOf(r)>=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var l=n.createContext({}),u=function(e){var t=n.useContext(l),r=t;return e&&(r="function"==typeof e?e(t):o(o({},t),e)),r},s=function(e){var t=u(e.components);return n.createElement(l.Provider,{value:t},e.children)},c={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},m=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,p=e.originalType,l=e.parentName,s=i(e,["components","mdxType","originalType","parentName"]),m=u(r),d=a,f=m["".concat(l,".").concat(d)]||m[d]||c[d]||p;return r?n.createElement(f,o(o({ref:t},s),{},{components:r})):n.createElement(f,o({ref:t},s))}));function d(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var p=r.length,o=new Array(p);o[0]=m;var i={};for(var l in t)hasOwnProperty.call(t,l)&&(i[l]=t[l]);i.originalType=e,i.mdxType="string"==typeof e?e:a,o[1]=i;for(var u=2;u<p;u++)o[u]=r[u];return n.createElement.apply(null,o)}return n.createElement.apply(null,r)}m.displayName="MDXCreateElement"},15878:function(e,t,r){r.r(t),r.d(t,{frontMatter:function(){return i},contentTitle:function(){return l},metadata:function(){return u},toc:function(){return s},default:function(){return m}});var n=r(87462),a=r(63366),p=(r(67294),r(3905)),o=["components"],i={},l=void 0,u={unversionedId:"puppeteer.page.waitfor",id:"puppeteer.page.waitfor",isDocsHomePage:!1,title:"puppeteer.page.waitfor",description:"Home &gt; puppeteer &gt; Page &gt; waitFor",source:"@site/docs/puppeteer.page.waitfor.md",sourceDirName:".",slug:"/puppeteer.page.waitfor",permalink:"/puppeteer/docs/next/puppeteer.page.waitfor",editUrl:"https://github.com/facebook/puppeteer/edit/main/website/docs/puppeteer.page.waitfor.md",version:"current",frontMatter:{},sidebar:"docs",previous:{title:"puppeteer.page.viewport",permalink:"/puppeteer/docs/next/puppeteer.page.viewport"},next:{title:"puppeteer.page.waitforfilechooser",permalink:"/puppeteer/docs/next/puppeteer.page.waitforfilechooser"}},s=[{value:"Page.waitFor() method",id:"pagewaitfor-method",children:[]},{value:"Parameters",id:"parameters",children:[]},{value:"Remarks",id:"remarks",children:[]}],c={toc:s};function m(e){var t=e.components,r=(0,a.Z)(e,o);return(0,p.kt)("wrapper",(0,n.Z)({},c,r,{components:t,mdxType:"MDXLayout"}),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/puppeteer/docs/next/index"},"Home")," ",">"," ",(0,p.kt)("a",{parentName:"p",href:"/puppeteer/docs/next/puppeteer"},"puppeteer")," ",">"," ",(0,p.kt)("a",{parentName:"p",href:"/puppeteer/docs/next/puppeteer.page"},"Page")," ",">"," ",(0,p.kt)("a",{parentName:"p",href:"/puppeteer/docs/next/puppeteer.page.waitfor"},"waitFor")),(0,p.kt)("h2",{id:"pagewaitfor-method"},"Page.waitFor() method"),(0,p.kt)("blockquote",null,(0,p.kt)("p",{parentName:"blockquote"},"Warning: This API is now obsolete."),(0,p.kt)("p",{parentName:"blockquote"},"Don't use this method directly. Instead use the more explicit methods available: ",(0,p.kt)("a",{parentName:"p",href:"/puppeteer/docs/next/puppeteer.page.waitforselector"},"Page.waitForSelector()"),", ",(0,p.kt)("a",{parentName:"p",href:"/puppeteer/docs/next/puppeteer.page.waitforxpath"},"Page.waitForXPath()"),", ",(0,p.kt)("a",{parentName:"p",href:"/puppeteer/docs/next/puppeteer.page.waitforfunction"},"Page.waitForFunction()")," or ",(0,p.kt)("a",{parentName:"p",href:"/puppeteer/docs/next/puppeteer.page.waitfortimeout"},"Page.waitForTimeout()"),".")),(0,p.kt)("b",null,"Signature:"),(0,p.kt)("pre",null,(0,p.kt)("code",{parentName:"pre",className:"language-typescript"},"waitFor(selectorOrFunctionOrTimeout: string | number | Function, options?: {\n        visible?: boolean;\n        hidden?: boolean;\n        timeout?: number;\n        polling?: string | number;\n    }, ...args: SerializableOrJSHandle[]): Promise<JSHandle>;\n")),(0,p.kt)("h2",{id:"parameters"},"Parameters"),(0,p.kt)("table",null,(0,p.kt)("thead",{parentName:"table"},(0,p.kt)("tr",{parentName:"thead"},(0,p.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,p.kt)("th",{parentName:"tr",align:null},"Type"),(0,p.kt)("th",{parentName:"tr",align:null},"Description"))),(0,p.kt)("tbody",{parentName:"table"},(0,p.kt)("tr",{parentName:"tbody"},(0,p.kt)("td",{parentName:"tr",align:null},"selectorOrFunctionOrTimeout"),(0,p.kt)("td",{parentName:"tr",align:null},"string ","|"," number ","|"," Function"),(0,p.kt)("td",{parentName:"tr",align:null},"a selector, predicate or timeout to wait for.")),(0,p.kt)("tr",{parentName:"tbody"},(0,p.kt)("td",{parentName:"tr",align:null},"options"),(0,p.kt)("td",{parentName:"tr",align:null},"{ visible?: boolean; hidden?: boolean; timeout?: number; polling?: string ","|"," number; }"),(0,p.kt)("td",{parentName:"tr",align:null},"optional waiting parameters.")),(0,p.kt)("tr",{parentName:"tbody"},(0,p.kt)("td",{parentName:"tr",align:null},"args"),(0,p.kt)("td",{parentName:"tr",align:null},(0,p.kt)("a",{parentName:"td",href:"/puppeteer/docs/next/puppeteer.serializableorjshandle"},"SerializableOrJSHandle"),"[","]"),(0,p.kt)("td",{parentName:"tr",align:null},"arguments to pass to ",(0,p.kt)("code",null,"pageFunction"),".")))),(0,p.kt)("b",null,"Returns:"),(0,p.kt)("p",null,"Promise","<",(0,p.kt)("a",{parentName:"p",href:"/puppeteer/docs/next/puppeteer.jshandle"},"JSHandle"),">"),(0,p.kt)("h2",{id:"remarks"},"Remarks"),(0,p.kt)("p",null,"This method behaves differently depending on the first parameter. If it's a ",(0,p.kt)("inlineCode",{parentName:"p"},"string"),", it will be treated as a ",(0,p.kt)("inlineCode",{parentName:"p"},"selector")," or ",(0,p.kt)("inlineCode",{parentName:"p"},"xpath")," (if the string starts with ",(0,p.kt)("inlineCode",{parentName:"p"},"//"),"). This method then is a shortcut for ",(0,p.kt)("a",{parentName:"p",href:"/puppeteer/docs/next/puppeteer.page.waitforselector"},"Page.waitForSelector()")," or ",(0,p.kt)("a",{parentName:"p",href:"/puppeteer/docs/next/puppeteer.page.waitforxpath"},"Page.waitForXPath()"),"."),(0,p.kt)("p",null,"If the first argument is a function this method is a shortcut for ",(0,p.kt)("a",{parentName:"p",href:"/puppeteer/docs/next/puppeteer.page.waitforfunction"},"Page.waitForFunction()"),"."),(0,p.kt)("p",null,"If the first argument is a ",(0,p.kt)("inlineCode",{parentName:"p"},"number"),", it's treated as a timeout in milliseconds and the method returns a promise which resolves after the timeout."))}m.isMDXComponent=!0}}]);