From 054fa2e45df57aa7f5a770b02a2be5cf190bc602 Mon Sep 17 00:00:00 2001 From: Jack Franklin Date: Thu, 2 Jul 2020 16:13:22 +0100 Subject: [PATCH] chore(docs): fix more documentation warnings (#6145) --- new-docs/puppeteer.credentials.md | 20 ++++++ new-docs/puppeteer.credentials.password.md | 11 +++ new-docs/puppeteer.credentials.username.md | 11 +++ new-docs/puppeteer.frame._childframes.md | 11 --- new-docs/puppeteer.frame._client.md | 11 --- new-docs/puppeteer.frame._constructor_.md | 23 ------- new-docs/puppeteer.frame._detached.md | 11 --- new-docs/puppeteer.frame._framemanager.md | 11 --- new-docs/puppeteer.frame._id.md | 11 --- new-docs/puppeteer.frame._lifecycleevents.md | 11 --- new-docs/puppeteer.frame._loaderid.md | 11 --- new-docs/puppeteer.frame._mainworld.md | 11 --- new-docs/puppeteer.frame._name.md | 11 --- new-docs/puppeteer.frame._parentframe.md | 11 --- new-docs/puppeteer.frame._secondaryworld.md | 11 --- new-docs/puppeteer.frame._url.md | 11 --- new-docs/puppeteer.frame.md | 23 +------ new-docs/puppeteer.frame.waitforselector.md | 2 +- new-docs/puppeteer.frame.waitforxpath.md | 2 +- new-docs/puppeteer.framemanager._client.md | 11 --- .../puppeteer.framemanager._constructor_.md | 23 ------- ...peteer.framemanager._contextidtocontext.md | 11 --- ...eteer.framemanager._ensureisolatedworld.md | 22 ------ new-docs/puppeteer.framemanager._frames.md | 11 --- ...puppeteer.framemanager._handleframetree.md | 22 ------ .../puppeteer.framemanager._isolatedworlds.md | 11 --- new-docs/puppeteer.framemanager._mainframe.md | 11 --- .../puppeteer.framemanager._networkmanager.md | 11 --- ...framemanager._onexecutioncontextcreated.md | 22 ------ ...amemanager._onexecutioncontextdestroyed.md | 22 ------ ...ramemanager._onexecutioncontextscleared.md | 15 ----- ...puppeteer.framemanager._onframeattached.md | 23 ------- ...puppeteer.framemanager._onframedetached.md | 22 ------ ...uppeteer.framemanager._onframenavigated.md | 22 ------ ...manager._onframenavigatedwithindocument.md | 23 ------- ...eer.framemanager._onframestoppedloading.md | 22 ------ ...uppeteer.framemanager._onlifecycleevent.md | 22 ------ new-docs/puppeteer.framemanager._page.md | 11 --- ...r.framemanager._removeframesrecursively.md | 22 ------ ...puppeteer.framemanager._timeoutsettings.md | 11 --- ...eteer.framemanager.executioncontextbyid.md | 22 ------ new-docs/puppeteer.framemanager.frame.md | 22 ------ new-docs/puppeteer.framemanager.frames.md | 15 ----- new-docs/puppeteer.framemanager.initialize.md | 15 ----- new-docs/puppeteer.framemanager.mainframe.md | 15 ----- new-docs/puppeteer.framemanager.md | 58 ---------------- .../puppeteer.framemanager.navigateframe.md | 28 -------- .../puppeteer.framemanager.networkmanager.md | 15 ----- new-docs/puppeteer.framemanager.page.md | 15 ----- ...eer.framemanager.waitforframenavigation.md | 26 ------- new-docs/puppeteer.md | 3 +- new-docs/puppeteer.page.authenticate.md | 2 +- ...puppeteer.waitforselectoroptions.hidden.md | 11 +++ new-docs/puppeteer.waitforselectoroptions.md | 21 ++++++ ...uppeteer.waitforselectoroptions.timeout.md | 11 +++ ...uppeteer.waitforselectoroptions.visible.md | 11 +++ src/api-docs-entry.ts | 2 + src/common/DOMWorld.ts | 6 ++ src/common/FrameManager.ts | 67 +++++++++++++------ src/common/NetworkManager.ts | 9 ++- 60 files changed, 164 insertions(+), 804 deletions(-) create mode 100644 new-docs/puppeteer.credentials.md create mode 100644 new-docs/puppeteer.credentials.password.md create mode 100644 new-docs/puppeteer.credentials.username.md delete mode 100644 new-docs/puppeteer.frame._childframes.md delete mode 100644 new-docs/puppeteer.frame._client.md delete mode 100644 new-docs/puppeteer.frame._constructor_.md delete mode 100644 new-docs/puppeteer.frame._detached.md delete mode 100644 new-docs/puppeteer.frame._framemanager.md delete mode 100644 new-docs/puppeteer.frame._id.md delete mode 100644 new-docs/puppeteer.frame._lifecycleevents.md delete mode 100644 new-docs/puppeteer.frame._loaderid.md delete mode 100644 new-docs/puppeteer.frame._mainworld.md delete mode 100644 new-docs/puppeteer.frame._name.md delete mode 100644 new-docs/puppeteer.frame._parentframe.md delete mode 100644 new-docs/puppeteer.frame._secondaryworld.md delete mode 100644 new-docs/puppeteer.frame._url.md delete mode 100644 new-docs/puppeteer.framemanager._client.md delete mode 100644 new-docs/puppeteer.framemanager._constructor_.md delete mode 100644 new-docs/puppeteer.framemanager._contextidtocontext.md delete mode 100644 new-docs/puppeteer.framemanager._ensureisolatedworld.md delete mode 100644 new-docs/puppeteer.framemanager._frames.md delete mode 100644 new-docs/puppeteer.framemanager._handleframetree.md delete mode 100644 new-docs/puppeteer.framemanager._isolatedworlds.md delete mode 100644 new-docs/puppeteer.framemanager._mainframe.md delete mode 100644 new-docs/puppeteer.framemanager._networkmanager.md delete mode 100644 new-docs/puppeteer.framemanager._onexecutioncontextcreated.md delete mode 100644 new-docs/puppeteer.framemanager._onexecutioncontextdestroyed.md delete mode 100644 new-docs/puppeteer.framemanager._onexecutioncontextscleared.md delete mode 100644 new-docs/puppeteer.framemanager._onframeattached.md delete mode 100644 new-docs/puppeteer.framemanager._onframedetached.md delete mode 100644 new-docs/puppeteer.framemanager._onframenavigated.md delete mode 100644 new-docs/puppeteer.framemanager._onframenavigatedwithindocument.md delete mode 100644 new-docs/puppeteer.framemanager._onframestoppedloading.md delete mode 100644 new-docs/puppeteer.framemanager._onlifecycleevent.md delete mode 100644 new-docs/puppeteer.framemanager._page.md delete mode 100644 new-docs/puppeteer.framemanager._removeframesrecursively.md delete mode 100644 new-docs/puppeteer.framemanager._timeoutsettings.md delete mode 100644 new-docs/puppeteer.framemanager.executioncontextbyid.md delete mode 100644 new-docs/puppeteer.framemanager.frame.md delete mode 100644 new-docs/puppeteer.framemanager.frames.md delete mode 100644 new-docs/puppeteer.framemanager.initialize.md delete mode 100644 new-docs/puppeteer.framemanager.mainframe.md delete mode 100644 new-docs/puppeteer.framemanager.md delete mode 100644 new-docs/puppeteer.framemanager.navigateframe.md delete mode 100644 new-docs/puppeteer.framemanager.networkmanager.md delete mode 100644 new-docs/puppeteer.framemanager.page.md delete mode 100644 new-docs/puppeteer.framemanager.waitforframenavigation.md create mode 100644 new-docs/puppeteer.waitforselectoroptions.hidden.md create mode 100644 new-docs/puppeteer.waitforselectoroptions.md create mode 100644 new-docs/puppeteer.waitforselectoroptions.timeout.md create mode 100644 new-docs/puppeteer.waitforselectoroptions.visible.md diff --git a/new-docs/puppeteer.credentials.md b/new-docs/puppeteer.credentials.md new file mode 100644 index 00000000..856b9cd8 --- /dev/null +++ b/new-docs/puppeteer.credentials.md @@ -0,0 +1,20 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Credentials](./puppeteer.credentials.md) + +## Credentials interface + + +Signature: + +```typescript +export interface Credentials +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [password](./puppeteer.credentials.password.md) | string | | +| [username](./puppeteer.credentials.username.md) | string | | + diff --git a/new-docs/puppeteer.credentials.password.md b/new-docs/puppeteer.credentials.password.md new file mode 100644 index 00000000..99b0e3a9 --- /dev/null +++ b/new-docs/puppeteer.credentials.password.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Credentials](./puppeteer.credentials.md) > [password](./puppeteer.credentials.password.md) + +## Credentials.password property + +Signature: + +```typescript +password: string; +``` diff --git a/new-docs/puppeteer.credentials.username.md b/new-docs/puppeteer.credentials.username.md new file mode 100644 index 00000000..6e99806b --- /dev/null +++ b/new-docs/puppeteer.credentials.username.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Credentials](./puppeteer.credentials.md) > [username](./puppeteer.credentials.username.md) + +## Credentials.username property + +Signature: + +```typescript +username: string; +``` diff --git a/new-docs/puppeteer.frame._childframes.md b/new-docs/puppeteer.frame._childframes.md deleted file mode 100644 index cc06fb39..00000000 --- a/new-docs/puppeteer.frame._childframes.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [Frame](./puppeteer.frame.md) > [\_childFrames](./puppeteer.frame._childframes.md) - -## Frame.\_childFrames property - -Signature: - -```typescript -_childFrames: Set; -``` diff --git a/new-docs/puppeteer.frame._client.md b/new-docs/puppeteer.frame._client.md deleted file mode 100644 index dcd51cc9..00000000 --- a/new-docs/puppeteer.frame._client.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [Frame](./puppeteer.frame.md) > [\_client](./puppeteer.frame._client.md) - -## Frame.\_client property - -Signature: - -```typescript -_client: CDPSession; -``` diff --git a/new-docs/puppeteer.frame._constructor_.md b/new-docs/puppeteer.frame._constructor_.md deleted file mode 100644 index 55183054..00000000 --- a/new-docs/puppeteer.frame._constructor_.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [Frame](./puppeteer.frame.md) > [(constructor)](./puppeteer.frame._constructor_.md) - -## Frame.(constructor) - -Constructs a new instance of the `Frame` class - -Signature: - -```typescript -constructor(frameManager: FrameManager, client: CDPSession, parentFrame: Frame | null, frameId: string); -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| frameManager | [FrameManager](./puppeteer.framemanager.md) | | -| client | [CDPSession](./puppeteer.cdpsession.md) | | -| parentFrame | [Frame](./puppeteer.frame.md) \| null | | -| frameId | string | | - diff --git a/new-docs/puppeteer.frame._detached.md b/new-docs/puppeteer.frame._detached.md deleted file mode 100644 index 9e8eb632..00000000 --- a/new-docs/puppeteer.frame._detached.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [Frame](./puppeteer.frame.md) > [\_detached](./puppeteer.frame._detached.md) - -## Frame.\_detached property - -Signature: - -```typescript -_detached: boolean; -``` diff --git a/new-docs/puppeteer.frame._framemanager.md b/new-docs/puppeteer.frame._framemanager.md deleted file mode 100644 index 124fcbb9..00000000 --- a/new-docs/puppeteer.frame._framemanager.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [Frame](./puppeteer.frame.md) > [\_frameManager](./puppeteer.frame._framemanager.md) - -## Frame.\_frameManager property - -Signature: - -```typescript -_frameManager: FrameManager; -``` diff --git a/new-docs/puppeteer.frame._id.md b/new-docs/puppeteer.frame._id.md deleted file mode 100644 index 6c72a3e6..00000000 --- a/new-docs/puppeteer.frame._id.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [Frame](./puppeteer.frame.md) > [\_id](./puppeteer.frame._id.md) - -## Frame.\_id property - -Signature: - -```typescript -_id: string; -``` diff --git a/new-docs/puppeteer.frame._lifecycleevents.md b/new-docs/puppeteer.frame._lifecycleevents.md deleted file mode 100644 index b92fc366..00000000 --- a/new-docs/puppeteer.frame._lifecycleevents.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [Frame](./puppeteer.frame.md) > [\_lifecycleEvents](./puppeteer.frame._lifecycleevents.md) - -## Frame.\_lifecycleEvents property - -Signature: - -```typescript -_lifecycleEvents: Set; -``` diff --git a/new-docs/puppeteer.frame._loaderid.md b/new-docs/puppeteer.frame._loaderid.md deleted file mode 100644 index 1d100bdf..00000000 --- a/new-docs/puppeteer.frame._loaderid.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [Frame](./puppeteer.frame.md) > [\_loaderId](./puppeteer.frame._loaderid.md) - -## Frame.\_loaderId property - -Signature: - -```typescript -_loaderId: string; -``` diff --git a/new-docs/puppeteer.frame._mainworld.md b/new-docs/puppeteer.frame._mainworld.md deleted file mode 100644 index 6ed38cb4..00000000 --- a/new-docs/puppeteer.frame._mainworld.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [Frame](./puppeteer.frame.md) > [\_mainWorld](./puppeteer.frame._mainworld.md) - -## Frame.\_mainWorld property - -Signature: - -```typescript -_mainWorld: DOMWorld; -``` diff --git a/new-docs/puppeteer.frame._name.md b/new-docs/puppeteer.frame._name.md deleted file mode 100644 index 5634ef7c..00000000 --- a/new-docs/puppeteer.frame._name.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [Frame](./puppeteer.frame.md) > [\_name](./puppeteer.frame._name.md) - -## Frame.\_name property - -Signature: - -```typescript -_name?: string; -``` diff --git a/new-docs/puppeteer.frame._parentframe.md b/new-docs/puppeteer.frame._parentframe.md deleted file mode 100644 index 305bb3fa..00000000 --- a/new-docs/puppeteer.frame._parentframe.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [Frame](./puppeteer.frame.md) > [\_parentFrame](./puppeteer.frame._parentframe.md) - -## Frame.\_parentFrame property - -Signature: - -```typescript -_parentFrame?: Frame; -``` diff --git a/new-docs/puppeteer.frame._secondaryworld.md b/new-docs/puppeteer.frame._secondaryworld.md deleted file mode 100644 index dccb93c7..00000000 --- a/new-docs/puppeteer.frame._secondaryworld.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [Frame](./puppeteer.frame.md) > [\_secondaryWorld](./puppeteer.frame._secondaryworld.md) - -## Frame.\_secondaryWorld property - -Signature: - -```typescript -_secondaryWorld: DOMWorld; -``` diff --git a/new-docs/puppeteer.frame._url.md b/new-docs/puppeteer.frame._url.md deleted file mode 100644 index 78b45c97..00000000 --- a/new-docs/puppeteer.frame._url.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [Frame](./puppeteer.frame.md) > [\_url](./puppeteer.frame._url.md) - -## Frame.\_url property - -Signature: - -```typescript -_url: string; -``` diff --git a/new-docs/puppeteer.frame.md b/new-docs/puppeteer.frame.md index 2325efe6..3e2677de 100644 --- a/new-docs/puppeteer.frame.md +++ b/new-docs/puppeteer.frame.md @@ -10,28 +10,9 @@ export declare class Frame ``` -## Constructors +## Remarks -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [(constructor)(frameManager, client, parentFrame, frameId)](./puppeteer.frame._constructor_.md) | | Constructs a new instance of the Frame 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 | | +The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `Frame` class. ## Methods diff --git a/new-docs/puppeteer.frame.waitforselector.md b/new-docs/puppeteer.frame.waitforselector.md index e5b3dd55..35394d30 100644 --- a/new-docs/puppeteer.frame.waitforselector.md +++ b/new-docs/puppeteer.frame.waitforselector.md @@ -15,7 +15,7 @@ waitForSelector(selector: string, options?: WaitForSelectorOptions): PromiseReturns: diff --git a/new-docs/puppeteer.frame.waitforxpath.md b/new-docs/puppeteer.frame.waitforxpath.md index d8a2d8d0..c4909316 100644 --- a/new-docs/puppeteer.frame.waitforxpath.md +++ b/new-docs/puppeteer.frame.waitforxpath.md @@ -15,7 +15,7 @@ waitForXPath(xpath: string, options?: WaitForSelectorOptions): PromiseReturns: diff --git a/new-docs/puppeteer.framemanager._client.md b/new-docs/puppeteer.framemanager._client.md deleted file mode 100644 index bde37e38..00000000 --- a/new-docs/puppeteer.framemanager._client.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [FrameManager](./puppeteer.framemanager.md) > [\_client](./puppeteer.framemanager._client.md) - -## FrameManager.\_client property - -Signature: - -```typescript -_client: CDPSession; -``` diff --git a/new-docs/puppeteer.framemanager._constructor_.md b/new-docs/puppeteer.framemanager._constructor_.md deleted file mode 100644 index 067e389d..00000000 --- a/new-docs/puppeteer.framemanager._constructor_.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [FrameManager](./puppeteer.framemanager.md) > [(constructor)](./puppeteer.framemanager._constructor_.md) - -## FrameManager.(constructor) - -Constructs a new instance of the `FrameManager` class - -Signature: - -```typescript -constructor(client: CDPSession, page: Page, ignoreHTTPSErrors: boolean, timeoutSettings: TimeoutSettings); -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| client | [CDPSession](./puppeteer.cdpsession.md) | | -| page | [Page](./puppeteer.page.md) | | -| ignoreHTTPSErrors | boolean | | -| timeoutSettings | TimeoutSettings | | - diff --git a/new-docs/puppeteer.framemanager._contextidtocontext.md b/new-docs/puppeteer.framemanager._contextidtocontext.md deleted file mode 100644 index c60b654f..00000000 --- a/new-docs/puppeteer.framemanager._contextidtocontext.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [FrameManager](./puppeteer.framemanager.md) > [\_contextIdToContext](./puppeteer.framemanager._contextidtocontext.md) - -## FrameManager.\_contextIdToContext property - -Signature: - -```typescript -_contextIdToContext: Map; -``` diff --git a/new-docs/puppeteer.framemanager._ensureisolatedworld.md b/new-docs/puppeteer.framemanager._ensureisolatedworld.md deleted file mode 100644 index 2f9d2249..00000000 --- a/new-docs/puppeteer.framemanager._ensureisolatedworld.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [FrameManager](./puppeteer.framemanager.md) > [\_ensureIsolatedWorld](./puppeteer.framemanager._ensureisolatedworld.md) - -## FrameManager.\_ensureIsolatedWorld() method - -Signature: - -```typescript -_ensureIsolatedWorld(name: string): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| name | string | | - -Returns: - -Promise<void> - diff --git a/new-docs/puppeteer.framemanager._frames.md b/new-docs/puppeteer.framemanager._frames.md deleted file mode 100644 index a74fe1c9..00000000 --- a/new-docs/puppeteer.framemanager._frames.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [FrameManager](./puppeteer.framemanager.md) > [\_frames](./puppeteer.framemanager._frames.md) - -## FrameManager.\_frames property - -Signature: - -```typescript -_frames: Map; -``` diff --git a/new-docs/puppeteer.framemanager._handleframetree.md b/new-docs/puppeteer.framemanager._handleframetree.md deleted file mode 100644 index 545cda4e..00000000 --- a/new-docs/puppeteer.framemanager._handleframetree.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [FrameManager](./puppeteer.framemanager.md) > [\_handleFrameTree](./puppeteer.framemanager._handleframetree.md) - -## FrameManager.\_handleFrameTree() method - -Signature: - -```typescript -_handleFrameTree(frameTree: Protocol.Page.FrameTree): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| frameTree | Protocol.Page.FrameTree | | - -Returns: - -void - diff --git a/new-docs/puppeteer.framemanager._isolatedworlds.md b/new-docs/puppeteer.framemanager._isolatedworlds.md deleted file mode 100644 index aedc83c3..00000000 --- a/new-docs/puppeteer.framemanager._isolatedworlds.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [FrameManager](./puppeteer.framemanager.md) > [\_isolatedWorlds](./puppeteer.framemanager._isolatedworlds.md) - -## FrameManager.\_isolatedWorlds property - -Signature: - -```typescript -_isolatedWorlds: Set; -``` diff --git a/new-docs/puppeteer.framemanager._mainframe.md b/new-docs/puppeteer.framemanager._mainframe.md deleted file mode 100644 index 8fe456f2..00000000 --- a/new-docs/puppeteer.framemanager._mainframe.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [FrameManager](./puppeteer.framemanager.md) > [\_mainFrame](./puppeteer.framemanager._mainframe.md) - -## FrameManager.\_mainFrame property - -Signature: - -```typescript -_mainFrame: Frame; -``` diff --git a/new-docs/puppeteer.framemanager._networkmanager.md b/new-docs/puppeteer.framemanager._networkmanager.md deleted file mode 100644 index e9a423e6..00000000 --- a/new-docs/puppeteer.framemanager._networkmanager.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [FrameManager](./puppeteer.framemanager.md) > [\_networkManager](./puppeteer.framemanager._networkmanager.md) - -## FrameManager.\_networkManager property - -Signature: - -```typescript -_networkManager: NetworkManager; -``` diff --git a/new-docs/puppeteer.framemanager._onexecutioncontextcreated.md b/new-docs/puppeteer.framemanager._onexecutioncontextcreated.md deleted file mode 100644 index d1c758f5..00000000 --- a/new-docs/puppeteer.framemanager._onexecutioncontextcreated.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [FrameManager](./puppeteer.framemanager.md) > [\_onExecutionContextCreated](./puppeteer.framemanager._onexecutioncontextcreated.md) - -## FrameManager.\_onExecutionContextCreated() method - -Signature: - -```typescript -_onExecutionContextCreated(contextPayload: Protocol.Runtime.ExecutionContextDescription): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| contextPayload | Protocol.Runtime.ExecutionContextDescription | | - -Returns: - -void - diff --git a/new-docs/puppeteer.framemanager._onexecutioncontextdestroyed.md b/new-docs/puppeteer.framemanager._onexecutioncontextdestroyed.md deleted file mode 100644 index 28e94748..00000000 --- a/new-docs/puppeteer.framemanager._onexecutioncontextdestroyed.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [FrameManager](./puppeteer.framemanager.md) > [\_onExecutionContextDestroyed](./puppeteer.framemanager._onexecutioncontextdestroyed.md) - -## FrameManager.\_onExecutionContextDestroyed() method - -Signature: - -```typescript -_onExecutionContextDestroyed(executionContextId: number): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| executionContextId | number | | - -Returns: - -void - diff --git a/new-docs/puppeteer.framemanager._onexecutioncontextscleared.md b/new-docs/puppeteer.framemanager._onexecutioncontextscleared.md deleted file mode 100644 index 8913a030..00000000 --- a/new-docs/puppeteer.framemanager._onexecutioncontextscleared.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [FrameManager](./puppeteer.framemanager.md) > [\_onExecutionContextsCleared](./puppeteer.framemanager._onexecutioncontextscleared.md) - -## FrameManager.\_onExecutionContextsCleared() method - -Signature: - -```typescript -_onExecutionContextsCleared(): void; -``` -Returns: - -void - diff --git a/new-docs/puppeteer.framemanager._onframeattached.md b/new-docs/puppeteer.framemanager._onframeattached.md deleted file mode 100644 index 25210425..00000000 --- a/new-docs/puppeteer.framemanager._onframeattached.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [FrameManager](./puppeteer.framemanager.md) > [\_onFrameAttached](./puppeteer.framemanager._onframeattached.md) - -## FrameManager.\_onFrameAttached() method - -Signature: - -```typescript -_onFrameAttached(frameId: string, parentFrameId?: string): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| frameId | string | | -| parentFrameId | string | | - -Returns: - -void - diff --git a/new-docs/puppeteer.framemanager._onframedetached.md b/new-docs/puppeteer.framemanager._onframedetached.md deleted file mode 100644 index 06f2e33c..00000000 --- a/new-docs/puppeteer.framemanager._onframedetached.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [FrameManager](./puppeteer.framemanager.md) > [\_onFrameDetached](./puppeteer.framemanager._onframedetached.md) - -## FrameManager.\_onFrameDetached() method - -Signature: - -```typescript -_onFrameDetached(frameId: string): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| frameId | string | | - -Returns: - -void - diff --git a/new-docs/puppeteer.framemanager._onframenavigated.md b/new-docs/puppeteer.framemanager._onframenavigated.md deleted file mode 100644 index 8936b209..00000000 --- a/new-docs/puppeteer.framemanager._onframenavigated.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [FrameManager](./puppeteer.framemanager.md) > [\_onFrameNavigated](./puppeteer.framemanager._onframenavigated.md) - -## FrameManager.\_onFrameNavigated() method - -Signature: - -```typescript -_onFrameNavigated(framePayload: Protocol.Page.Frame): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| framePayload | Protocol.Page.Frame | | - -Returns: - -void - diff --git a/new-docs/puppeteer.framemanager._onframenavigatedwithindocument.md b/new-docs/puppeteer.framemanager._onframenavigatedwithindocument.md deleted file mode 100644 index a88e63c1..00000000 --- a/new-docs/puppeteer.framemanager._onframenavigatedwithindocument.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [FrameManager](./puppeteer.framemanager.md) > [\_onFrameNavigatedWithinDocument](./puppeteer.framemanager._onframenavigatedwithindocument.md) - -## FrameManager.\_onFrameNavigatedWithinDocument() method - -Signature: - -```typescript -_onFrameNavigatedWithinDocument(frameId: string, url: string): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| frameId | string | | -| url | string | | - -Returns: - -void - diff --git a/new-docs/puppeteer.framemanager._onframestoppedloading.md b/new-docs/puppeteer.framemanager._onframestoppedloading.md deleted file mode 100644 index a174247d..00000000 --- a/new-docs/puppeteer.framemanager._onframestoppedloading.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [FrameManager](./puppeteer.framemanager.md) > [\_onFrameStoppedLoading](./puppeteer.framemanager._onframestoppedloading.md) - -## FrameManager.\_onFrameStoppedLoading() method - -Signature: - -```typescript -_onFrameStoppedLoading(frameId: string): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| frameId | string | | - -Returns: - -void - diff --git a/new-docs/puppeteer.framemanager._onlifecycleevent.md b/new-docs/puppeteer.framemanager._onlifecycleevent.md deleted file mode 100644 index 038eda0e..00000000 --- a/new-docs/puppeteer.framemanager._onlifecycleevent.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [FrameManager](./puppeteer.framemanager.md) > [\_onLifecycleEvent](./puppeteer.framemanager._onlifecycleevent.md) - -## FrameManager.\_onLifecycleEvent() method - -Signature: - -```typescript -_onLifecycleEvent(event: Protocol.Page.lifecycleEventPayload): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| event | Protocol.Page.lifecycleEventPayload | | - -Returns: - -void - diff --git a/new-docs/puppeteer.framemanager._page.md b/new-docs/puppeteer.framemanager._page.md deleted file mode 100644 index d7529db6..00000000 --- a/new-docs/puppeteer.framemanager._page.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [FrameManager](./puppeteer.framemanager.md) > [\_page](./puppeteer.framemanager._page.md) - -## FrameManager.\_page property - -Signature: - -```typescript -_page: Page; -``` diff --git a/new-docs/puppeteer.framemanager._removeframesrecursively.md b/new-docs/puppeteer.framemanager._removeframesrecursively.md deleted file mode 100644 index 508e8799..00000000 --- a/new-docs/puppeteer.framemanager._removeframesrecursively.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [FrameManager](./puppeteer.framemanager.md) > [\_removeFramesRecursively](./puppeteer.framemanager._removeframesrecursively.md) - -## FrameManager.\_removeFramesRecursively() method - -Signature: - -```typescript -_removeFramesRecursively(frame: Frame): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| frame | [Frame](./puppeteer.frame.md) | | - -Returns: - -void - diff --git a/new-docs/puppeteer.framemanager._timeoutsettings.md b/new-docs/puppeteer.framemanager._timeoutsettings.md deleted file mode 100644 index 1fa9f5b8..00000000 --- a/new-docs/puppeteer.framemanager._timeoutsettings.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [FrameManager](./puppeteer.framemanager.md) > [\_timeoutSettings](./puppeteer.framemanager._timeoutsettings.md) - -## FrameManager.\_timeoutSettings property - -Signature: - -```typescript -_timeoutSettings: TimeoutSettings; -``` diff --git a/new-docs/puppeteer.framemanager.executioncontextbyid.md b/new-docs/puppeteer.framemanager.executioncontextbyid.md deleted file mode 100644 index c55d5ba2..00000000 --- a/new-docs/puppeteer.framemanager.executioncontextbyid.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [FrameManager](./puppeteer.framemanager.md) > [executionContextById](./puppeteer.framemanager.executioncontextbyid.md) - -## FrameManager.executionContextById() method - -Signature: - -```typescript -executionContextById(contextId: number): ExecutionContext; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| contextId | number | | - -Returns: - -[ExecutionContext](./puppeteer.executioncontext.md) - diff --git a/new-docs/puppeteer.framemanager.frame.md b/new-docs/puppeteer.framemanager.frame.md deleted file mode 100644 index 36d57266..00000000 --- a/new-docs/puppeteer.framemanager.frame.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [FrameManager](./puppeteer.framemanager.md) > [frame](./puppeteer.framemanager.frame.md) - -## FrameManager.frame() method - -Signature: - -```typescript -frame(frameId: string): Frame | null; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| frameId | string | | - -Returns: - -[Frame](./puppeteer.frame.md) \| null - diff --git a/new-docs/puppeteer.framemanager.frames.md b/new-docs/puppeteer.framemanager.frames.md deleted file mode 100644 index efff043c..00000000 --- a/new-docs/puppeteer.framemanager.frames.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [FrameManager](./puppeteer.framemanager.md) > [frames](./puppeteer.framemanager.frames.md) - -## FrameManager.frames() method - -Signature: - -```typescript -frames(): Frame[]; -``` -Returns: - -[Frame](./puppeteer.frame.md)\[\] - diff --git a/new-docs/puppeteer.framemanager.initialize.md b/new-docs/puppeteer.framemanager.initialize.md deleted file mode 100644 index 4cc05ce1..00000000 --- a/new-docs/puppeteer.framemanager.initialize.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [FrameManager](./puppeteer.framemanager.md) > [initialize](./puppeteer.framemanager.initialize.md) - -## FrameManager.initialize() method - -Signature: - -```typescript -initialize(): Promise; -``` -Returns: - -Promise<void> - diff --git a/new-docs/puppeteer.framemanager.mainframe.md b/new-docs/puppeteer.framemanager.mainframe.md deleted file mode 100644 index a6e34f0c..00000000 --- a/new-docs/puppeteer.framemanager.mainframe.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [FrameManager](./puppeteer.framemanager.md) > [mainFrame](./puppeteer.framemanager.mainframe.md) - -## FrameManager.mainFrame() method - -Signature: - -```typescript -mainFrame(): Frame; -``` -Returns: - -[Frame](./puppeteer.frame.md) - diff --git a/new-docs/puppeteer.framemanager.md b/new-docs/puppeteer.framemanager.md deleted file mode 100644 index f1563870..00000000 --- a/new-docs/puppeteer.framemanager.md +++ /dev/null @@ -1,58 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [FrameManager](./puppeteer.framemanager.md) - -## FrameManager class - -Signature: - -```typescript -export declare class FrameManager extends EventEmitter -``` -Extends: [EventEmitter](./puppeteer.eventemitter.md) - -## Constructors - -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [(constructor)(client, page, ignoreHTTPSErrors, timeoutSettings)](./puppeteer.framemanager._constructor_.md) | | Constructs a new instance of the FrameManager class | - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [\_client](./puppeteer.framemanager._client.md) | | [CDPSession](./puppeteer.cdpsession.md) | | -| [\_contextIdToContext](./puppeteer.framemanager._contextidtocontext.md) | | Map<number, [ExecutionContext](./puppeteer.executioncontext.md)> | | -| [\_frames](./puppeteer.framemanager._frames.md) | | Map<string, [Frame](./puppeteer.frame.md)> | | -| [\_isolatedWorlds](./puppeteer.framemanager._isolatedworlds.md) | | Set<string> | | -| [\_mainFrame](./puppeteer.framemanager._mainframe.md) | | [Frame](./puppeteer.frame.md) | | -| [\_networkManager](./puppeteer.framemanager._networkmanager.md) | | NetworkManager | | -| [\_page](./puppeteer.framemanager._page.md) | | [Page](./puppeteer.page.md) | | -| [\_timeoutSettings](./puppeteer.framemanager._timeoutsettings.md) | | TimeoutSettings | | - -## Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [\_ensureIsolatedWorld(name)](./puppeteer.framemanager._ensureisolatedworld.md) | | | -| [\_handleFrameTree(frameTree)](./puppeteer.framemanager._handleframetree.md) | | | -| [\_onExecutionContextCreated(contextPayload)](./puppeteer.framemanager._onexecutioncontextcreated.md) | | | -| [\_onExecutionContextDestroyed(executionContextId)](./puppeteer.framemanager._onexecutioncontextdestroyed.md) | | | -| [\_onExecutionContextsCleared()](./puppeteer.framemanager._onexecutioncontextscleared.md) | | | -| [\_onFrameAttached(frameId, parentFrameId)](./puppeteer.framemanager._onframeattached.md) | | | -| [\_onFrameDetached(frameId)](./puppeteer.framemanager._onframedetached.md) | | | -| [\_onFrameNavigated(framePayload)](./puppeteer.framemanager._onframenavigated.md) | | | -| [\_onFrameNavigatedWithinDocument(frameId, url)](./puppeteer.framemanager._onframenavigatedwithindocument.md) | | | -| [\_onFrameStoppedLoading(frameId)](./puppeteer.framemanager._onframestoppedloading.md) | | | -| [\_onLifecycleEvent(event)](./puppeteer.framemanager._onlifecycleevent.md) | | | -| [\_removeFramesRecursively(frame)](./puppeteer.framemanager._removeframesrecursively.md) | | | -| [executionContextById(contextId)](./puppeteer.framemanager.executioncontextbyid.md) | | | -| [frame(frameId)](./puppeteer.framemanager.frame.md) | | | -| [frames()](./puppeteer.framemanager.frames.md) | | | -| [initialize()](./puppeteer.framemanager.initialize.md) | | | -| [mainFrame()](./puppeteer.framemanager.mainframe.md) | | | -| [navigateFrame(frame, url, options)](./puppeteer.framemanager.navigateframe.md) | | | -| [networkManager()](./puppeteer.framemanager.networkmanager.md) | | | -| [page()](./puppeteer.framemanager.page.md) | | | -| [waitForFrameNavigation(frame, options)](./puppeteer.framemanager.waitforframenavigation.md) | | | - diff --git a/new-docs/puppeteer.framemanager.navigateframe.md b/new-docs/puppeteer.framemanager.navigateframe.md deleted file mode 100644 index 5f16dd52..00000000 --- a/new-docs/puppeteer.framemanager.navigateframe.md +++ /dev/null @@ -1,28 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [FrameManager](./puppeteer.framemanager.md) > [navigateFrame](./puppeteer.framemanager.navigateframe.md) - -## FrameManager.navigateFrame() method - -Signature: - -```typescript -navigateFrame(frame: Frame, url: string, options?: { - referer?: string; - timeout?: number; - waitUntil?: PuppeteerLifeCycleEvent | PuppeteerLifeCycleEvent[]; - }): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| frame | [Frame](./puppeteer.frame.md) | | -| url | string | | -| options | { referer?: string; timeout?: number; waitUntil?: PuppeteerLifeCycleEvent \| PuppeteerLifeCycleEvent\[\]; } | | - -Returns: - -Promise<[HTTPResponse](./puppeteer.httpresponse.md) \| null> - diff --git a/new-docs/puppeteer.framemanager.networkmanager.md b/new-docs/puppeteer.framemanager.networkmanager.md deleted file mode 100644 index 5a4bd914..00000000 --- a/new-docs/puppeteer.framemanager.networkmanager.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [FrameManager](./puppeteer.framemanager.md) > [networkManager](./puppeteer.framemanager.networkmanager.md) - -## FrameManager.networkManager() method - -Signature: - -```typescript -networkManager(): NetworkManager; -``` -Returns: - -NetworkManager - diff --git a/new-docs/puppeteer.framemanager.page.md b/new-docs/puppeteer.framemanager.page.md deleted file mode 100644 index c2518bb3..00000000 --- a/new-docs/puppeteer.framemanager.page.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [FrameManager](./puppeteer.framemanager.md) > [page](./puppeteer.framemanager.page.md) - -## FrameManager.page() method - -Signature: - -```typescript -page(): Page; -``` -Returns: - -[Page](./puppeteer.page.md) - diff --git a/new-docs/puppeteer.framemanager.waitforframenavigation.md b/new-docs/puppeteer.framemanager.waitforframenavigation.md deleted file mode 100644 index f470429d..00000000 --- a/new-docs/puppeteer.framemanager.waitforframenavigation.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [FrameManager](./puppeteer.framemanager.md) > [waitForFrameNavigation](./puppeteer.framemanager.waitforframenavigation.md) - -## FrameManager.waitForFrameNavigation() method - -Signature: - -```typescript -waitForFrameNavigation(frame: Frame, options?: { - timeout?: number; - waitUntil?: PuppeteerLifeCycleEvent | PuppeteerLifeCycleEvent[]; - }): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| frame | [Frame](./puppeteer.frame.md) | | -| options | { timeout?: number; waitUntil?: PuppeteerLifeCycleEvent \| PuppeteerLifeCycleEvent\[\]; } | | - -Returns: - -Promise<[HTTPResponse](./puppeteer.httpresponse.md) \| null> - diff --git a/new-docs/puppeteer.md b/new-docs/puppeteer.md index c5648645..0961f47d 100644 --- a/new-docs/puppeteer.md +++ b/new-docs/puppeteer.md @@ -22,7 +22,6 @@ | [ExecutionContext](./puppeteer.executioncontext.md) | This class represents a context for JavaScript execution. A \[Page\] might have many execution contexts: - each [frame](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/iframe) has "default" execution context that is always created after frame is attached to DOM. This context is returned by the method. - [Extension](https://developer.chrome.com/extensions)'s content scripts create additional execution contexts.Besides pages, execution contexts can be found in [workers](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API). | | [FileChooser](./puppeteer.filechooser.md) | File choosers let you react to the page requesting for a file. | | [Frame](./puppeteer.frame.md) | | -| [FrameManager](./puppeteer.framemanager.md) | | | [HTTPRequest](./puppeteer.httprequest.md) | | | [HTTPResponse](./puppeteer.httpresponse.md) | The HTTPResponse class represents responses which are received by the [Page](./puppeteer.page.md) class. | | [JSHandle](./puppeteer.jshandle.md) | Represents an in-page JavaScript object. JSHandles can be created with the [page.evaluateHandle](./puppeteer.page.evaluatehandle.md) method. | @@ -56,6 +55,7 @@ | [ClickOptions](./puppeteer.clickoptions.md) | | | [ConsoleMessageLocation](./puppeteer.consolemessagelocation.md) | | | [CoverageEntry](./puppeteer.coverageentry.md) | The CoverageEntry class represents one entry of the coverage report. | +| [Credentials](./puppeteer.credentials.md) | | | [CSSCoverageOptions](./puppeteer.csscoverageoptions.md) | Set of configurable options for CSS coverage. | | [GeolocationOptions](./puppeteer.geolocationoptions.md) | | | [JSCoverageOptions](./puppeteer.jscoverageoptions.md) | Set of configurable options for JS coverage. | @@ -70,6 +70,7 @@ | [SnapshotOptions](./puppeteer.snapshotoptions.md) | | | [TracingOptions](./puppeteer.tracingoptions.md) | | | [WaitForOptions](./puppeteer.waitforoptions.md) | | +| [WaitForSelectorOptions](./puppeteer.waitforselectoroptions.md) | | | [WaitForTargetOptions](./puppeteer.waitfortargetoptions.md) | | | [WaitTimeoutOptions](./puppeteer.waittimeoutoptions.md) | | diff --git a/new-docs/puppeteer.page.authenticate.md b/new-docs/puppeteer.page.authenticate.md index 02544b4c..afda0e0b 100644 --- a/new-docs/puppeteer.page.authenticate.md +++ b/new-docs/puppeteer.page.authenticate.md @@ -14,7 +14,7 @@ authenticate(credentials: Credentials): Promise; | Parameter | Type | Description | | --- | --- | --- | -| credentials | Credentials | | +| credentials | [Credentials](./puppeteer.credentials.md) | | Returns: diff --git a/new-docs/puppeteer.waitforselectoroptions.hidden.md b/new-docs/puppeteer.waitforselectoroptions.hidden.md new file mode 100644 index 00000000..f512acbf --- /dev/null +++ b/new-docs/puppeteer.waitforselectoroptions.hidden.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [WaitForSelectorOptions](./puppeteer.waitforselectoroptions.md) > [hidden](./puppeteer.waitforselectoroptions.hidden.md) + +## WaitForSelectorOptions.hidden property + +Signature: + +```typescript +hidden?: boolean; +``` diff --git a/new-docs/puppeteer.waitforselectoroptions.md b/new-docs/puppeteer.waitforselectoroptions.md new file mode 100644 index 00000000..68a445e6 --- /dev/null +++ b/new-docs/puppeteer.waitforselectoroptions.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [WaitForSelectorOptions](./puppeteer.waitforselectoroptions.md) + +## WaitForSelectorOptions interface + + +Signature: + +```typescript +export interface WaitForSelectorOptions +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [hidden](./puppeteer.waitforselectoroptions.hidden.md) | boolean | | +| [timeout](./puppeteer.waitforselectoroptions.timeout.md) | number | | +| [visible](./puppeteer.waitforselectoroptions.visible.md) | boolean | | + diff --git a/new-docs/puppeteer.waitforselectoroptions.timeout.md b/new-docs/puppeteer.waitforselectoroptions.timeout.md new file mode 100644 index 00000000..8ba2d84c --- /dev/null +++ b/new-docs/puppeteer.waitforselectoroptions.timeout.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [WaitForSelectorOptions](./puppeteer.waitforselectoroptions.md) > [timeout](./puppeteer.waitforselectoroptions.timeout.md) + +## WaitForSelectorOptions.timeout property + +Signature: + +```typescript +timeout?: number; +``` diff --git a/new-docs/puppeteer.waitforselectoroptions.visible.md b/new-docs/puppeteer.waitforselectoroptions.visible.md new file mode 100644 index 00000000..4019630f --- /dev/null +++ b/new-docs/puppeteer.waitforselectoroptions.visible.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [WaitForSelectorOptions](./puppeteer.waitforselectoroptions.md) > [visible](./puppeteer.waitforselectoroptions.visible.md) + +## WaitForSelectorOptions.visible property + +Signature: + +```typescript +visible?: boolean; +``` diff --git a/src/api-docs-entry.ts b/src/api-docs-entry.ts index f4908764..b7dcf04b 100644 --- a/src/api-docs-entry.ts +++ b/src/api-docs-entry.ts @@ -33,6 +33,7 @@ export * from './common/ConsoleMessage'; export * from './common/Coverage'; export * from './common/DeviceDescriptors'; export * from './common/Dialog'; +export * from './common/DOMWorld'; export * from './common/JSHandle'; export * from './common/ExecutionContext'; export * from './common/EventEmitter'; @@ -49,6 +50,7 @@ export * from './common/SecurityDetails'; export * from './common/Target'; export * from './common/Errors'; export * from './common/Tracing'; +export * from './common/NetworkManager'; export * from './common/WebWorker'; export * from './common/USKeyboardLayout'; export * from './common/EvalTypes'; diff --git a/src/common/DOMWorld.ts b/src/common/DOMWorld.ts index 326cdf0b..1cf644f8 100644 --- a/src/common/DOMWorld.ts +++ b/src/common/DOMWorld.ts @@ -36,12 +36,18 @@ import { isNode } from '../environment'; // when it is used in the predicate function below. declare const predicateQueryHandler: QueryHandler; +/** + * @public + */ export interface WaitForSelectorOptions { visible?: boolean; hidden?: boolean; timeout?: number; } +/** + * @internal + */ export class DOMWorld { _frameManager: FrameManager; _frame: Frame; diff --git a/src/common/FrameManager.ts b/src/common/FrameManager.ts index 61bbe8be..f6c1aa9a 100644 --- a/src/common/FrameManager.ts +++ b/src/common/FrameManager.ts @@ -38,15 +38,18 @@ import { const UTILITY_WORLD_NAME = '__puppeteer_utility_world__'; +/** + * @internal + */ export class FrameManager extends EventEmitter { _client: CDPSession; - _page: Page; - _networkManager: NetworkManager; + private _page: Page; + private _networkManager: NetworkManager; _timeoutSettings: TimeoutSettings; - _frames = new Map(); - _contextIdToContext = new Map(); - _isolatedWorlds = new Set(); - _mainFrame: Frame; + private _frames = new Map(); + private _contextIdToContext = new Map(); + private _isolatedWorlds = new Set(); + private _mainFrame: Frame; constructor( client: CDPSession, @@ -234,7 +237,7 @@ export class FrameManager extends EventEmitter { if (this._frames.has(frameId)) return; assert(parentFrameId); const parentFrame = this._frames.get(parentFrameId); - const frame = new Frame(this, this._client, parentFrame, frameId); + const frame = new Frame(this, parentFrame, frameId); this._frames.set(frame._id, frame); this.emit(Events.FrameManager.FrameAttached, frame); } @@ -263,7 +266,7 @@ export class FrameManager extends EventEmitter { frame._id = framePayload.id; } else { // Initial main frame navigation. - frame = new Frame(this, this._client, null, framePayload.id); + frame = new Frame(this, null, framePayload.id); } this._frames.set(framePayload.id, frame); this._mainFrame = frame; @@ -335,17 +338,14 @@ export class FrameManager extends EventEmitter { this._contextIdToContext.set(contextPayload.id, context); } - /** - * @param {number} executionContextId - */ - _onExecutionContextDestroyed(executionContextId: number): void { + private _onExecutionContextDestroyed(executionContextId: number): void { const context = this._contextIdToContext.get(executionContextId); if (!context) return; this._contextIdToContext.delete(executionContextId); if (context._world) context._world._setContext(null); } - _onExecutionContextsCleared(): void { + private _onExecutionContextsCleared(): void { for (const context of this._contextIdToContext.values()) { if (context._world) context._world._setContext(null); } @@ -358,7 +358,7 @@ export class FrameManager extends EventEmitter { return context; } - _removeFramesRecursively(frame: Frame): void { + private _removeFramesRecursively(frame: Frame): void { for (const child of frame.childFrames()) this._removeFramesRecursively(child); frame._detach(); @@ -367,30 +367,57 @@ export class FrameManager extends EventEmitter { } } +/** + * @public + */ export class Frame { + /** + * @internal + */ _frameManager: FrameManager; - _client: CDPSession; - _parentFrame?: Frame; + private _parentFrame?: Frame; + /** + * @internal + */ _id: string; - _url = ''; - _detached = false; + private _url = ''; + private _detached = false; + /** + * @internal + */ _loaderId = ''; + /** + * @internal + */ _name?: string; + /** + * @internal + */ _lifecycleEvents = new Set(); + /** + * @internal + */ _mainWorld: DOMWorld; + /** + * @internal + */ _secondaryWorld: DOMWorld; + /** + * @internal + */ _childFrames: Set; + /** + * @internal + */ constructor( frameManager: FrameManager, - client: CDPSession, parentFrame: Frame | null, frameId: string ) { this._frameManager = frameManager; - this._client = client; this._parentFrame = parentFrame; this._url = ''; this._id = frameId; diff --git a/src/common/NetworkManager.ts b/src/common/NetworkManager.ts index 2f52284c..3f3c829e 100644 --- a/src/common/NetworkManager.ts +++ b/src/common/NetworkManager.ts @@ -23,11 +23,17 @@ import { FrameManager } from './FrameManager'; import { HTTPRequest } from './HTTPRequest'; import { HTTPResponse } from './HTTPResponse'; +/** + * @public + */ export interface Credentials { username: string; password: string; } +/** + * @internal + */ export class NetworkManager extends EventEmitter { _client: CDPSession; _ignoreHTTPSErrors: boolean; @@ -183,9 +189,6 @@ export class NetworkManager extends EventEmitter { this._onRequest(event, null); } - /** - * @param {!Protocol.Fetch.authRequiredPayload} event - */ _onAuthRequired(event: Protocol.Fetch.authRequiredPayload): void { /* TODO(jacktfranklin): This is defined in protocol.d.ts but not * in an easily referrable way - we should look at exposing it.