Interface: Browser

Defined in: packages/sdk/src/context/index.ts:40

Puppeteer browser connected to the user's browser via the Assistant.

Extends

Browser

Properties

Property	Type	Description	Defined in
`createMinimizedWindow?`	(`url?`: `string`) => `Promise`<`any`>	Open a minimized browser window (Assistant extension only).	packages/sdk/src/context/index.ts:42

Accessors

connected

Get Signature

get abstract connected(): boolean;

Defined in: node_modules/.pnpm/puppeteer-core@24.38.0/node_modules/puppeteer-core/lib/types.d.ts:541

Whether Puppeteer is connected to this browser.

Returns

boolean

Inherited from

PuppeteerBrowser.connected

debugInfo

Get Signature

get abstract debugInfo(): DebugInfo;

Defined in: node_modules/.pnpm/puppeteer-core@24.38.0/node_modules/puppeteer-core/lib/types.d.ts:555

Experimental

Get debug information from Puppeteer.

Remarks

Currently, includes pending protocol calls. In the future, we might add more info.

Returns

DebugInfo

Inherited from

PuppeteerBrowser.debugInfo

Methods

process()

abstract process(): ChildProcess | null;

Defined in: node_modules/.pnpm/puppeteer-core@24.38.0/node_modules/puppeteer-core/lib/types.d.ts:308

Gets the associated ChildProcess.

Returns

ChildProcess | null

null if this instance was connected to via Puppeteer.connect.

Inherited from

PuppeteerBrowser.process

createBrowserContext()

abstract createBrowserContext(options?: BrowserContextOptions): Promise<BrowserContext>;

Defined in: node_modules/.pnpm/puppeteer-core@24.38.0/node_modules/puppeteer-core/lib/types.d.ts:328

Creates a new BrowserContext | browser context.

This won't share cookies/cache with other BrowserContext | browser contexts.

Parameters

Parameter	Type
`options?`	`BrowserContextOptions`

Returns

Promise<BrowserContext>

Example

import puppeteer from 'puppeteer';

const browser = await puppeteer.launch();
// Create a new browser context.
const context = await browser.createBrowserContext();
// Create a new page in a pristine context.
const page = await context.newPage();
// Do stuff
await page.goto('https://example.com');

Inherited from

PuppeteerBrowser.createBrowserContext

browserContexts()

abstract browserContexts(): BrowserContext[];

Defined in: node_modules/.pnpm/puppeteer-core@24.38.0/node_modules/puppeteer-core/lib/types.d.ts:335

Gets a list of open BrowserContext | browser contexts.

In a newly-created browser, this will return a single instance of BrowserContext.

Returns

BrowserContext[]

Inherited from

PuppeteerBrowser.browserContexts

defaultBrowserContext()

abstract defaultBrowserContext(): BrowserContext;

Defined in: node_modules/.pnpm/puppeteer-core@24.38.0/node_modules/puppeteer-core/lib/types.d.ts:342

Gets the default BrowserContext | browser context.

Returns

BrowserContext

Remarks

The default BrowserContext | browser context cannot be closed.

Inherited from

PuppeteerBrowser.defaultBrowserContext

wsEndpoint()

abstract wsEndpoint(): string;

Defined in: node_modules/.pnpm/puppeteer-core@24.38.0/node_modules/puppeteer-core/lib/types.d.ts:356

Gets the WebSocket URL to connect to this browser.

This is usually used with Puppeteer.connect.

You can find the debugger URL (webSocketDebuggerUrl) from http://HOST:PORT/json/version.

See browser endpoint for more information.

Returns

string

Remarks

The format is always ws://HOST:PORT/devtools/browser/<id>.

Inherited from

PuppeteerBrowser.wsEndpoint

newPage()

abstract newPage(options?: CreatePageOptions): Promise<Page>;

Defined in: node_modules/.pnpm/puppeteer-core@24.38.0/node_modules/puppeteer-core/lib/types.d.ts:361

Creates a new page in the default browser context.

Parameters

Parameter	Type
`options?`	`CreatePageOptions`

Returns

Promise<Page>

Inherited from

PuppeteerBrowser.newPage

getWindowBounds()

abstract getWindowBounds(windowId: string): Promise<WindowBounds>;

Defined in: node_modules/.pnpm/puppeteer-core@24.38.0/node_modules/puppeteer-core/lib/types.d.ts:365

Gets the specified window WindowBounds | bounds.

Parameters

Parameter	Type
`windowId`	`string`

Returns

Promise<WindowBounds>

Inherited from

PuppeteerBrowser.getWindowBounds

setWindowBounds()

abstract setWindowBounds(windowId: string, windowBounds: WindowBounds): Promise<void>;

Defined in: node_modules/.pnpm/puppeteer-core@24.38.0/node_modules/puppeteer-core/lib/types.d.ts:369

Sets the specified window WindowBounds | bounds.

Parameters

Parameter	Type
`windowId`	`string`
`windowBounds`	`WindowBounds`

Returns

Promise<void>

Inherited from

PuppeteerBrowser.setWindowBounds

targets()

abstract targets(): Target[];

Defined in: node_modules/.pnpm/puppeteer-core@24.38.0/node_modules/puppeteer-core/lib/types.d.ts:377

Gets all active Target | targets.

In case of multiple BrowserContext | browser contexts, this returns all Target | targets in all BrowserContext | browser contexts.

Returns

Target[]

Inherited from

PuppeteerBrowser.targets

target()

abstract target(): Target;

Defined in: node_modules/.pnpm/puppeteer-core@24.38.0/node_modules/puppeteer-core/lib/types.d.ts:382

Gets the Target | target associated with the default browser context).

Returns

Target

Inherited from

PuppeteerBrowser.target

waitForTarget()

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

Defined in: node_modules/.pnpm/puppeteer-core@24.38.0/node_modules/puppeteer-core/lib/types.d.ts:398

Waits until a Target | target matching the given predicate appears and returns it.

This will look all open BrowserContext | browser contexts.

Parameters

Parameter	Type
`predicate`	(`x`: `Target`) => `boolean` \| `Promise`<`boolean`>
`options?`	`WaitForTargetOptions`

Returns

Promise<Target>

Example

await page.evaluate(() => window.open('https://www.example.com/'));
const newWindowTarget = await browser.waitForTarget(
  target => target.url() === 'https://www.example.com/',
);

Inherited from

PuppeteerBrowser.waitForTarget

pages()

pages(includeAll?: boolean): Promise<Page[]>;

Defined in: node_modules/.pnpm/puppeteer-core@24.38.0/node_modules/puppeteer-core/lib/types.d.ts:411

Gets a list of all open pages inside this Browser.

If there are multiple BrowserContext | browser contexts, this returns all pages in all BrowserContext | browser contexts.

Parameters

Parameter	Type	Description
`includeAll?`	`boolean`	experimental, setting to true includes all kinds of pages.

Returns

Promise<Page[]>

Remarks

Non-visible pages, such as "background_page", will not be listed here. You can find them using Target.page.

Inherited from

PuppeteerBrowser.pages

version()

abstract version(): Promise<string>;

Defined in: node_modules/.pnpm/puppeteer-core@24.38.0/node_modules/puppeteer-core/lib/types.d.ts:423

Gets a string representing this browser's name and version.

For headless browser, this is similar to "HeadlessChrome/61.0.3153.0". For non-headless or new-headless, this is similar to "Chrome/61.0.3153.0". For Firefox, it is similar to "Firefox/116.0a1".

The format of Browser.version might change with future releases of browsers.

Returns

Promise<string>

Inherited from

PuppeteerBrowser.version

userAgent()

abstract userAgent(): Promise<string>;

Defined in: node_modules/.pnpm/puppeteer-core@24.38.0/node_modules/puppeteer-core/lib/types.d.ts:431

Gets this browser's original user agent.

Pages can override the user agent with Page.(setUserAgent:2).

Returns

Promise<string>

Inherited from

PuppeteerBrowser.userAgent

close()

abstract close(): Promise<void>;

Defined in: node_modules/.pnpm/puppeteer-core@24.38.0/node_modules/puppeteer-core/lib/types.d.ts:436

Closes this browser and all associated pages.

Returns

Promise<void>

Inherited from

PuppeteerBrowser.close

disconnect()

abstract disconnect(): Promise<void>;

Defined in: node_modules/.pnpm/puppeteer-core@24.38.0/node_modules/puppeteer-core/lib/types.d.ts:441

Disconnects Puppeteer from this browser, but leaves the process running.

Returns

Promise<void>

Inherited from

PuppeteerBrowser.disconnect

cookies()

cookies(): Promise<Cookie[]>;

Defined in: node_modules/.pnpm/puppeteer-core@24.38.0/node_modules/puppeteer-core/lib/types.d.ts:450

Returns all cookies in the default BrowserContext.

Returns

Promise<Cookie[]>

Remarks

Shortcut for BrowserContext.cookies | browser.defaultBrowserContext().cookies().

Inherited from

PuppeteerBrowser.cookies

setCookie()

setCookie(...cookies: CookieData[]): Promise<void>;

Defined in: node_modules/.pnpm/puppeteer-core@24.38.0/node_modules/puppeteer-core/lib/types.d.ts:459

Sets cookies in the default BrowserContext.

Parameters

Parameter	Type
...`cookies`	`CookieData`[]

Returns

Promise<void>

Remarks

Shortcut for BrowserContext.setCookie | browser.defaultBrowserContext().setCookie().

Inherited from

PuppeteerBrowser.setCookie

deleteCookie()

deleteCookie(...cookies: Cookie[]): Promise<void>;

Defined in: node_modules/.pnpm/puppeteer-core@24.38.0/node_modules/puppeteer-core/lib/types.d.ts:468

Removes cookies from the default BrowserContext.

Parameters

Parameter	Type
...`cookies`	`Cookie`[]

Returns

Promise<void>

Remarks

Shortcut for BrowserContext.deleteCookie | browser.defaultBrowserContext().deleteCookie().

Inherited from

PuppeteerBrowser.deleteCookie

deleteMatchingCookies()

deleteMatchingCookies(...filters: DeleteCookiesRequest[]): Promise<void>;

Defined in: node_modules/.pnpm/puppeteer-core@24.38.0/node_modules/puppeteer-core/lib/types.d.ts:479

Deletes cookies matching the provided filters from the default BrowserContext.

Parameters

Parameter	Type
...`filters`	`DeleteCookiesRequest`[]

Returns

Promise<void>

Remarks

Shortcut for BrowserContext.deleteMatchingCookies | browser.defaultBrowserContext().deleteMatchingCookies().

Inherited from

PuppeteerBrowser.deleteMatchingCookies

setPermission()

setPermission(origin: string, ...permissions: {
  permission: PermissionDescriptor_2;
  state: PermissionState_2;
}[]): Promise<void>;

Defined in: node_modules/.pnpm/puppeteer-core@24.38.0/node_modules/puppeteer-core/lib/types.d.ts:496

Sets the permission for a specific origin in the default BrowserContext.

Parameters

Parameter	Type	Description
`origin`	`string`	The origin to set the permission for.
...`permissions`	{ `permission`: `PermissionDescriptor_2`; `state`: `PermissionState_2`; }[]	-

Returns

Promise<void>

Remarks

Shortcut for BrowserContext.setPermission | browser.defaultBrowserContext().setPermission().

Inherited from

PuppeteerBrowser.setPermission

installExtension()

abstract installExtension(path: string): Promise<string>;

Defined in: node_modules/.pnpm/puppeteer-core@24.38.0/node_modules/puppeteer-core/lib/types.d.ts:505

Installs an extension and returns the ID. In Chrome, this is only available if the browser was created using pipe: true and the --enable-unsafe-extension-debugging flag is set.

Parameters

Parameter	Type
`path`	`string`

Returns

Promise<string>

Inherited from

PuppeteerBrowser.installExtension

uninstallExtension()

abstract uninstallExtension(id: string): Promise<void>;

Defined in: node_modules/.pnpm/puppeteer-core@24.38.0/node_modules/puppeteer-core/lib/types.d.ts:511

Uninstalls an extension. In Chrome, this is only available if the browser was created using pipe: true and the --enable-unsafe-extension-debugging flag is set.

Parameters

Parameter	Type
`id`	`string`

Returns

Promise<void>

Inherited from

PuppeteerBrowser.uninstallExtension

screens()

abstract screens(): Promise<ScreenInfo[]>;

Defined in: node_modules/.pnpm/puppeteer-core@24.38.0/node_modules/puppeteer-core/lib/types.d.ts:515

Gets a list of ScreenInfo | screen information objects.

Returns

Promise<ScreenInfo[]>

Inherited from

PuppeteerBrowser.screens

addScreen()

abstract addScreen(params: AddScreenParams): Promise<ScreenInfo>;

Defined in: node_modules/.pnpm/puppeteer-core@24.38.0/node_modules/puppeteer-core/lib/types.d.ts:523

Adds a new screen, returns the added ScreenInfo | screen information object.

Parameters

Parameter	Type
`params`	`AddScreenParams`

Returns

Promise<ScreenInfo>

Remarks

Only supported in headless mode.

Inherited from

PuppeteerBrowser.addScreen

removeScreen()

abstract removeScreen(screenId: string): Promise<void>;

Defined in: node_modules/.pnpm/puppeteer-core@24.38.0/node_modules/puppeteer-core/lib/types.d.ts:531

Removes a screen.

Parameters

Parameter	Type
`screenId`	`string`

Returns

Promise<void>

Remarks

Only supported in headless mode. Fails if the primary screen id is specified.

Inherited from

PuppeteerBrowser.removeScreen

isConnected()

isConnected(): boolean;

Defined in: node_modules/.pnpm/puppeteer-core@24.38.0/node_modules/puppeteer-core/lib/types.d.ts:537

Whether Puppeteer is connected to this browser.

Returns

boolean

Deprecated

Use Browser.connected.

Inherited from

PuppeteerBrowser.isConnected

on()

on<Key>(type: Key, handler: Handler<EventsWithWildcard<BrowserEvents>[Key]>): this;

Defined in: node_modules/.pnpm/puppeteer-core@24.38.0/node_modules/puppeteer-core/lib/types.d.ts:2531

Bind an event listener to fire when an event occurs.

Type Parameters

Type Parameter
`Key` extends keyof `BrowserEvents`

Parameters

Parameter	Type	Description
`type`	`Key`	the event type you'd like to listen to. Can be a string or symbol.
`handler`	`Handler`<`EventsWithWildcard`<`BrowserEvents`>[`Key`]>	the function to be called when the event occurs.

Returns

this

this to enable you to chain method calls.

Inherited from

PuppeteerBrowser.on

off()

off<Key>(type: Key, handler?: Handler<EventsWithWildcard<BrowserEvents>[Key]>): this;

Defined in: node_modules/.pnpm/puppeteer-core@24.38.0/node_modules/puppeteer-core/lib/types.d.ts:2538

Remove an event listener from firing.

Type Parameters

Type Parameter
`Key` extends keyof `BrowserEvents`

Parameters

Parameter	Type	Description
`type`	`Key`	the event type you'd like to stop listening to.
`handler?`	`Handler`<`EventsWithWildcard`<`BrowserEvents`>[`Key`]>	the function that should be removed.

Returns

this

this to enable you to chain method calls.

Inherited from

PuppeteerBrowser.off

emit()

emit<Key>(type: Key, event: EventsWithWildcard<BrowserEvents>[Key]): boolean;

Defined in: node_modules/.pnpm/puppeteer-core@24.38.0/node_modules/puppeteer-core/lib/types.d.ts:2546

Emit an event and call any associated listeners.

Type Parameters

Type Parameter
`Key` extends keyof `BrowserEvents`

Parameters

Parameter	Type	Description
`type`	`Key`	the event you'd like to emit
`event`	`EventsWithWildcard`<`BrowserEvents`>[`Key`]	-

Returns

boolean

true if there are any listeners, false if there are not.

Inherited from

PuppeteerBrowser.emit

once()

once<Key>(type: Key, handler: Handler<EventsWithWildcard<BrowserEvents>[Key]>): this;

Defined in: node_modules/.pnpm/puppeteer-core@24.38.0/node_modules/puppeteer-core/lib/types.d.ts:2553

Like on but the listener will only be fired once and then it will be removed.

Type Parameters

Type Parameter
`Key` extends keyof `BrowserEvents`

Parameters

Parameter	Type	Description
`type`	`Key`	the event you'd like to listen to
`handler`	`Handler`<`EventsWithWildcard`<`BrowserEvents`>[`Key`]>	the handler function to run when the event occurs

Returns

this

this to enable you to chain method calls.

Inherited from

PuppeteerBrowser.once

listenerCount()

listenerCount(type: keyof BrowserEvents): number;

Defined in: node_modules/.pnpm/puppeteer-core@24.38.0/node_modules/puppeteer-core/lib/types.d.ts:2560

Gets the number of listeners for a given event.

Parameters

Parameter	Type	Description
`type`	keyof `BrowserEvents`	the event to get the listener count for

Returns

number

the number of listeners bound to the given event

Inherited from

PuppeteerBrowser.listenerCount

removeAllListeners()

removeAllListeners(type?: keyof BrowserEvents): this;

Defined in: node_modules/.pnpm/puppeteer-core@24.38.0/node_modules/puppeteer-core/lib/types.d.ts:2568

Removes all listeners. If given an event argument, it will remove only listeners for that event.

Parameters

Parameter	Type	Description
`type?`	keyof BrowserEvents	the event to remove listeners for.

Returns

this

this to enable you to chain method calls.

Inherited from

PuppeteerBrowser.removeAllListeners

Interface: Browser ​

Extends ​

Properties ​

Accessors ​

connected ​

Get Signature ​

Returns ​

Inherited from ​

debugInfo ​

Get Signature ​

Remarks ​

Returns ​

Inherited from ​

Methods ​

process() ​

Returns ​

Inherited from ​

createBrowserContext() ​

Parameters ​

Returns ​

Example ​

Inherited from ​

browserContexts() ​

Returns ​

Inherited from ​

defaultBrowserContext() ​

Returns ​

Remarks ​

Inherited from ​

wsEndpoint() ​

Returns ​

Remarks ​

Inherited from ​

newPage() ​

Parameters ​

Returns ​

Inherited from ​

getWindowBounds() ​

Parameters ​

Returns ​

Inherited from ​

setWindowBounds() ​

Parameters ​

Returns ​

Inherited from ​

targets() ​

Returns ​

Inherited from ​

target() ​

Returns ​

Inherited from ​

waitForTarget() ​

Parameters ​

Returns ​

Example ​

Inherited from ​

pages() ​

Parameters ​

Returns ​

Remarks ​

Inherited from ​

version() ​

Returns ​

Inherited from ​

userAgent() ​

Returns ​

Inherited from ​

close() ​

Returns ​

Inherited from ​

disconnect() ​

Interface: Browser

Extends

Properties

Accessors

connected

Get Signature

Returns

Inherited from

debugInfo

Get Signature

Remarks

Returns

Inherited from

Methods

process()

Returns

Inherited from

createBrowserContext()

Parameters

Returns

Example

Inherited from

browserContexts()

Returns

Inherited from

defaultBrowserContext()

Returns

Remarks

Inherited from

wsEndpoint()

Returns

Remarks

Inherited from

newPage()

Parameters

Returns

Inherited from

getWindowBounds()

Parameters

Returns

Inherited from

setWindowBounds()

Parameters

Returns

Inherited from

targets()

Returns

Inherited from

target()

Returns

Inherited from

waitForTarget()

Parameters

Returns

Example

Inherited from

pages()

Parameters

Returns

Remarks

Inherited from

version()

Returns

Inherited from

userAgent()

Returns

Inherited from

close()

Returns

Inherited from

disconnect()