mirror of
https://github.com/puppeteer/puppeteer
synced 2024-06-14 14:02:48 +00:00
93e9acc410
Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Nikolay Vitkov <nvitkov@chromium.org>
76 lines
1.1 KiB
Markdown
76 lines
1.1 KiB
Markdown
---
|
|
sidebar_label: Puppeteer.registerCustomQueryHandler
|
|
---
|
|
|
|
# Puppeteer.registerCustomQueryHandler() method
|
|
|
|
Registers a [custom query handler](./puppeteer.customqueryhandler.md).
|
|
|
|
#### Signature:
|
|
|
|
```typescript
|
|
class Puppeteer {
|
|
static registerCustomQueryHandler(
|
|
name: string,
|
|
queryHandler: CustomQueryHandler
|
|
): void;
|
|
}
|
|
```
|
|
|
|
## Parameters
|
|
|
|
<table><thead><tr><th>
|
|
|
|
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>
|
|
**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.
|
|
|
|
## Example
|
|
|
|
```
|
|
puppeteer.registerCustomQueryHandler('text', { … });
|
|
const aHandle = await page.$('text/…');
|
|
```
|