"use strict";(self.webpackChunkwebsite=self.webpackChunkwebsite||[]).push([[99379],{3905:function(e,t,n){n.d(t,{Zo:function(){return c},kt:function(){return m}});var a=n(67294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function l(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function o(e){for(var t=1;t<arguments.length;t++){var n=null!=arguments[t]?arguments[t]:{};t%2?l(Object(n),!0).forEach((function(t){r(e,t,n[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(n)):l(Object(n)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(n,t))}))}return e}function p(e,t){if(null==e)return{};var n,a,r=function(e,t){if(null==e)return{};var n,a,r={},l=Object.keys(e);for(a=0;a<l.length;a++)n=l[a],t.indexOf(n)>=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(a=0;a<l.length;a++)n=l[a],t.indexOf(n)>=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var u=a.createContext({}),i=function(e){var t=a.useContext(u),n=t;return e&&(n="function"==typeof e?e(t):o(o({},t),e)),n},c=function(e){var t=i(e.components);return a.createElement(u.Provider,{value:t},e.children)},d={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},s=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,l=e.originalType,u=e.parentName,c=p(e,["components","mdxType","originalType","parentName"]),s=i(n),m=r,x=s["".concat(u,".").concat(m)]||s[m]||d[m]||l;return n?a.createElement(x,o(o({ref:t},c),{},{components:n})):a.createElement(x,o({ref:t},c))}));function m(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var l=n.length,o=new Array(l);o[0]=s;var p={};for(var u in t)hasOwnProperty.call(t,u)&&(p[u]=t[u]);p.originalType=e,p.mdxType="string"==typeof e?e:r,o[1]=p;for(var i=2;i<l;i++)o[i]=n[i];return a.createElement.apply(null,o)}return a.createElement.apply(null,n)}s.displayName="MDXCreateElement"},16894:function(e,t,n){n.r(t),n.d(t,{frontMatter:function(){return p},contentTitle:function(){return u},metadata:function(){return i},toc:function(){return c},default:function(){return s}});var a=n(87462),r=n(63366),l=(n(67294),n(3905)),o=["components"],p={},u=void 0,i={unversionedId:"puppeteer.executioncontext.evaluatehandle",id:"version-10.0.0/puppeteer.executioncontext.evaluatehandle",isDocsHomePage:!1,title:"puppeteer.executioncontext.evaluatehandle",description:"Home &gt; puppeteer &gt; ExecutionContext &gt; evaluateHandle",source:"@site/versioned_docs/version-10.0.0/puppeteer.executioncontext.evaluatehandle.md",sourceDirName:".",slug:"/puppeteer.executioncontext.evaluatehandle",permalink:"/puppeteer/docs/10.0.0/puppeteer.executioncontext.evaluatehandle",editUrl:"https://github.com/facebook/puppeteer/edit/main/website/versioned_docs/version-10.0.0/puppeteer.executioncontext.evaluatehandle.md",version:"10.0.0",frontMatter:{},sidebar:"version-10.0.0/docs",previous:{title:"puppeteer.executioncontext.evaluate",permalink:"/puppeteer/docs/10.0.0/puppeteer.executioncontext.evaluate"},next:{title:"puppeteer.executioncontext.frame",permalink:"/puppeteer/docs/10.0.0/puppeteer.executioncontext.frame"}},c=[{value:"ExecutionContext.evaluateHandle() method",id:"executioncontextevaluatehandle-method",children:[]},{value:"Parameters",id:"parameters",children:[]},{value:"Remarks",id:"remarks",children:[]},{value:"Example 1",id:"example-1",children:[]},{value:"Example 2",id:"example-2",children:[]},{value:"Example 3",id:"example-3",children:[]}],d={toc:c};function s(e){var t=e.components,n=(0,r.Z)(e,o);return(0,l.kt)("wrapper",(0,a.Z)({},d,n,{components:t,mdxType:"MDXLayout"}),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/puppeteer/docs/10.0.0/index"},"Home")," ",">"," ",(0,l.kt)("a",{parentName:"p",href:"/puppeteer/docs/10.0.0/puppeteer"},"puppeteer")," ",">"," ",(0,l.kt)("a",{parentName:"p",href:"/puppeteer/docs/10.0.0/puppeteer.executioncontext"},"ExecutionContext")," ",">"," ",(0,l.kt)("a",{parentName:"p",href:"/puppeteer/docs/10.0.0/puppeteer.executioncontext.evaluatehandle"},"evaluateHandle")),(0,l.kt)("h2",{id:"executioncontextevaluatehandle-method"},"ExecutionContext.evaluateHandle() method"),(0,l.kt)("b",null,"Signature:"),(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre",className:"language-typescript"},"evaluateHandle<HandleType extends JSHandle | ElementHandle = JSHandle>(pageFunction: EvaluateHandleFn, ...args: SerializableOrJSHandle[]): Promise<HandleType>;\n")),(0,l.kt)("h2",{id:"parameters"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"pageFunction"),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"/puppeteer/docs/10.0.0/puppeteer.evaluatehandlefn"},"EvaluateHandleFn")),(0,l.kt)("td",{parentName:"tr",align:null},"a function to be evaluated in the ",(0,l.kt)("code",null,"executionContext"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"args"),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"/puppeteer/docs/10.0.0/puppeteer.serializableorjshandle"},"SerializableOrJSHandle"),"[","]"),(0,l.kt)("td",{parentName:"tr",align:null},"argument to pass to the page function")))),(0,l.kt)("b",null,"Returns:"),(0,l.kt)("p",null,"Promise","<","HandleType",">"),(0,l.kt)("p",null,"A promise that resolves to the return value of the given function as an in-page object (a ",(0,l.kt)("a",{parentName:"p",href:"/puppeteer/docs/10.0.0/puppeteer.jshandle"},"JSHandle"),")."),(0,l.kt)("h2",{id:"remarks"},"Remarks"),(0,l.kt)("p",null,"The only difference between ",(0,l.kt)("inlineCode",{parentName:"p"},"executionContext.evaluate")," and ",(0,l.kt)("inlineCode",{parentName:"p"},"executionContext.evaluateHandle")," is that ",(0,l.kt)("inlineCode",{parentName:"p"},"executionContext.evaluateHandle")," returns an in-page object (a ",(0,l.kt)("a",{parentName:"p",href:"/puppeteer/docs/10.0.0/puppeteer.jshandle"},"JSHandle"),"). If the function passed to the ",(0,l.kt)("inlineCode",{parentName:"p"},"executionContext.evaluateHandle")," returns a Promise, then ",(0,l.kt)("inlineCode",{parentName:"p"},"executionContext.evaluateHandle")," would wait for the promise to resolve and return its value."),(0,l.kt)("h2",{id:"example-1"},"Example 1"),(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre",className:"language-js"},"const context = await page.mainFrame().executionContext();\nconst aHandle = await context.evaluateHandle(() => Promise.resolve(self));\naHandle; // Handle for the global object.\n\n")),(0,l.kt)("h2",{id:"example-2"},"Example 2"),(0,l.kt)("p",null,"A string can also be passed in instead of a function."),(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre",className:"language-js"},"// Handle for the '3' * object.\nconst aHandle = await context.evaluateHandle('1 + 2');\n\n")),(0,l.kt)("h2",{id:"example-3"},"Example 3"),(0,l.kt)("p",null,"JSHandle instances can be passed as arguments to the ",(0,l.kt)("inlineCode",{parentName:"p"},"executionContext.* evaluateHandle"),":"),(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre",className:"language-js"},"const aHandle = await context.evaluateHandle(() => document.body);\nconst resultHandle = await context.evaluateHandle(body => body.innerHTML, * aHandle);\nconsole.log(await resultHandle.jsonValue()); // prints body's innerHTML\nawait aHandle.dispose();\nawait resultHandle.dispose();\n\n")))}s.isMDXComponent=!0}}]);