086c08998b
This adds the new docs that are generated by API Extractor via TSDoc. They are sparse because we do not yet use TSDoc in the codebase. This is the starting point and from here we can work through all the different classes and improve the documentation.
76 lines
4.0 KiB
Markdown
76 lines
4.0 KiB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
|
|
[Home](./index.md) > [puppeteer](./puppeteer.md) > [Frame](./puppeteer.frame.md)
|
|
|
|
## Frame class
|
|
|
|
<b>Signature:</b>
|
|
|
|
```typescript
|
|
export declare class Frame
|
|
```
|
|
|
|
## Constructors
|
|
|
|
| Constructor | Modifiers | Description |
|
|
| --- | --- | --- |
|
|
| [(constructor)(frameManager, client, parentFrame, frameId)](./puppeteer.frame._constructor_.md) | | Constructs a new instance of the <code>Frame</code> class |
|
|
|
|
## Properties
|
|
|
|
| Property | Modifiers | Type | Description |
|
|
| --- | --- | --- | --- |
|
|
| [\_childFrames](./puppeteer.frame._childframes.md) | | Set<[Frame](./puppeteer.frame.md)<!-- -->> | |
|
|
| [\_client](./puppeteer.frame._client.md) | | [CDPSession](./puppeteer.cdpsession.md) | |
|
|
| [\_detached](./puppeteer.frame._detached.md) | | boolean | |
|
|
| [\_frameManager](./puppeteer.frame._framemanager.md) | | [FrameManager](./puppeteer.framemanager.md) | |
|
|
| [\_id](./puppeteer.frame._id.md) | | string | |
|
|
| [\_lifecycleEvents](./puppeteer.frame._lifecycleevents.md) | | Set<string> | |
|
|
| [\_loaderId](./puppeteer.frame._loaderid.md) | | string | |
|
|
| [\_mainWorld](./puppeteer.frame._mainworld.md) | | DOMWorld | |
|
|
| [\_name](./puppeteer.frame._name.md) | | string | |
|
|
| [\_parentFrame](./puppeteer.frame._parentframe.md) | | [Frame](./puppeteer.frame.md) | |
|
|
| [\_secondaryWorld](./puppeteer.frame._secondaryworld.md) | | DOMWorld | |
|
|
| [\_url](./puppeteer.frame._url.md) | | string | |
|
|
|
|
## Methods
|
|
|
|
| Method | Modifiers | Description |
|
|
| --- | --- | --- |
|
|
| [\_detach()](./puppeteer.frame._detach.md) | | |
|
|
| [\_navigated(framePayload)](./puppeteer.frame._navigated.md) | | |
|
|
| [\_navigatedWithinDocument(url)](./puppeteer.frame._navigatedwithindocument.md) | | |
|
|
| [\_onLifecycleEvent(loaderId, name)](./puppeteer.frame._onlifecycleevent.md) | | |
|
|
| [\_onLoadingStopped()](./puppeteer.frame._onloadingstopped.md) | | |
|
|
| [$(selector)](./puppeteer.frame._.md) | | |
|
|
| [$$(selector)](./puppeteer.frame.__.md) | | |
|
|
| [$$eval(selector, pageFunction, args)](./puppeteer.frame.__eval.md) | | |
|
|
| [$eval(selector, pageFunction, args)](./puppeteer.frame._eval.md) | | |
|
|
| [$x(expression)](./puppeteer.frame._x.md) | | |
|
|
| [addScriptTag(options)](./puppeteer.frame.addscripttag.md) | | |
|
|
| [addStyleTag(options)](./puppeteer.frame.addstyletag.md) | | |
|
|
| [childFrames()](./puppeteer.frame.childframes.md) | | |
|
|
| [click(selector, options)](./puppeteer.frame.click.md) | | |
|
|
| [content()](./puppeteer.frame.content.md) | | |
|
|
| [evaluate(pageFunction, args)](./puppeteer.frame.evaluate.md) | | |
|
|
| [evaluateHandle(pageFunction, args)](./puppeteer.frame.evaluatehandle.md) | | |
|
|
| [executionContext()](./puppeteer.frame.executioncontext.md) | | |
|
|
| [focus(selector)](./puppeteer.frame.focus.md) | | |
|
|
| [goto(url, options)](./puppeteer.frame.goto.md) | | |
|
|
| [hover(selector)](./puppeteer.frame.hover.md) | | |
|
|
| [isDetached()](./puppeteer.frame.isdetached.md) | | |
|
|
| [name()](./puppeteer.frame.name.md) | | |
|
|
| [parentFrame()](./puppeteer.frame.parentframe.md) | | |
|
|
| [select(selector, values)](./puppeteer.frame.select.md) | | |
|
|
| [setContent(html, options)](./puppeteer.frame.setcontent.md) | | |
|
|
| [tap(selector)](./puppeteer.frame.tap.md) | | |
|
|
| [title()](./puppeteer.frame.title.md) | | |
|
|
| [type(selector, text, options)](./puppeteer.frame.type.md) | | |
|
|
| [url()](./puppeteer.frame.url.md) | | |
|
|
| [waitFor(selectorOrFunctionOrTimeout, options, args)](./puppeteer.frame.waitfor.md) | | |
|
|
| [waitForFunction(pageFunction, options, args)](./puppeteer.frame.waitforfunction.md) | | |
|
|
| [waitForNavigation(options)](./puppeteer.frame.waitfornavigation.md) | | |
|
|
| [waitForSelector(selector, options)](./puppeteer.frame.waitforselector.md) | | |
|
|
| [waitForXPath(xpath, options)](./puppeteer.frame.waitforxpath.md) | | |
|
|
|