puppeteer/docs/api/puppeteer.frame._eval.md

sidebar_label
Frame.$eval

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:

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	Type	Description
selector	Selector	selector to query page for. CSS selectors can be passed as-is and a Puppeteer-specific seletor syntax allows quering by text, a11y role and name, and xpath and combining these queries across shadow roots. Alternatively, you can specify a selector type using a prefix prefix.
pageFunction	string | Func	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.
args	Params	Additional arguments to pass to pageFunction.

**Returns:**

Promise<Awaited<ReturnType<Func>>>

A promise to the result of the function.

Example

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