mirror of
https://github.com/puppeteer/puppeteer
synced 2024-06-14 14:02:48 +00:00
9fbb9f9653
Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>
41 lines
1.3 KiB
Markdown
41 lines
1.3 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
|
|
|
|
| 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. |
|
|
|
|
**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/…');
|
|
```
|