puppeteer/docs/api/puppeteer.puppeteer.registercustomqueryhandler.md

76 lines
1.1 KiB
Markdown
Raw Normal View History

2022-07-05 13:41:43 +00:00
---
sidebar_label: Puppeteer.registerCustomQueryHandler
---
# Puppeteer.registerCustomQueryHandler() method
Registers a [custom query handler](./puppeteer.customqueryhandler.md).
2022-07-05 13:41:43 +00:00
#### Signature:
2022-07-05 13:41:43 +00:00
```typescript
class Puppeteer {
static registerCustomQueryHandler(
2022-07-05 13:41:43 +00:00
name: string,
queryHandler: CustomQueryHandler
): void;
}
```
## Parameters
<table><thead><tr><th>
2022-07-05 13:41:43 +00:00
Parameter
</th><th>
Type
</th><th>
Description
</th></tr></thead>
<tbody><tr><td>
name
</td><td>
string
</td><td>
The name that the custom query handler will be registered under.
</td></tr>
<tr><td>
queryHandler
</td><td>
[CustomQueryHandler](./puppeteer.customqueryhandler.md)
</td><td>
The [custom query handler](./puppeteer.customqueryhandler.md) to register.
</td></tr>
</tbody></table>
2022-07-05 13:41:43 +00:00
**Returns:**
void
## Remarks
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.
2022-07-05 13:41:43 +00:00
## Example
```
puppeteer.registerCustomQueryHandler('text', { … });
const aHandle = await page.$('text/…');
2022-07-05 13:41:43 +00:00
```