Frame.$eval() method

Runs the given function on the first element matching the given selector in the frame.

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

Signature

typescript

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

Parameters

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>

string | Func

</td><td>

The function to be evaluated in the frame's context. The first element matching the 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

const searchValue = await frame.$eval('#search', el => el.value);