puppeteer/website/versioned_docs/version-20.4.0/api/puppeteer.puppeteer.registercustomqueryhandler.md
release-please[bot] b1308d1c95
chore: release main (#10228)
Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>
2023-05-25 04:52:07 +00: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/…');