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 Browser docs to TSDoc #6070

Merged
merged 1 commit into from Jun 23, 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.browser._closecallback.md

This file was deleted.

11 changes: 0 additions & 11 deletions new-docs/puppeteer.browser._connection.md

This file was deleted.

25 changes: 0 additions & 25 deletions new-docs/puppeteer.browser._constructor_.md

This file was deleted.

11 changes: 0 additions & 11 deletions new-docs/puppeteer.browser._contexts.md

This file was deleted.

22 changes: 0 additions & 22 deletions new-docs/puppeteer.browser._createpageincontext.md

This file was deleted.

11 changes: 0 additions & 11 deletions new-docs/puppeteer.browser._defaultcontext.md

This file was deleted.

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

This file was deleted.

22 changes: 0 additions & 22 deletions new-docs/puppeteer.browser._disposecontext.md

This file was deleted.

15 changes: 0 additions & 15 deletions new-docs/puppeteer.browser._getversion.md

This file was deleted.

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

This file was deleted.

11 changes: 0 additions & 11 deletions new-docs/puppeteer.browser._process.md

This file was deleted.

22 changes: 0 additions & 22 deletions new-docs/puppeteer.browser._targetcreated.md

This file was deleted.

24 changes: 0 additions & 24 deletions new-docs/puppeteer.browser._targetdestroyed.md

This file was deleted.

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

This file was deleted.

11 changes: 0 additions & 11 deletions new-docs/puppeteer.browser._targets.md

This file was deleted.

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

## Browser.browserContexts() method

Returns an array of all open browser contexts. In a newly created browser, this will return a single instance of [BrowserContext](./puppeteer.browsercontext.md)<!-- -->.

<b>Signature:</b>

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

## Browser.close() method

Closes Chromium and all of its pages (if any were opened). The [Browser](./puppeteer.browser.md) object itself is considered to be disposed and cannot be used anymore.

<b>Signature:</b>

```typescript
Expand Down
27 changes: 0 additions & 27 deletions new-docs/puppeteer.browser.create.md

This file was deleted.

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

## Browser.createIncognitoBrowserContext() method

Creates a new incognito browser context. This won't share cookies/cache with other browser contexts.

<b>Signature:</b>

```typescript
Expand All @@ -13,3 +15,19 @@ createIncognitoBrowserContext(): Promise<BrowserContext>;

Promise&lt;[BrowserContext](./puppeteer.browsercontext.md)<!-- -->&gt;

## Example


```js
(async () => {
const browser = await puppeteer.launch();
// Create a new incognito browser context.
const context = await browser.createIncognitoBrowserContext();
// Create a new page in a pristine context.
const page = await context.newPage();
// Do stuff
await page.goto('https://example.com');
})();

```

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

## Browser.defaultBrowserContext() method

Returns the default browser context. The default browser context cannot be closed.

<b>Signature:</b>

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

## Browser.disconnect() method

Disconnects Puppeteer from the browser, but leaves the Chromium process running. After calling `disconnect`<!-- -->, the [Browser](./puppeteer.browser.md) object is considered disposed and cannot be used anymore.

<b>Signature:</b>

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

## Browser.isConnected() method

Indicates that the browser is connected.

<b>Signature:</b>

```typescript
Expand Down