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

2.6 KiB

Raw Blame History

sidebar_label
Page.waitForFunction

Page.waitForFunction() method

Waits for a function to finish evaluating in the page's context.

Signature:

class Page {
  waitForFunction<
    Params extends unknown[],
    Func extends EvaluateFunc<Params> = EvaluateFunc<Params>
  >(
    pageFunction: Func | string,
    options?: FrameWaitForFunctionOptions,
    ...args: Params
  ): Promise<HandleFor<Awaited<ReturnType<Func>>>>;
}

Parameters

Parameter	Type	Description
pageFunction	Func \| string	Function to be evaluated in browser context
options	FrameWaitForFunctionOptions	(Optional) Options for configuring waiting behavior.
args	Params

Returns:

Promise<HandleFor<Awaited<ReturnType<Func>>>>

Example 1

The Page.waitForFunction() can be used to observe viewport size change:

const puppeteer = require('puppeteer');
(async () => {
  const browser = await puppeteer.launch();
  const page = await browser.newPage();
  const watchDog = page.waitForFunction('window.innerWidth < 100');
  await page.setViewport({width: 50, height: 50});
  await watchDog;
  await browser.close();
})();

Example 2

To pass arguments from node.js to the predicate of Page.waitForFunction() function:

const selector = '.foo';
await page.waitForFunction(
  selector => !!document.querySelector(selector),
  {},
  selector
);

Example 3

The predicate of Page.waitForFunction() can be asynchronous too:

const username = 'github-username';
await page.waitForFunction(
  async username => {
    const githubResponse = await fetch(
      `https://api.github.com/users/${username}`
    );
    const githubUser = await githubResponse.json();
    // show the avatar
    const img = document.createElement('img');
    img.src = githubUser.avatar_url;
    // wait 3 seconds
    await new Promise((resolve, reject) => setTimeout(resolve, 3000));
    img.remove();
  },
  {},
  username
);

2.6 KiB Raw Blame History