puppeteer/assets/js/737a85ac.ae15bf43.js

"use strict";(self.webpackChunkwebsite=self.webpackChunkwebsite||[]).push([[14240],{3905:function(e,t,r){r.d(t,{Zo:function(){return c},kt:function(){return m}});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 u(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 p(e){for(var t=1;t<arguments.length;t++){var r=null!=arguments[t]?arguments[t]:{};t%2?u(Object(r),!0).forEach((function(t){a(e,t,r[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(r)):u(Object(r)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(r,t))}))}return e}function o(e,t){if(null==e)return{};var r,n,a=function(e,t){if(null==e)return{};var r,n,a={},u=Object.keys(e);for(n=0;n<u.length;n++)r=u[n],t.indexOf(r)>=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var u=Object.getOwnPropertySymbols(e);for(n=0;n<u.length;n++)r=u[n],t.indexOf(r)>=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var l=n.createContext({}),i=function(e){var t=n.useContext(l),r=t;return e&&(r="function"==typeof e?e(t):p(p({},t),e)),r},c=function(e){var t=i(e.components);return n.createElement(l.Provider,{value:t},e.children)},s={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},d=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,u=e.originalType,l=e.parentName,c=o(e,["components","mdxType","originalType","parentName"]),d=i(r),m=a,f=d["".concat(l,".").concat(m)]||d[m]||s[m]||u;return r?n.createElement(f,p(p({ref:t},c),{},{components:r})):n.createElement(f,p({ref:t},c))}));function m(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var u=r.length,p=new Array(u);p[0]=d;var o={};for(var l in t)hasOwnProperty.call(t,l)&&(o[l]=t[l]);o.originalType=e,o.mdxType="string"==typeof e?e:a,p[1]=o;for(var i=2;i<u;i++)p[i]=r[i];return n.createElement.apply(null,p)}return n.createElement.apply(null,r)}d.displayName="MDXCreateElement"},26206:function(e,t,r){r.r(t),r.d(t,{frontMatter:function(){return o},contentTitle:function(){return l},metadata:function(){return i},toc:function(){return c},default:function(){return d}});var n=r(87462),a=r(63366),u=(r(67294),r(3905)),p=["components"],o={},l=void 0,i={unversionedId:"puppeteer.registercustomqueryhandler",id:"puppeteer.registercustomqueryhandler",isDocsHomePage:!1,title:"puppeteer.registercustomqueryhandler",description:"Home &gt; puppeteer &gt; registerCustomQueryHandler",source:"@site/docs/puppeteer.registercustomqueryhandler.md",sourceDirName:".",slug:"/puppeteer.registercustomqueryhandler",permalink:"/puppeteer/docs/next/puppeteer.registercustomqueryhandler",editUrl:"https://github.com/facebook/puppeteer/edit/main/website/docs/puppeteer.registercustomqueryhandler.md",version:"current",frontMatter:{}},c=[{value:"registerCustomQueryHandler() function",id:"registercustomqueryhandler-function",children:[]},{value:"Parameters",id:"parameters",children:[]}],s={toc:c};function d(e){var t=e.components,r=(0,a.Z)(e,p);return(0,u.kt)("wrapper",(0,n.Z)({},s,r,{components:t,mdxType:"MDXLayout"}),(0,u.kt)("p",null,(0,u.kt)("a",{parentName:"p",href:"/puppeteer/docs/next/index"},"Home")," ",">"," ",(0,u.kt)("a",{parentName:"p",href:"/puppeteer/docs/next/puppeteer"},"puppeteer")," ",">"," ",(0,u.kt)("a",{parentName:"p",href:"/puppeteer/docs/next/puppeteer.registercustomqueryhandler"},"registerCustomQueryHandler")),(0,u.kt)("h2",{id:"registercustomqueryhandler-function"},"registerCustomQueryHandler() function"),(0,u.kt)("p",null,"Registers a ",(0,u.kt)("a",{parentName:"p",href:"/puppeteer/docs/next/puppeteer.customqueryhandler"},"custom query handler"),". After registration, the handler can be used everywhere where a selector is expected by prepending the selection string with ",(0,u.kt)("inlineCode",{parentName:"p"},"<name>/"),". The name is only allowed to consist of lower- and upper case latin letters."),(0,u.kt)("b",null,"Signature:"),(0,u.kt)("pre",null,(0,u.kt)("code",{parentName:"pre",className:"language-typescript"},"export declare function registerCustomQueryHandler(name: string, queryHandler: CustomQueryHandler): void;\n")),(0,u.kt)("h2",{id:"parameters"},"Parameters"),(0,u.kt)("table",null,(0,u.kt)("thead",{parentName:"table"},(0,u.kt)("tr",{parentName:"thead"},(0,u.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,u.kt)("th",{parentName:"tr",align:null},"Type"),(0,u.kt)("th",{parentName:"tr",align:null},"Description"))),(0,u.kt)("tbody",{parentName:"table"},(0,u.kt)("tr",{parentName:"tbody"},(0,u.kt)("td",{parentName:"tr",align:null},"name"),(0,u.kt)("td",{parentName:"tr",align:null},"string"),(0,u.kt)("td",{parentName:"tr",align:null},"The name that the custom query handler will be registered under.")),(0,u.kt)("tr",{parentName:"tbody"},(0,u.kt)("td",{parentName:"tr",align:null},"queryHandler"),(0,u.kt)("td",{parentName:"tr",align:null},(0,u.kt)("a",{parentName:"td",href:"/puppeteer/docs/next/puppeteer.customqueryhandler"},"CustomQueryHandler")),(0,u.kt)("td",{parentName:"tr",align:null},"The ",(0,u.kt)("a",{parentName:"td",href:"/puppeteer/docs/next/puppeteer.customqueryhandler"},"custom query handler")," to register.")))),(0,u.kt)("b",null,"Returns:"),(0,u.kt)("p",null,"void"))}d.isMDXComponent=!0}}]);