Back to Puppeteer

ElementHandle.$$eval() method

docs/api/puppeteer.elementhandle.__eval.md

19.2.22.3 KB
Original Source

ElementHandle.$$eval() method

Runs the given function on an array of elements matching the given selector in the current element.

If the given function returns a promise, then this method will wait till the promise resolves.

Signature

typescript
class ElementHandle {
  $$eval<
    Selector extends string,
    Params extends unknown[],
    Func extends EvaluateFuncWith<Array<NodeFor<Selector>>, Params> =
      EvaluateFuncWith<Array<NodeFor<Selector>>, Params>,
  >(
    selector: Selector,
    pageFunction: Func | string,
    ...args: Params
  ): Promise<Awaited<ReturnType<Func>>>;
}

Parameters

<table><thead><tr><th>

Parameter

</th><th>

Type

</th><th>

Description

</th></tr></thead> <tbody><tr><td>

selector

</td><td>

Selector

</td><td>

selector to query the page for. CSS selectors can be passed as-is and a Puppeteer-specific selector syntax allows querying by text, a11y role and name, and xpath and combining these queries across shadow roots. Alternatively, you can specify the selector type using a prefix.

</td></tr> <tr><td>

pageFunction

</td><td>

Func | string

</td><td>

The function to be evaluated in the element's page's context. An array of elements matching the given selector will be passed to the function as its first argument.

</td></tr> <tr><td>

args

</td><td>

Params

</td><td>

Additional arguments to pass to pageFunction.

</td></tr> </tbody></table>

Returns:

Promise<Awaited<ReturnType<Func>>>

A promise to the result of the function.

Example

HTML:

html
<div class="feed">
  <div class="tweet">Hello!</div>
  <div class="tweet">Hi!</div>
</div>

JavaScript:

ts
const feedHandle = await page.$('.feed');

const listOfTweets = await feedHandle.$$eval('.tweet', nodes =>
  nodes.map(n => n.innerText),
);