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

41 lines
1.3 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
| Parameter | Type | Description |
| ------------ | ------------------------------------------------------- | -------------------------------------------------------------------------- |
| name | string | The name that the custom query handler will be registered under. |
| queryHandler | [CustomQueryHandler](./puppeteer.customqueryhandler.md) | The [custom query handler](./puppeteer.customqueryhandler.md) to register. |
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
```