puppeteer/docs/api/puppeteer.browsercontext.waitfortarget.md
jrandolf f07ad2c661
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.8 KiB

sidebar_label
BrowserContext.waitForTarget

BrowserContext.waitForTarget() method

This searches for a target in this specific browser context.

Signature:

class BrowserContext {
  waitForTarget(
    predicate: (x: Target) => boolean | Promise<boolean>,
    options?: {
      timeout?: number;
    }
  ): Promise<Target>;
}

Parameters

Parameter Type Description
predicate (x: Target) => boolean | Promise<boolean> A function to be run for every target
options { timeout?: number; } (Optional) An object of options. Accepts a timout, which is the maximum wait time in milliseconds. Pass 0 to disable the timeout. Defaults to 30 seconds.

Returns:

Promise<Target>

Promise which resolves to the first target found that matches the predicate function.

Example

An example of finding a target for a page opened via window.open:

await page.evaluate(() => window.open('https://www.example.com/'));
const newWindowTarget = await browserContext.waitForTarget(
  target => target.url() === 'https://www.example.com/'
);