Skip to content

Commit

Permalink
docs: improve Browser docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@jrandolf
jrandolf committed Sep 18, 2023
1 parent 0b94ae2 commit 47d124b
Show file tree
Hide file tree
Showing 20 changed files with 220 additions and 233 deletions.
4 changes: 2 additions & 2 deletions docs/api/index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ sidebar_label: API
| Class | Description |
| --------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [Accessibility](./puppeteer.accessibility.md) | The Accessibility class provides methods for inspecting the browser's accessibility tree. The accessibility tree is used by assistive technology such as [screen readers](https://en.wikipedia.org/wiki/Screen_reader) or [switches](https://en.wikipedia.org/wiki/Switch_access). |
| [Browser](./puppeteer.browser.md) | A Browser is created when Puppeteer connects to a browser instance, either through [PuppeteerNode.launch()](./puppeteer.puppeteernode.launch.md) or [Puppeteer.connect()](./puppeteer.puppeteer.connect.md). |
| [Browser](./puppeteer.browser.md) | <p>[Browser](./puppeteer.browser.md) represents a browser instance that is either:</p><p>- connected to via [Puppeteer.connect()](./puppeteer.puppeteer.connect.md) or - launched by [PuppeteerNode.launch()](./puppeteer.puppeteernode.launch.md).</p><p>[Browser](./puppeteer.browser.md) [emits](./puppeteer.eventemitter.md) various events which are documented in the [BrowserEvent](./puppeteer.browserevent.md) enum.</p> |
| [BrowserContext](./puppeteer.browsercontext.md) | BrowserContexts provide a way to operate multiple independent browser sessions. When a browser is launched, it has a single BrowserContext used by default. The method [Browser.newPage](./puppeteer.browser.newpage.md) creates a page in the default browser context. |
| [CDPSession](./puppeteer.cdpsession.md) | The <code>CDPSession</code> instances are used to talk raw Chrome Devtools Protocol. |
| [Connection](./puppeteer.connection.md) | |
Expand Down Expand Up @@ -73,7 +73,7 @@ sidebar_label: API
| [BoxModel](./puppeteer.boxmodel.md) | |
| [BrowserConnectOptions](./puppeteer.browserconnectoptions.md) | Generic browser options that can be passed when launching any browser or when connecting to an existing browser instance. |
| [BrowserContextEvents](./puppeteer.browsercontextevents.md) | |
| [BrowserContextOptions](./puppeteer.browsercontextoptions.md) | BrowserContext options. |
| [BrowserContextOptions](./puppeteer.browsercontextoptions.md) | |
| [BrowserEvents](./puppeteer.browserevents.md) | |
| [BrowserLaunchArgumentOptions](./puppeteer.browserlaunchargumentoptions.md) | Launcher options that only apply to Chrome. |
| [CDPSessionEvents](./puppeteer.cdpsessionevents.md) | |
Expand Down
6 changes: 4 additions & 2 deletions docs/api/puppeteer.browser.browsercontexts.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,15 @@ sidebar_label: Browser.browserContexts

# 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).
Gets a list of open [browser contexts](./puppeteer.browsercontext.md).

In a newly-created [browser](./puppeteer.browser.md), this will return a single instance of [BrowserContext](./puppeteer.browsercontext.md).

#### Signature:

```typescript
class Browser {
browserContexts(): BrowserContext[];
abstract browserContexts(): BrowserContext[];
}
```

Expand Down
4 changes: 2 additions & 2 deletions docs/api/puppeteer.browser.close.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@ sidebar_label: Browser.close

# Browser.close() method

Closes the browser 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.
Closes this [browser](./puppeteer.browser.md) and all associated [pages](./puppeteer.page.md).

#### Signature:

```typescript
class Browser {
close(): Promise<void>;
abstract close(): Promise<void>;
}
```

Expand Down
24 changes: 13 additions & 11 deletions docs/api/puppeteer.browser.createincognitobrowsercontext.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,15 @@ sidebar_label: Browser.createIncognitoBrowserContext

# Browser.createIncognitoBrowserContext() method

Creates a new incognito browser context. This won't share cookies/cache with other browser contexts.
Creates a new incognito [browser context](./puppeteer.browsercontext.md).

This won't share cookies/cache with other [browser contexts](./puppeteer.browsercontext.md).

#### Signature:

```typescript
class Browser {
createIncognitoBrowserContext(
abstract createIncognitoBrowserContext(
options?: BrowserContextOptions
): Promise<BrowserContext>;
}
Expand All @@ -29,13 +31,13 @@ Promise&lt;[BrowserContext](./puppeteer.browsercontext.md)&gt;
## Example

```ts
(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');
})();
import puppeteer from 'puppeteer';

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');
```
8 changes: 6 additions & 2 deletions docs/api/puppeteer.browser.defaultbrowsercontext.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,20 @@ sidebar_label: Browser.defaultBrowserContext

# Browser.defaultBrowserContext() method

Returns the default browser context. The default browser context cannot be closed.
Gets the default [browser context](./puppeteer.browsercontext.md).

#### Signature:

```typescript
class Browser {
defaultBrowserContext(): BrowserContext;
abstract defaultBrowserContext(): BrowserContext;
}
```

**Returns:**

[BrowserContext](./puppeteer.browsercontext.md)

## Remarks

The default [browser context](./puppeteer.browsercontext.md) cannot be closed.
2 changes: 1 addition & 1 deletion docs/api/puppeteer.browser.disconnect.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ sidebar_label: Browser.disconnect

# Browser.disconnect() method

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

#### Signature:

Expand Down
4 changes: 2 additions & 2 deletions docs/api/puppeteer.browser.isconnected.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@ sidebar_label: Browser.isConnected

# Browser.isConnected() method

Indicates that the browser is connected.
Whether Puppeteer is connected to this [browser](./puppeteer.browser.md).

#### Signature:

```typescript
class Browser {
isConnected(): boolean;
abstract isConnected(): boolean;
}
```

Expand Down

0 comments on commit 47d124b

Please sign in to comment.