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

import {Puppeteer}, puppeteer from 'puppeteer';

Puppeteer.registerCustomQueryHandler('text', { … });
const aHandle = await page.$('text/…');