puppeteer/docs/api/puppeteer.puppeteer.registercustomqueryhandler.md
jrandolf 1847704789
fix!: refactor custom query handler API (#9078)
This PR removes the deprecated query selector API from the `puppeteer`
instance. Direct imports of the query selector API have also been
deprecated and users are now expected to use the static methods defined
on `Puppeteer`.
2022-10-10 16:01:09 +02:00

1.3 KiB

sidebar_label
Puppeteer.registerCustomQueryHandler

Puppeteer.registerCustomQueryHandler() method

Registers a custom query handler.

Signature:

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 The custom query handler 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/…');