Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(new): migrate Target to TSDoc #6067

Merged
merged 2 commits into from Jun 22, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
11 changes: 0 additions & 11 deletions new-docs/puppeteer.target._browsercontext.md

This file was deleted.

11 changes: 0 additions & 11 deletions new-docs/puppeteer.target._closedcallback.md

This file was deleted.

24 changes: 0 additions & 24 deletions new-docs/puppeteer.target._constructor_.md

This file was deleted.

11 changes: 0 additions & 11 deletions new-docs/puppeteer.target._defaultviewport.md

This file was deleted.

11 changes: 0 additions & 11 deletions new-docs/puppeteer.target._ignorehttpserrors.md

This file was deleted.

11 changes: 0 additions & 11 deletions new-docs/puppeteer.target._initializedcallback.md

This file was deleted.

11 changes: 0 additions & 11 deletions new-docs/puppeteer.target._initializedpromise.md

This file was deleted.

11 changes: 0 additions & 11 deletions new-docs/puppeteer.target._isclosedpromise.md

This file was deleted.

11 changes: 0 additions & 11 deletions new-docs/puppeteer.target._isinitialized.md

This file was deleted.

11 changes: 0 additions & 11 deletions new-docs/puppeteer.target._pagepromise.md

This file was deleted.

11 changes: 0 additions & 11 deletions new-docs/puppeteer.target._sessionfactory.md

This file was deleted.

11 changes: 0 additions & 11 deletions new-docs/puppeteer.target._targetid.md

This file was deleted.

11 changes: 0 additions & 11 deletions new-docs/puppeteer.target._targetinfo.md

This file was deleted.

22 changes: 0 additions & 22 deletions new-docs/puppeteer.target._targetinfochanged.md

This file was deleted.

11 changes: 0 additions & 11 deletions new-docs/puppeteer.target._workerpromise.md

This file was deleted.

2 changes: 2 additions & 0 deletions new-docs/puppeteer.target.browser.md
Expand Up @@ -4,6 +4,8 @@

## Target.browser() method

Get the browser the target belongs to.

<b>Signature:</b>

```typescript
Expand Down
2 changes: 2 additions & 0 deletions new-docs/puppeteer.target.createcdpsession.md
Expand Up @@ -4,6 +4,8 @@

## Target.createCDPSession() method

Creates a Chrome Devtools Protocol session attached to the target.

<b>Signature:</b>

```typescript
Expand Down
37 changes: 8 additions & 29 deletions new-docs/puppeteer.target.md
Expand Up @@ -10,41 +10,20 @@
export declare class Target
```

## Constructors
## Remarks

| Constructor | Modifiers | Description |
| --- | --- | --- |
| [(constructor)(targetInfo, browserContext, sessionFactory, ignoreHTTPSErrors, defaultViewport)](./puppeteer.target._constructor_.md) | | Constructs a new instance of the <code>Target</code> class |

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [\_browserContext](./puppeteer.target._browsercontext.md) | | [BrowserContext](./puppeteer.browsercontext.md) | |
| [\_closedCallback](./puppeteer.target._closedcallback.md) | | () =&gt; void | |
| [\_defaultViewport](./puppeteer.target._defaultviewport.md) | | Viewport | |
| [\_ignoreHTTPSErrors](./puppeteer.target._ignorehttpserrors.md) | | boolean | |
| [\_initializedCallback](./puppeteer.target._initializedcallback.md) | | (x: boolean) =&gt; void | |
| [\_initializedPromise](./puppeteer.target._initializedpromise.md) | | Promise&lt;boolean&gt; | |
| [\_isClosedPromise](./puppeteer.target._isclosedpromise.md) | | Promise&lt;boolean&gt; | |
| [\_isInitialized](./puppeteer.target._isinitialized.md) | | boolean | |
| [\_pagePromise](./puppeteer.target._pagepromise.md) | | Promise&lt;[Page](./puppeteer.page.md)<!-- -->&gt; | |
| [\_sessionFactory](./puppeteer.target._sessionfactory.md) | | () =&gt; Promise&lt;[CDPSession](./puppeteer.cdpsession.md)<!-- -->&gt; | |
| [\_targetId](./puppeteer.target._targetid.md) | | string | |
| [\_targetInfo](./puppeteer.target._targetinfo.md) | | Protocol.Target.TargetInfo | |
| [\_workerPromise](./puppeteer.target._workerpromise.md) | | Promise&lt;[WebWorker](./puppeteer.webworker.md)<!-- -->&gt; | |
The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `Target` class.

## Methods

| Method | Modifiers | Description |
| --- | --- | --- |
| [\_targetInfoChanged(targetInfo)](./puppeteer.target._targetinfochanged.md) | | |
| [browser()](./puppeteer.target.browser.md) | | |
| [browser()](./puppeteer.target.browser.md) | | Get the browser the target belongs to. |
| [browserContext()](./puppeteer.target.browsercontext.md) | | |
| [createCDPSession()](./puppeteer.target.createcdpsession.md) | | |
| [opener()](./puppeteer.target.opener.md) | | |
| [page()](./puppeteer.target.page.md) | | |
| [type()](./puppeteer.target.type.md) | | |
| [createCDPSession()](./puppeteer.target.createcdpsession.md) | | Creates a Chrome Devtools Protocol session attached to the target. |
| [opener()](./puppeteer.target.opener.md) | | Get the target that opened this target. Top-level targets return <code>null</code>. |
| [page()](./puppeteer.target.page.md) | | If the target is not of type <code>&quot;page&quot;</code> or <code>&quot;background_page&quot;</code>, returns <code>null</code>. |
| [type()](./puppeteer.target.type.md) | | Identifies what kind of target this is. |
| [url()](./puppeteer.target.url.md) | | |
| [worker()](./puppeteer.target.worker.md) | | |
| [worker()](./puppeteer.target.worker.md) | | If the target is not of type <code>&quot;service_worker&quot;</code> or <code>&quot;shared_worker&quot;</code>, returns <code>null</code>. |

2 changes: 2 additions & 0 deletions new-docs/puppeteer.target.opener.md
Expand Up @@ -4,6 +4,8 @@

## Target.opener() method

Get the target that opened this target. Top-level targets return `null`<!-- -->.

<b>Signature:</b>

```typescript
Expand Down
2 changes: 2 additions & 0 deletions new-docs/puppeteer.target.page.md
Expand Up @@ -4,6 +4,8 @@

## Target.page() method

If the target is not of type `"page"` or `"background_page"`<!-- -->, returns `null`<!-- -->.

<b>Signature:</b>

```typescript
Expand Down
6 changes: 6 additions & 0 deletions new-docs/puppeteer.target.type.md
Expand Up @@ -4,6 +4,8 @@

## Target.type() method

Identifies what kind of target this is.

<b>Signature:</b>

```typescript
Expand All @@ -13,3 +15,7 @@ type(): 'page' | 'background_page' | 'service_worker' | 'shared_worker' | 'other

'page' \| 'background\_page' \| 'service\_worker' \| 'shared\_worker' \| 'other' \| 'browser' \| 'webview'

## Remarks

See [docs](https://developer.chrome.com/extensions/background_pages) for more info about background pages.

2 changes: 2 additions & 0 deletions new-docs/puppeteer.target.worker.md
Expand Up @@ -4,6 +4,8 @@

## Target.worker() method

If the target is not of type `"service_worker"` or `"shared_worker"`<!-- -->, returns `null`<!-- -->.

<b>Signature:</b>

```typescript
Expand Down