Module

x/puppeteer/mod.ts>Browser

A port of puppeteer running on Deno
lucacasonato/deno-puppeteer
Very Popular
Latest
class Browser
extends EventEmitter
import { Browser } from "https://dotland.deno.dev/x/puppeteer@16.2.0/mod.ts";

A Browser is created when Puppeteer connects to a Chromium instance, either through {@link PuppeteerNode.launch} or {@link Puppeteer.connect}.

Examples

An example of using a {@link Browser} to create a {@link Page}:

const puppeteer = require('puppeteer');

(async () => {
  const browser = await puppeteer.launch();
  const page = await browser.newPage();
  await page.goto('https://example.com');
  await browser.close();
})();

An example of disconnecting from and reconnecting to a {@link Browser}:

const puppeteer = require('puppeteer');

(async () => {
  const browser = await puppeteer.launch();
  // Store the endpoint to be able to reconnect to Chromium
  const browserWSEndpoint = browser.wsEndpoint();
  // Disconnect puppeteer from Chromium
  browser.disconnect();

  // Use the endpoint to reestablish a connection
  const browser2 = await puppeteer.connect({browserWSEndpoint});
  // Close Chromium
  await browser2.close();
})();

Constructors

new
Browser(
product: "chrome" | "firefox" | undefined,
connection: Connection,
contextIds: string[],
ignoreHTTPSErrors: boolean,
defaultViewport?: Viewport | null,
process?: Deno.Process,
closeCallback?: BrowserCloseCallback,
targetFilterCallback?: TargetFilterCallback,
isPageTargetCallback?: IsPageTargetCallback,
)

Properties

readonly
_targets: Map<string, Target>

Methods

_attach(): Promise<void>
_createPageInContext(contextId?: string): Promise<Page>
_detach(): void
_disposeContext(contextId?: string): Promise<void>
_getIsPageTargetCallback(): IsPageTargetCallback | undefined
_targetManager(): TargetManager
browserContexts(): BrowserContext[]

Returns an array of all open browser contexts. In a newly created browser, this will return a single instance of {@link BrowserContext}.

close(): Promise<void>

Closes Chromium and all of its pages (if any were opened). The {@link Browser} object itself is considered to be disposed and cannot be used anymore.

createIncognitoBrowserContext(options?: BrowserContextOptions): Promise<BrowserContext>

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

defaultBrowserContext(): BrowserContext

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

disconnect(): void

Disconnects Puppeteer from the browser, but leaves the Chromium process running. After calling disconnect, the {@link Browser} object is considered disposed and cannot be used anymore.

isConnected(): boolean

Indicates that the browser is connected.

newPage(): Promise<Page>

Promise which resolves to a new {@link Page} object. The Page is created in a default browser context.

pages(): Promise<Page[]>

An array of all open pages inside the Browser.

process(): Deno.Process | null

The spawned browser process. Returns null if the browser instance was created with {@link Puppeteer.connect}.

target(): Target

The target associated with the browser.

targets(): Target[]

All active targets inside the Browser. In case of multiple browser contexts, returns an array with all the targets in all browser contexts.

userAgent(): Promise<string>

The browser's original user agent. Pages can override the browser user agent with {@link Page.setUserAgent}.

version(): Promise<string>

A string representing the browser name and version.

waitForTarget(predicate: (x: Target) => boolean | Promise<boolean>, options?: WaitForTargetOptions): Promise<Target>

Searches for a target in all browser contexts.

wsEndpoint(): string

The browser websocket endpoint which can be used as an argument to {@link Puppeteer.connect}.

Static Methods

_create(
product: "firefox" | "chrome" | undefined,
connection: Connection,
contextIds: string[],
ignoreHTTPSErrors: boolean,
defaultViewport?: Viewport | null,
process?: Deno.Process,
closeCallback?: BrowserCloseCallback,
targetFilterCallback?: TargetFilterCallback,
isPageTargetCallback?: IsPageTargetCallback,
): Promise<Browser>
import Browser
import { Browser } from "https://dotland.deno.dev/x/puppeteer@16.2.0/mod.ts";

Copyright 2017 Google Inc. All rights reserved.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.