github/puppeteer
0
0
Fork 0
mirror of https://github.com/puppeteer/puppeteer synced 2024-06-14 14:02:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(api): expand registerCustomQueryHandler example (#6557)

Browse Source 
This patch makes it easier to see exactly how to use the registerCustomQueryHandler API without having to follow the trail of breadcrumbs throughout the docs.
This commit is contained in:
Mathias Bynens 2020-10-29 15:22:03 +01:00 committed by GitHub
parent a0d8a27856
commit 8bc8a76c89
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 15 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
docs/api.md
View File

@ -617,18 +617,24 @@ The product is set by the `PUPPETEER_PRODUCT` environment variable or the `produ
- `name` <[string]> The name that the custom query handler will be registered under.
- `queryHandler` <[CustomQueryHandler]> The [custom query handler](#interface-customqueryhandler) to register.
Registers a [custom query handler](#interface-customqueryhandler). After registration,
the handler can be used everywhere where a selector is expected by prepending
the selection string with `<name>/`. The name is only allowed to consist of
lower- and upper case latin letters.
Registers a [custom query handler](#interface-customqueryhandler). After registration, the handler can be used everywhere where a selector is expected by prepending the selection string with `<name>/`. The name is only allowed to consist of lower- and upper case latin letters.
Example:
```
puppeteer.registerCustomQueryHandler('text', { … });
const aHandle = await page.$('text/…');
```js
puppeteer.registerCustomQueryHandler('getByClass', {
queryOne: (element, selector) => {
return element.querySelector(`.${selector}`);
},
queryAll: (element, selector) => {
return element.querySelectorAll(`.${selector}`);
},
});
const aHandle = await page.$('getByClass/…');
```
#### puppeteer.unregisterCustomQueryHandler(name)
- `name` <[string]> The name of the query handler to unregistered.
- `name` <[string]> The name of the query handler to unregister.
### class: BrowserFetcher
@ -4173,14 +4179,7 @@ This method is identical to `off` and maintained for compatibility with Node's E
### interface: CustomQueryHandler
Contains two functions `queryOne` and `queryAll` that can be
[registered](#puppeteerregistercustomqueryhandlername-queryhandler) as
alternative querying strategies. The functions `queryOne` and `queryAll` are
executed in the page context. `queryOne` should take an `Element` and a
selector string as argument and return a single `Element` or `null` if no
element is found. `queryAll` takes the same arguments but should instead return
a `NodeListOf<Element>` or `Array<Element>` with all the elements that match
the given query selector.
Contains two functions `queryOne` and `queryAll` that can be [registered](#puppeteerregistercustomqueryhandlername-queryhandler) as alternative querying strategies. The functions `queryOne` and `queryAll` are executed in the page context. `queryOne` should take an `Element` and a selector string as argument and return a single `Element` or `null` if no element is found. `queryAll` takes the same arguments but should instead return a `NodeList<Element>` or `Array<Element>` with all the elements that match the given query selector.
[AXNode]: #accessibilitysnapshotoptions "AXNode"
[Accessibility]: #class-accessibility "Accessibility"