Class Frame

Hierarchy

Target
- Frame

Implements

IFrame

Properties

id

id: string

Methods

$

$(s: string, options: SelectorOptions): Selector
Parameters
- s: string
- options: SelectorOptions
Returns Selector

Implementation of IFrame.$

Inherited from Target.$

cookieConsent

cookieConsent(buttonText: string): Promise<void>
Parameters
- buttonText: string
Returns Promise<void>

Inherited from Target.cookieConsent

evaluate

evaluate<Arg, R>(jsCode: string | ((arg: Arg) => R | Promise<R>), arg: Arg): Promise<R>
Type Parameters
- Arg
- R
Parameters
- jsCode: string | ((arg: Arg) => R | Promise<R>)
- arg: Arg
Returns Promise<R>

Implementation of IFrame.evaluate

Inherited from Target.evaluate

getFrameBySelector

getFrameBySelector(selector: string | ISelector, options?: GetFrameBySelectorOptions): Promise<IFrame>
Parameters
- selector: string | ISelector
- options: GetFrameBySelectorOptions = {}
Returns Promise<IFrame>

Implementation of IFrame.getFrameBySelector

Inherited from Target.getFrameBySelector

goto

goto(url: string, options?: {
referer?: string;
timeout?: number;
} & WaitUntilOption): Promise<null | Response>
Returns the main resource response. In case of multiple redirects, the navigation will resolve with the first non-redirect response.

The method will throw an error if:
- there's an SSL error (e.g. in case of self-signed certificates).
- target URL is invalid.
- the timeout is exceeded during navigation.
- the remote server does not respond or is unreachable.
- the main resource failed to load.
The method will not throw an error when any valid HTTP status code is returned by the remote server, including 404 "Not Found" and 500 "Internal Server Error".

NOTE: The method either throws an error or returns a main resource response. The only exceptions are navigation to about:blank or navigation to the same URL with a different hash, which would succeed and return null. NOTE: Headless mode doesn't support navigation to a PDF document. See the upstream issue.

Shortcut for main frame's frame.goto(url[, options])
Parameters
- url: string
  
  URL to navigate page to. The url should include scheme, e.g. https://. When a baseURL via the context options was provided and the passed URL is a path, it gets merged via the new URL() constructor.
- Optional options: {
  referer?: string;
  timeout?: number;
  } & WaitUntilOption
Returns Promise<null | Response>

Implementation of IFrame.goto

Inherited from Target.goto

innerHTML

innerHTML(options: TimeoutOption): Promise<string>
Parameters
- options: TimeoutOption
Returns Promise<string>

Implementation of IFrame.innerHTML

Inherited from Target.innerHTML

innerText

innerText(options: TimeoutOption): Promise<string>
Parameters
- options: TimeoutOption
Returns Promise<string>

Implementation of IFrame.innerText

Inherited from Target.innerText

isDetached

isDetached(): boolean
Returns boolean

Implementation of IFrame.isDetached

jsonLDParser

jsonLDParser(types: string | string[], options: TimeoutOption): Promise<JSONObject>
Parameters
- types: string | string[]
- options: TimeoutOption
Returns Promise<JSONObject>

Implementation of IFrame.jsonLDParser

Inherited from Target.jsonLDParser

name

name(): string
Returns string

Implementation of IFrame.name

parentFrame

parentFrame(): null | IFrame
Returns null | IFrame

Implementation of IFrame.parentFrame

url

url(): string
Returns string

Implementation of IFrame.url

Inherited from Target.url

waitForFunction

waitForFunction<Arg, R>(jsCode: string | ((arg: Arg) => R | Promise<R>), arg: Arg, options: {
polling?: number | "raf";
timeout?: number;
}): Promise<void>
Type Parameters
- Arg
- R
Parameters
- jsCode: string | ((arg: Arg) => R | Promise<R>)
- arg: Arg
- options: {
  polling?: number | "raf";
  timeout?: number;
  }
  - Optional polling?: number | "raf"
  - Optional timeout?: number
Returns Promise<void>

Implementation of IFrame.waitForFunction

Inherited from Target.waitForFunction

waitForLoadState

waitForLoadState(state?: "load" | "domcontentloaded" | "networkidle", options?: {
timeout?: number;
}): Promise<void>
Parameters
- Optional state: "load" | "domcontentloaded" | "networkidle"
- options: {
  timeout?: number;
  } = {}
  - Optional timeout?: number
Returns Promise<void>

Implementation of IFrame.waitForLoadState

Inherited from Target.waitForLoadState

waitForNavigation

waitForNavigation(options: WaitForNavigationOptions): Promise<void>
Parameters
- options: WaitForNavigationOptions
Returns Promise<void>

Implementation of IFrame.waitForNavigation

Inherited from Target.waitForNavigation

waitForSelector

waitForSelector(selector: string | ISelector, options: WaitForSelectorOptions): Promise<Selector>
Parameters
- selector: string | ISelector
- options: WaitForSelectorOptions
Returns Promise<Selector>

Implementation of IFrame.waitForSelector

Inherited from Target.waitForSelector

waitForTimeout

waitForTimeout(n: number): Promise<void>
Parameters
- n: number
Returns Promise<void>

Implementation of IFrame.waitForTimeout

Inherited from Target.waitForTimeout

waitForUrl

waitForUrl(__target: ITarget, url: string, options: WaitForUrlOptions): Promise<void>
Parameters
- __target: ITarget
- url: string
- options: WaitForUrlOptions
Returns Promise<void>

Implementation of IFrame.waitForUrl

Inherited from Target.waitForUrl

waitForUrlChange

waitForUrlChange(__target: ITarget, options: WaitForUrlOptions): Promise<void>
Parameters
- __target: ITarget
- options: WaitForUrlOptions
Returns Promise<void>

Implementation of IFrame.waitForUrlChange

Inherited from Target.waitForUrlChange

Class Frame

Hierarchy

Implements

Index

Properties

Methods

Properties

id

Methods

$

Parameters

s: string

options: SelectorOptions

Returns Selector

cookieConsent

Parameters

buttonText: string

Returns Promise<void>

evaluate

Type Parameters

Arg

R

Parameters

jsCode: string | ((arg: Arg) => R | Promise<R>)

arg: Arg

Returns Promise<R>

getFrameBySelector

Parameters

selector: string | ISelector

options: GetFrameBySelectorOptions = {}

Returns Promise<IFrame>

goto

Parameters

url: string

Optional options: { referer?: string; timeout?: number; } & WaitUntilOption

Returns Promise<null | Response>

innerHTML

Parameters

options: TimeoutOption

Returns Promise<string>

innerText

Parameters

options: TimeoutOption

Returns Promise<string>

isDetached

Returns boolean

jsonLDParser

Parameters

types: string | string[]

options: TimeoutOption

Returns Promise<JSONObject>

name

Returns string

page

Returns IPage

parentFrame

Returns null | IFrame

url

Returns string

waitForFunction

Type Parameters

Arg

R

Parameters

jsCode: string | ((arg: Arg) => R | Promise<R>)

arg: Arg

options: { polling?: number | "raf"; timeout?: number; }

Optional polling?: number | "raf"

Optional timeout?: number

Returns Promise<void>

waitForLoadState

Parameters

Optional state: "load" | "domcontentloaded" | "networkidle"

options: { timeout?: number; } = {}

Optional timeout?: number

Returns Promise<void>

waitForNavigation

Parameters

options: WaitForNavigationOptions

Returns Promise<void>

`Optional` options: {
referer?: string;
timeout?: number;
} & WaitUntilOption

options: {
polling?: number | "raf";
timeout?: number;
}

`Optional` polling?: number | "raf"

`Optional` timeout?: number

`Optional` state: "load" | "domcontentloaded" | "networkidle"

options: {
timeout?: number;
} = {}

`Optional` timeout?: number