fix: update documentation on configuring puppeteer (#9150 )

This PR updates the docs regarding configuring puppeteer. In addition,
some changes have been made to the documentation generator to show
default values on the documentation site.

Also fixes: https://github.com/puppeteer/puppeteer/pull/9144

2022-10-24 09:07:05 +02:00

1.3 KiB

Raw Blame History

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

1.3 KiB Raw Blame History