Files
puppeteer/docs/api/puppeteer.puppeteer.registercustomqueryhandler.md
dependabot[bot]GitHubdependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>Nikolay Vitkov
4afe06b61d chore(deps-dev): Bump the dev-dependencies group with 14 updates (#13982)
Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Nikolay Vitkov <[email protected]>
2025-07-02 08:16:05 +00:00

1.2 KiB

sidebar_label
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

import {Puppeteer}, puppeteer from 'puppeteer';

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