puppeteer/website/versioned_docs/version-17.0.0/api/puppeteer.registercustomqueryhandler.md
release-please[bot] e2d9858b38
chore(main): release 17.0.0 (#8828)
* chore(main): release 17.0.0

* chore: generate versioned docs

Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>
2022-08-29 11:11:05 +02:00

1.2 KiB

sidebar_label
registerCustomQueryHandler

registerCustomQueryHandler() function

Registers a custom query handler.

Signature:

export declare function registerCustomQueryHandler(
  name: string,
  handler: CustomQueryHandler
): void;

Parameters

Parameter Type Description
name string The name that the custom query handler will be registered under.
handler CustomQueryHandler

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/…');