Evalable | Bubanai API Documentation

Defines $eval and $$eval for Page, Frame and ElementHandle.

Hierarchy

Evalable
- ElementHandle
- FrameBase

Index

Methods

$$eval
$eval

Methods

$$eval

$$eval<R>(selector: string, pageFunction: (elements: Element[]) => R | Promise<R>): Promise<WrapElementHandle<R>>
$$eval<R, X1>(selector: string, pageFunction: (elements: Element[], x1: UnwrapElementHandle<X1>) => R | Promise<R>, x1: X1): Promise<WrapElementHandle<R>>
$$eval<R, X1, X2>(selector: string, pageFunction: (elements: Element[], x1: UnwrapElementHandle<X1>, x2: UnwrapElementHandle<X2>) => R | Promise<R>, x1: X1, x2: X2): Promise<WrapElementHandle<R>>
$$eval<R, X1, X2, X3>(selector: string, pageFunction: (elements: Element[], x1: UnwrapElementHandle<X1>, x2: UnwrapElementHandle<X2>, x3: UnwrapElementHandle<X3>) => R | Promise<R>, x1: X1, x2: X2, x3: X3): Promise<WrapElementHandle<R>>
$$eval<R>(selector: string, pageFunction: (elements: Element[], ...args: any[]) => R | Promise<R>, ...args: SerializableOrJSHandle[]): Promise<WrapElementHandle<R>>

- Defined in node_modules/@types/puppeteer/index.d.ts:180
This method runs Array.from(document.querySelectorAll(selector)) within the context and passes it as the first argument to pageFunction.

If pageFunction returns a Promise, then $$eval would wait for the promise to resolve and return its value.

Type parameters
- R
Parameters
- selector: string
  
  A selector to query for
- pageFunction: (elements: Element[]) => R | Promise<R>
  
  Function to be evaluated in browser context
  - - (elements: Element[]): R | Promise<R>
    - Parameters
      - elements: Element[]
      Returns R | Promise<R>
Returns Promise<WrapElementHandle<R>>

Promise which resolves to the return value of pageFunction
- Defined in node_modules/@types/puppeteer/index.d.ts:193
This method runs Array.from(document.querySelectorAll(selector)) within the context and passes it as the first argument to pageFunction.

If pageFunction returns a Promise, then $$eval would wait for the promise to resolve and return its value.

Type parameters
- R
- X1
Parameters
- selector: string
  
  A selector to query for
- pageFunction: (elements: Element[], x1: UnwrapElementHandle<X1>) => R | Promise<R>
  
  Function to be evaluated in browser context
  - - (elements: Element[], x1: UnwrapElementHandle<X1>): R | Promise<R>
    - Parameters
      - elements: Element[]
      - x1: UnwrapElementHandle<X1>
      Returns R | Promise<R>
- x1: X1
  
  First argument to pass to pageFunction
Returns Promise<WrapElementHandle<R>>

Promise which resolves to the return value of pageFunction
- Defined in node_modules/@types/puppeteer/index.d.ts:211
This method runs Array.from(document.querySelectorAll(selector)) within the context and passes it as the first argument to pageFunction.

If pageFunction returns a Promise, then $$eval would wait for the promise to resolve and return its value.

Type parameters
- R
- X1
- X2
Parameters
- selector: string
  
  A selector to query for
- pageFunction: (elements: Element[], x1: UnwrapElementHandle<X1>, x2: UnwrapElementHandle<X2>) => R | Promise<R>
  
  Function to be evaluated in browser context
  - - (elements: Element[], x1: UnwrapElementHandle<X1>, x2: UnwrapElementHandle<X2>): R | Promise<R>
    - Parameters
      - elements: Element[]
      - x1: UnwrapElementHandle<X1>
      - x2: UnwrapElementHandle<X2>
      Returns R | Promise<R>
- x1: X1
  
  First argument to pass to pageFunction
- x2: X2
  
  Second argument to pass to pageFunction
Returns Promise<WrapElementHandle<R>>

Promise which resolves to the return value of pageFunction
- Defined in node_modules/@types/puppeteer/index.d.ts:231
This method runs Array.from(document.querySelectorAll(selector)) within the context and passes it as the first argument to pageFunction.

If pageFunction returns a Promise, then $$eval would wait for the promise to resolve and return its value.

Type parameters
- R
- X1
- X2
- X3
Parameters
- selector: string
  
  A selector to query for
- pageFunction: (elements: Element[], x1: UnwrapElementHandle<X1>, x2: UnwrapElementHandle<X2>, x3: UnwrapElementHandle<X3>) => R | Promise<R>
  
  Function to be evaluated in browser context
  - - (elements: Element[], x1: UnwrapElementHandle<X1>, x2: UnwrapElementHandle<X2>, x3: UnwrapElementHandle<X3>): R | Promise<R>
    - Parameters
      - elements: Element[]
      - x1: UnwrapElementHandle<X1>
      - x2: UnwrapElementHandle<X2>
      - x3: UnwrapElementHandle<X3>
      Returns R | Promise<R>
- x1: X1
  
  First argument to pass to pageFunction
- x2: X2
  
  Second argument to pass to pageFunction
- x3: X3
  
  Third argument to pass to pageFunction
Returns Promise<WrapElementHandle<R>>

Promise which resolves to the return value of pageFunction
- Defined in node_modules/@types/puppeteer/index.d.ts:255
This method runs Array.from(document.querySelectorAll(selector)) within the context and passes it as the first argument to pageFunction.

If pageFunction returns a Promise, then $$eval would wait for the promise to resolve and return its value.

Type parameters
- R
Parameters
- selector: string
  
  A selector to query for
- pageFunction: (elements: Element[], ...args: any[]) => R | Promise<R>
  
  Function to be evaluated in browser context
  - - (elements: Element[], ...args: any[]): R | Promise<R>
    - Parameters
      - elements: Element[]
      - Rest ...args: any[]
      Returns R | Promise<R>
- Rest ...args: SerializableOrJSHandle[]
  
  Arguments to pass to pageFunction
Returns Promise<WrapElementHandle<R>>

Promise which resolves to the return value of pageFunction

$eval

$eval<R>(selector: string, pageFunction: (element: Element) => R | Promise<R>): Promise<WrapElementHandle<R>>
$eval<R, X1>(selector: string, pageFunction: (element: Element, x1: UnwrapElementHandle<X1>) => R | Promise<R>, x1: X1): Promise<WrapElementHandle<R>>
$eval<R, X1, X2>(selector: string, pageFunction: (element: Element, x1: UnwrapElementHandle<X1>, x2: UnwrapElementHandle<X2>) => R | Promise<R>, x1: X1, x2: X2): Promise<WrapElementHandle<R>>
$eval<R, X1, X2, X3>(selector: string, pageFunction: (element: Element, x1: UnwrapElementHandle<X1>, x2: UnwrapElementHandle<X2>, x3: UnwrapElementHandle<X3>) => R | Promise<R>, x1: X1, x2: X2, x3: X3): Promise<WrapElementHandle<R>>
$eval<R>(selector: string, pageFunction: (element: Element, ...args: any[]) => R | Promise<R>, ...args: SerializableOrJSHandle[]): Promise<WrapElementHandle<R>>

- Defined in node_modules/@types/puppeteer/index.d.ts:89
This method runs document.querySelector within the context and passes it as the first argument to pageFunction. If there's no element matching selector, the method throws an error.

If pageFunction returns a Promise, then $eval would wait for the promise to resolve and return its value.

Type parameters
- R
Parameters
- selector: string
  
  A selector to query for
- pageFunction: (element: Element) => R | Promise<R>
  
  Function to be evaluated in browser context
  - - (element: Element): R | Promise<R>
    - Parameters
      - element: Element
      Returns R | Promise<R>
Returns Promise<WrapElementHandle<R>>

Promise which resolves to the return value of pageFunction
- Defined in node_modules/@types/puppeteer/index.d.ts:102
This method runs document.querySelector within the context and passes it as the first argument to pageFunction. If there's no element matching selector, the method throws an error.

If pageFunction returns a Promise, then $eval would wait for the promise to resolve and return its value.

Type parameters
- R
- X1
Parameters
- selector: string
  
  A selector to query for
- pageFunction: (element: Element, x1: UnwrapElementHandle<X1>) => R | Promise<R>
  
  Function to be evaluated in browser context
  - - (element: Element, x1: UnwrapElementHandle<X1>): R | Promise<R>
    - Parameters
      - element: Element
      - x1: UnwrapElementHandle<X1>
      Returns R | Promise<R>
- x1: X1
  
  First argument to pass to pageFunction
Returns Promise<WrapElementHandle<R>>

Promise which resolves to the return value of pageFunction
- Defined in node_modules/@types/puppeteer/index.d.ts:120
This method runs document.querySelector within the context and passes it as the first argument to pageFunction. If there's no element matching selector, the method throws an error.

If pageFunction returns a Promise, then $eval would wait for the promise to resolve and return its value.

Type parameters
- R
- X1
- X2
Parameters
- selector: string
  
  A selector to query for
- pageFunction: (element: Element, x1: UnwrapElementHandle<X1>, x2: UnwrapElementHandle<X2>) => R | Promise<R>
  
  Function to be evaluated in browser context
  - - (element: Element, x1: UnwrapElementHandle<X1>, x2: UnwrapElementHandle<X2>): R | Promise<R>
    - Parameters
      - element: Element
      - x1: UnwrapElementHandle<X1>
      - x2: UnwrapElementHandle<X2>
      Returns R | Promise<R>
- x1: X1
  
  First argument to pass to pageFunction
- x2: X2
  
  Second argument to pass to pageFunction
Returns Promise<WrapElementHandle<R>>

Promise which resolves to the return value of pageFunction
- Defined in node_modules/@types/puppeteer/index.d.ts:140
This method runs document.querySelector within the context and passes it as the first argument to pageFunction. If there's no element matching selector, the method throws an error.

If pageFunction returns a Promise, then $eval would wait for the promise to resolve and return its value.

Type parameters
- R
- X1
- X2
- X3
Parameters
- selector: string
  
  A selector to query for
- pageFunction: (element: Element, x1: UnwrapElementHandle<X1>, x2: UnwrapElementHandle<X2>, x3: UnwrapElementHandle<X3>) => R | Promise<R>
  
  Function to be evaluated in browser context
  - - (element: Element, x1: UnwrapElementHandle<X1>, x2: UnwrapElementHandle<X2>, x3: UnwrapElementHandle<X3>): R | Promise<R>
    - Parameters
      - element: Element
      - x1: UnwrapElementHandle<X1>
      - x2: UnwrapElementHandle<X2>
      - x3: UnwrapElementHandle<X3>
      Returns R | Promise<R>
- x1: X1
  
  First argument to pass to pageFunction
- x2: X2
  
  Second argument to pass to pageFunction
- x3: X3
  
  Third argument to pass to pageFunction
Returns Promise<WrapElementHandle<R>>

Promise which resolves to the return value of pageFunction
- Defined in node_modules/@types/puppeteer/index.d.ts:164
This method runs document.querySelector within the context and passes it as the first argument to pageFunction. If there's no element matching selector, the method throws an error.

If pageFunction returns a Promise, then $eval would wait for the promise to resolve and return its value.

Type parameters
- R
Parameters
- selector: string
  
  A selector to query for
- pageFunction: (element: Element, ...args: any[]) => R | Promise<R>
  
  Function to be evaluated in browser context
  - - (element: Element, ...args: any[]): R | Promise<R>
    - Parameters
      - element: Element
      - Rest ...args: any[]
      Returns R | Promise<R>
- Rest ...args: SerializableOrJSHandle[]
  
  Arguments to pass to pageFunction
Returns Promise<WrapElementHandle<R>>

Promise which resolves to the return value of pageFunction

Hierarchy

Index

Methods

Methods

$$eval

Type parameters

R

Parameters

selector: string

pageFunction: (elements: Element[]) => R | Promise<R>

Parameters

elements: Element[]

Returns R | Promise<R>

Returns Promise<WrapElementHandle<R>>

Type parameters

R

X1

Parameters

selector: string

pageFunction: (elements: Element[], x1: UnwrapElementHandle<X1>) => R | Promise<R>

Parameters

elements: Element[]

x1: UnwrapElementHandle<X1>

Returns R | Promise<R>

x1: X1

Returns Promise<WrapElementHandle<R>>

Type parameters

R

X1

X2

Parameters

selector: string

pageFunction: (elements: Element[], x1: UnwrapElementHandle<X1>, x2: UnwrapElementHandle<X2>) => R | Promise<R>

Parameters

elements: Element[]

x1: UnwrapElementHandle<X1>

x2: UnwrapElementHandle<X2>

Returns R | Promise<R>

x1: X1

x2: X2

Returns Promise<WrapElementHandle<R>>

Type parameters

R

X1

X2

X3

Parameters

selector: string

pageFunction: (elements: Element[], x1: UnwrapElementHandle<X1>, x2: UnwrapElementHandle<X2>, x3: UnwrapElementHandle<X3>) => R | Promise<R>

Parameters

elements: Element[]

x1: UnwrapElementHandle<X1>

x2: UnwrapElementHandle<X2>

x3: UnwrapElementHandle<X3>

Returns R | Promise<R>

x1: X1

x2: X2

x3: X3

Returns Promise<WrapElementHandle<R>>

Type parameters

R

Parameters

selector: string

pageFunction: (elements: Element[], ...args: any[]) => R | Promise<R>

Parameters

elements: Element[]

Rest ...args: any[]

Returns R | Promise<R>

Rest ...args: SerializableOrJSHandle[]

Returns Promise<WrapElementHandle<R>>

$eval

Type parameters

R

Parameters

selector: string

pageFunction: (element: Element) => R | Promise<R>

Parameters

element: Element

Returns R | Promise<R>

Returns Promise<WrapElementHandle<R>>