puppeteer/assets/js/ef402815.130b885c.js

"use strict";(self.webpackChunkwebsite=self.webpackChunkwebsite||[]).push([[83665],{3905:function(e,t,r){r.d(t,{Zo:function(){return m},kt:function(){return f}});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 u=n.createContext({}),l=function(e){var t=n.useContext(u),r=t;return e&&(r="function"==typeof e?e(t):o(o({},t),e)),r},m=function(e){var t=l(e.components);return n.createElement(u.Provider,{value:t},e.children)},c={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},s=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,p=e.originalType,u=e.parentName,m=i(e,["components","mdxType","originalType","parentName"]),s=l(r),f=a,d=s["".concat(u,".").concat(f)]||s[f]||c[f]||p;return r?n.createElement(d,o(o({ref:t},m),{},{components:r})):n.createElement(d,o({ref:t},m))}));function f(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var p=r.length,o=new Array(p);o[0]=s;var i={};for(var u in t)hasOwnProperty.call(t,u)&&(i[u]=t[u]);i.originalType=e,i.mdxType="string"==typeof e?e:a,o[1]=i;for(var l=2;l<p;l++)o[l]=r[l];return n.createElement.apply(null,o)}return n.createElement.apply(null,r)}s.displayName="MDXCreateElement"},4833:function(e,t,r){r.r(t),r.d(t,{frontMatter:function(){return i},contentTitle:function(){return u},metadata:function(){return l},toc:function(){return m},default:function(){return s}});var n=r(87462),a=r(63366),p=(r(67294),r(3905)),o=["components"],i={},u=void 0,l={unversionedId:"puppeteer.frame.waitfor",id:"puppeteer.frame.waitfor",isDocsHomePage:!1,title:"puppeteer.frame.waitfor",description:"Home &gt; puppeteer &gt; Frame &gt; waitFor",source:"@site/docs/puppeteer.frame.waitfor.md",sourceDirName:".",slug:"/puppeteer.frame.waitfor",permalink:"/puppeteer/docs/next/puppeteer.frame.waitfor",editUrl:"https://github.com/facebook/puppeteer/edit/main/website/docs/puppeteer.frame.waitfor.md",version:"current",frontMatter:{},sidebar:"docs",previous:{title:"puppeteer.frame.url",permalink:"/puppeteer/docs/next/puppeteer.frame.url"},next:{title:"puppeteer.frame.waitforfunction",permalink:"/puppeteer/docs/next/puppeteer.frame.waitforfunction"}},m=[{value:"Frame.waitFor() method",id:"framewaitfor-method",children:[]},{value:"Parameters",id:"parameters",children:[]},{value:"Remarks",id:"remarks",children:[]}],c={toc:m};function s(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.frame"},"Frame")," ",">"," ",(0,p.kt)("a",{parentName:"p",href:"/puppeteer/docs/next/puppeteer.frame.waitfor"},"waitFor")),(0,p.kt)("h2",{id:"framewaitfor-method"},"Frame.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.frame.waitforselector"},"Frame.waitForSelector()"),", ",(0,p.kt)("a",{parentName:"p",href:"/puppeteer/docs/next/puppeteer.frame.waitforxpath"},"Frame.waitForXPath()"),", ",(0,p.kt)("a",{parentName:"p",href:"/puppeteer/docs/next/puppeteer.frame.waitforfunction"},"Frame.waitForFunction()")," or ",(0,p.kt)("a",{parentName:"p",href:"/puppeteer/docs/next/puppeteer.frame.waitfortimeout"},"Frame.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?: Record<string, unknown>, ...args: SerializableOrJSHandle[]): Promise<JSHandle | null>;\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},"Record","<","string, unknown",">"),(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")," ","|"," null",">"),(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.frame.waitforselector"},"Frame.waitForSelector()")," or ",(0,p.kt)("a",{parentName:"p",href:"/puppeteer/docs/next/puppeteer.frame.waitforxpath"},"Frame.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.frame.waitforfunction"},"Frame.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."))}s.isMDXComponent=!0}}]);