FrameBase | Bubanai API Documentation

Hierarchy

Evalable
JSEvalable
- FrameBase
  - Frame
  - Page

Index

Methods

$

$(selector: string): Promise<null | ElementHandle<Element>>

- Defined in node_modules/@types/puppeteer/index.d.ts:1198
The method queries frame for the selector. If there's no such element within the frame, the method will resolve to null.

Parameters
- selector: string
Returns Promise<null | ElementHandle<Element>>

$$

$$(selector: string): Promise<ElementHandle<Element>[]>

- Defined in node_modules/@types/puppeteer/index.d.ts:1204
The method runs document.querySelectorAll within the frame. If no elements match the selector, the return value resolve to [].

Parameters
- selector: string
Returns Promise<ElementHandle<Element>[]>

$$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>>

Inherited from Evalable.$$eval
- 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
Inherited from Evalable.$$eval
- 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
Inherited from Evalable.$$eval
- 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
Inherited from Evalable.$$eval
- 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
Inherited from Evalable.$$eval
- 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>>

Inherited from Evalable.$eval
- 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
Inherited from Evalable.$eval
- 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
Inherited from Evalable.$eval
- 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
Inherited from Evalable.$eval
- 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
Inherited from Evalable.$eval
- 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

$x

$x(expression: string): Promise<ElementHandle<Element>[]>

- Defined in node_modules/@types/puppeteer/index.d.ts:1210
The method evaluates the XPath expression.

Parameters
- expression: string
  
  XPath expression to evaluate.
Returns Promise<ElementHandle<Element>[]>

addScriptTag

addScriptTag(options: ScriptTagOptions): Promise<void>

- Defined in node_modules/@types/puppeteer/index.d.ts:1213
Adds a <script> tag into the page with the desired url or content.

Parameters
- options: ScriptTagOptions
Returns Promise<void>

addStyleTag

addStyleTag(options: StyleTagOptions): Promise<void>

- Defined in node_modules/@types/puppeteer/index.d.ts:1216
Adds a <link rel="stylesheet"> tag into the page with the desired url or a <style type="text/css"> tag with the content.

Parameters
- options: StyleTagOptions
Returns Promise<void>

click

click(selector: string, options?: ClickOptions): Promise<void>

- Defined in node_modules/@types/puppeteer/index.d.ts:1225
This method fetches an element with selector, scrolls it into view if needed, and then uses page.mouse to click in the center of the element. If there's no element matching selector, the method throws an error.

Parameters
- selector: string
  
  A selector to search for element to click. If there are multiple elements satisfying the selector, the first will be clicked.
- Optional options: ClickOptions
  
  Specifies the click options.
Returns Promise<void>

content

content(): Promise<string>

- Defined in node_modules/@types/puppeteer/index.d.ts:1228
Gets the full HTML contents of the page, including the doctype.

Returns Promise<string>

evaluate

evaluate<T>(pageFunction: T, ...args: SerializableOrJSHandle[]): Promise<EvaluateFnReturnType<T> extends PromiseLike<U> ? U : EvaluateFnReturnType<T>>

Inherited from JSEvalable.evaluate
- Defined in node_modules/@types/puppeteer/index.d.ts:270
Evaluates a function in the browser context. If the function, passed to the frame.evaluate, returns a Promise, then frame.evaluate would wait for the promise to resolve and return its value. If the function passed into frame.evaluate returns a non-Serializable value, then frame.evaluate resolves to undefined.

Type parameters
- T: EvaluateFn<any>
Parameters
- pageFunction: T
- Rest ...args: SerializableOrJSHandle[]
  
  Arguments to pass to fn
Returns Promise<EvaluateFnReturnType<T> extends PromiseLike<U> ? U : EvaluateFnReturnType<T>>

evaluateHandle

evaluateHandle<HandlerType>(pageFunction: string | ((arg1: any, ...args: any[]) => any), ...args: SerializableOrJSHandle[]): Promise<HandlerType>

Inherited from JSEvalable.evaluateHandle
- Defined in node_modules/@types/puppeteer/index.d.ts:284
The only difference between evaluate and evaluateHandle is that evaluateHandle returns in-page object (JSHandle). If the function, passed to the evaluateHandle, returns a Promise, then evaluateHandle would wait for the promise to resolve and return its value. The TypeScript definitions assume that evaluateHandle returns a JSHandle, but if you know it's going to return an ElementHandle, pass it as the generic argument:

Type parameters
- HandlerType: JSHandle<any, HandlerType> = JSHandle<any>
Parameters
- pageFunction: string | ((arg1: any, ...args: any[]) => any)
  
  a function that is run within the page
- Rest ...args: SerializableOrJSHandle[]
  
  arguments to be passed to the pageFunction
Returns Promise<HandlerType>

focus

focus(selector: string): Promise<void>

- Defined in node_modules/@types/puppeteer/index.d.ts:1238
This method fetches an element with selector and focuses it.

Parameters
- selector: string
Returns Promise<void>

goto

goto(url: string, options?: DirectNavigationOptions): Promise<null | Response>

- Defined in node_modules/@types/puppeteer/index.d.ts:1235
Navigates to a URL.

Parameters
- url: string
  
  URL to navigate page to. The url should include scheme, e.g. https://
- Optional options: DirectNavigationOptions
  
  The navigation parameters.
Returns Promise<null | Response>

hover

hover(selector: string): Promise<void>

- Defined in node_modules/@types/puppeteer/index.d.ts:1246
This method fetches an element with selector, scrolls it into view if needed, and then uses page.mouse to hover over the center of the element. If there's no element matching selector, the method throws an error.

Parameters
- selector: string
  
  A selector to search for element to hover. If there are multiple elements satisfying the selector, the first will be hovered.
Returns Promise<void>

select

select(selector: string, ...values: string[]): Promise<string[]>

- Defined in node_modules/@types/puppeteer/index.d.ts:1255
Triggers a change and input event once all the provided options have been selected. If there's no <select> element matching selector, the method throws an error.

Parameters
- selector: string
  
  A selector to query page for.
- Rest ...values: string[]
  
  Values of options to select. If the <select> has the multiple attribute, all values are considered, otherwise only the first one is taken into account.
Returns Promise<string[]>

setContent

setContent(html: string, options?: NavigationOptions): Promise<void>

- Defined in node_modules/@types/puppeteer/index.d.ts:1262
Sets the page content.

Parameters
- html: string
  
  HTML markup to assign to the page.
- Optional options: NavigationOptions
  
  The navigation parameters.
Returns Promise<void>

tap

tap(selector: string): Promise<void>

- Defined in node_modules/@types/puppeteer/index.d.ts:1270
This method fetches an element with selector, scrolls it into view if needed, and then uses page.touchscreen to tap in the center of the element.

Parameters
- selector: string
  
  A selector to search for element to tap. If there are multiple elements satisfying the selector, the first will be tapped.
Returns Promise<void>

title

title(): Promise<string>

- Defined in node_modules/@types/puppeteer/index.d.ts:1273
Returns page's title.

Returns Promise<string>

type

type(selector: string, text: string, options?: { delay: number }): Promise<void>

- Defined in node_modules/@types/puppeteer/index.d.ts:1281
Sends a keydown, keypress/input, and keyup event for each character in the text.

Parameters
- selector: string
  
  A selector of an element to type into. If there are multiple elements satisfying the selector, the first will be used.
- text: string
- Optional options: { delay: number }
  - delay: number
Returns Promise<void>

url

url(): string

- Defined in node_modules/@types/puppeteer/index.d.ts:1284
Returns frame's url.

Returns string

waitFor

waitFor(duration: number): Promise<void>
waitFor(selector: string, options: WaitForSelectorOptionsHidden): Promise<null | ElementHandle<Element>>
waitFor(selector: string, options?: WaitForSelectorOptions): Promise<ElementHandle<Element>>
waitFor(selector: EvaluateFn<any>, options?: WaitForSelectorOptions, ...args: SerializableOrJSHandle[]): Promise<JSHandle<any>>

- Defined in node_modules/@types/puppeteer/index.d.ts:1311
remarks

This method behaves differently depending on the first parameter. If it's a string, it will be treated as a selector or xpath (if the string starts with //). This method then is a shortcut for Frame.waitForSelector or Frame.waitForXPath.

If the first argument is a function this method is a shortcut for Frame.waitForFunction.

If the first argument is a number, it's treated as a timeout in milliseconds and the method returns a promise which resolves after the timeout.

deprecated

Don't use this method directly. Instead use the more explicit methods available: Frame.waitForSelector, Frame.waitForXPath, Frame.waitForFunction or Frame.waitForTimeout.

Parameters
- duration: number
Returns Promise<void>
- Defined in node_modules/@types/puppeteer/index.d.ts:1312
Parameters
- selector: string
- options: WaitForSelectorOptionsHidden
Returns Promise<null | ElementHandle<Element>>
- Defined in node_modules/@types/puppeteer/index.d.ts:1313
Parameters
- selector: string
- Optional options: WaitForSelectorOptions
Returns Promise<ElementHandle<Element>>
- Defined in node_modules/@types/puppeteer/index.d.ts:1314
Parameters
- selector: EvaluateFn<any>
- Optional options: WaitForSelectorOptions
- Rest ...args: SerializableOrJSHandle[]
Returns Promise<JSHandle<any>>

waitForFunction

waitForFunction(fn: EvaluateFn<any>, options?: PageFnOptions, ...args: SerializableOrJSHandle[]): Promise<JSHandle<any>>

- Defined in node_modules/@types/puppeteer/index.d.ts:1323
Allows waiting for various conditions.

Parameters
- fn: EvaluateFn<any>
- Optional options: PageFnOptions
- Rest ...args: SerializableOrJSHandle[]
Returns Promise<JSHandle<any>>

waitForNavigation

waitForNavigation(options?: NavigationOptions): Promise<Response>

- Defined in node_modules/@types/puppeteer/index.d.ts:1329
Wait for the page navigation occur.

Parameters
- Optional options: NavigationOptions
  
  The navigation parameters.
Returns Promise<Response>

waitForSelector

waitForSelector(selector: string, options?: WaitForSelectorOptions): Promise<ElementHandle<Element>>
waitForSelector(selector: string, options?: WaitForSelectorOptionsHidden): Promise<null | ElementHandle<Element>>

- Defined in node_modules/@types/puppeteer/index.d.ts:1331
Parameters
- selector: string
- Optional options: WaitForSelectorOptions
Returns Promise<ElementHandle<Element>>
- Defined in node_modules/@types/puppeteer/index.d.ts:1332
Parameters
- selector: string
- Optional options: WaitForSelectorOptionsHidden
Returns Promise<null | ElementHandle<Element>>

waitForTimeout

waitForTimeout(milliseconds: number): Promise<void>

- Defined in node_modules/@types/puppeteer/index.d.ts:1352
Causes your script to wait for the given number of milliseconds.
remarks

It's generally recommended to not wait for a number of seconds, but instead use Frame.waitForSelector, Frame.waitForXPath or Frame.waitForFunction to wait for exactly the conditions you want.

example
Wait for 1 second:
```
await frame.waitForTimeout(1000);
```
Parameters
- milliseconds: number
  
  the number of milliseconds to wait.
Returns Promise<void>

waitForXPath

waitForXPath(xpath: string, options?: WaitForSelectorOptions): Promise<ElementHandle<Element>>

- Defined in node_modules/@types/puppeteer/index.d.ts:1354
Parameters
- xpath: string
- Optional options: WaitForSelectorOptions
Returns Promise<ElementHandle<Element>>

Hierarchy

Index

Methods

Methods

$

Parameters

selector: string

Returns Promise<null | ElementHandle<Element>>

$$

Parameters

selector: string

Returns Promise<ElementHandle<Element>[]>

$$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