Interface Browser

A Browser is created via browserType.launch([options]). An example of using a Browser to create a Page:

const { firefox } = require('playwright');  // Or 'chromium' or 'webkit'.

(async () => {
  const browser = await firefox.launch();
  const page = await browser.newPage();
  await page.goto('https://example.com');
  await browser.close();
})();
interface Browser {
    [asyncDispose](): Promise<void>;
    addListener(event: "disconnected", listener: ((browser: Browser) => any)): this;
    browserType(): BrowserType<{}>;
    close(options?: {
        reason?: string;
    }): Promise<void>;
    contexts(): BrowserContext[];
    isConnected(): boolean;
    newBrowserCDPSession(): Promise<CDPSession>;
    newContext(options?: BrowserContextOptions): Promise<BrowserContext>;
    newPage(options?: {
        acceptDownloads?: boolean;
        baseURL?: string;
        bypassCSP?: boolean;
        clientCertificates?: {
            cert?: Buffer<ArrayBufferLike>;
            certPath?: string;
            key?: Buffer<ArrayBufferLike>;
            keyPath?: string;
            origin: string;
            passphrase?: string;
            pfx?: Buffer<ArrayBufferLike>;
            pfxPath?: string;
        }[];
        colorScheme?:
            | null
            | "light"
            | "dark"
            | "no-preference";
        deviceScaleFactor?: number;
        extraHTTPHeaders?: {
            [key: string]: string;
        };
        forcedColors?: null | "none" | "active";
        geolocation?: {
            accuracy?: number;
            latitude: number;
            longitude: number;
        };
        hasTouch?: boolean;
        httpCredentials?: {
            origin?: string;
            password: string;
            send?: "always" | "unauthorized";
            username: string;
        };
        ignoreHTTPSErrors?: boolean;
        isMobile?: boolean;
        javaScriptEnabled?: boolean;
        locale?: string;
        logger?: Logger;
        offline?: boolean;
        permissions?: string[];
        proxy?: {
            bypass?: string;
            password?: string;
            server: string;
            username?: string;
        };
        recordHar?: {
            content?: "embed" | "attach" | "omit";
            mode?: "minimal" | "full";
            omitContent?: boolean;
            path: string;
            urlFilter?: string | RegExp;
        };
        recordVideo?: {
            dir: string;
            size?: {
                height: number;
                width: number;
            };
        };
        reducedMotion?: null | "reduce" | "no-preference";
        screen?: {
            height: number;
            width: number;
        };
        serviceWorkers?: "block" | "allow";
        storageState?: string | {
            cookies: {
                domain: string;
                expires: number;
                httpOnly: boolean;
                name: string;
                path: string;
                sameSite: "None" | "Strict" | "Lax";
                secure: boolean;
                value: string;
            }[];
            origins: {
                localStorage: {
                    name: string;
                    value: string;
                }[];
                origin: string;
            }[];
        };
        strictSelectors?: boolean;
        timezoneId?: string;
        userAgent?: string;
        videoSize?: {
            height: number;
            width: number;
        };
        videosPath?: string;
        viewport?: null | {
            height: number;
            width: number;
        };
    }): Promise<Page>;
    off(event: "disconnected", listener: ((browser: Browser) => any)): this;
    on(event: "disconnected", listener: ((browser: Browser) => any)): this;
    once(event: "disconnected", listener: ((browser: Browser) => any)): this;
    prependListener(event: "disconnected", listener: ((browser: Browser) => any)): this;
    removeAllListeners(type?: string): this;
    removeAllListeners(type: undefined | string, options: {
        behavior?: "default" | "wait" | "ignoreErrors";
    }): Promise<void>;
    removeListener(event: "disconnected", listener: ((browser: Browser) => any)): this;
    startTracing(page?: Page, options?: {
        categories?: string[];
        path?: string;
        screenshots?: boolean;
    }): Promise<void>;
    stopTracing(): Promise<Buffer<ArrayBufferLike>>;
    version(): string;
}

Methods

[asyncDispose] addListener browserType close contexts isConnected newBrowserCDPSession newContext newPage off on once prependListener removeAllListeners removeListener startTracing stopTracing version

Methods

[asyncDispose]

  • [asyncDispose](): Promise<void>

  • Returns Promise<void>

addListener

  • addListener(event, listener): this

  • Emitted when Browser gets disconnected from the browser application. This might happen because of one of the following:

    Parameters

    • event: "disconnected"
    • listener: ((browser: Browser) => any)
        • (browser): any

        • Parameters

          Returns any

    Returns this

browserType

  • browserType(): BrowserType<{}>

  • Get the browser type (chromium, firefox or webkit) that the browser belongs to.

    Returns BrowserType<{}>

close

  • close(options?): Promise<void>

  • In case this browser is obtained using browserType.launch([options]), closes the browser and all of its pages (if any were opened).

    In case this browser is connected to, clears all created contexts belonging to this browser and disconnects from the browser server.

    NOTE This is similar to force quitting the browser. Therefore, you should call browserContext.close([options]) on any BrowserContext's you explicitly created earlier with browser.newContext([options]) before calling browser.close([options]).

    The Browser object itself is considered to be disposed and cannot be used anymore.

    Parameters

    • Optionaloptions: {
          reason?: string;
      }
      • Optionalreason?: string

        The reason to be reported to the operations interrupted by the browser closure.

    Returns Promise<void>

contexts

  • contexts(): BrowserContext[]

  • Returns an array of all open browser contexts. In a newly created browser, this will return zero browser contexts.

    Usage

    const browser = await pw.webkit.launch();
    console.log(browser.contexts().length); // prints `0`

    const context = await browser.newContext();
    console.log(browser.contexts().length); // prints `1`

    Returns BrowserContext[]

isConnected

  • isConnected(): boolean

  • Indicates that the browser is connected.

    Returns boolean

newBrowserCDPSession

  • newBrowserCDPSession(): Promise<CDPSession>

  • NOTE CDP Sessions are only supported on Chromium-based browsers.

    Returns the newly created browser session.

    Returns Promise<CDPSession>

newContext

  • newContext(options?): Promise<BrowserContext>

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

    NOTE If directly using this method to create BrowserContexts, it is best practice to explicitly close the returned context via browserContext.close([options]) when your code is done with the BrowserContext, and before calling browser.close([options]). This will ensure the context is closed gracefully and any artifacts—like HARs and videos—are fully flushed and saved.

    Usage

    (async () => {
      const browser = await playwright.firefox.launch();  // Or 'chromium' or 'webkit'.
      // Create a new incognito browser context.
      const context = await browser.newContext();
      // Create a new page in a pristine context.
      const page = await context.newPage();
      await page.goto('https://example.com');

      // Gracefully close up everything
      await context.close();
      await browser.close();
    })();

    Parameters

    • Optionaloptions: BrowserContextOptions

    Returns Promise<BrowserContext>

newPage

  • newPage(options?): Promise<Page>

  • Creates a new page in a new browser context. Closing this page will close the context as well.

    This is a convenience API that should only be used for the single-page scenarios and short snippets. Production code and testing frameworks should explicitly create browser.newContext([options]) followed by the browserContext.newPage() to control their exact life times.

    Parameters

    • Optionaloptions: {
          acceptDownloads?: boolean;
          baseURL?: string;
          bypassCSP?: boolean;
          clientCertificates?: {
              cert?: Buffer<ArrayBufferLike>;
              certPath?: string;
              key?: Buffer<ArrayBufferLike>;
              keyPath?: string;
              origin: string;
              passphrase?: string;
              pfx?: Buffer<ArrayBufferLike>;
              pfxPath?: string;
          }[];
          colorScheme?:
              | null
              | "light"
              | "dark"
              | "no-preference";
          deviceScaleFactor?: number;
          extraHTTPHeaders?: {
              [key: string]: string;
          };
          forcedColors?: null | "none" | "active";
          geolocation?: {
              accuracy?: number;
              latitude: number;
              longitude: number;
          };
          hasTouch?: boolean;
          httpCredentials?: {
              origin?: string;
              password: string;
              send?: "always" | "unauthorized";
              username: string;
          };
          ignoreHTTPSErrors?: boolean;
          isMobile?: boolean;
          javaScriptEnabled?: boolean;
          locale?: string;
          logger?: Logger;
          offline?: boolean;
          permissions?: string[];
          proxy?: {
              bypass?: string;
              password?: string;
              server: string;
              username?: string;
          };
          recordHar?: {
              content?: "embed" | "attach" | "omit";
              mode?: "minimal" | "full";
              omitContent?: boolean;
              path: string;
              urlFilter?: string | RegExp;
          };
          recordVideo?: {
              dir: string;
              size?: {
                  height: number;
                  width: number;
              };
          };
          reducedMotion?: null | "reduce" | "no-preference";
          screen?: {
              height: number;
              width: number;
          };
          serviceWorkers?: "block" | "allow";
          storageState?: string | {
              cookies: {
                  domain: string;
                  expires: number;
                  httpOnly: boolean;
                  name: string;
                  path: string;
                  sameSite: "None" | "Strict" | "Lax";
                  secure: boolean;
                  value: string;
              }[];
              origins: {
                  localStorage: {
                      name: string;
                      value: string;
                  }[];
                  origin: string;
              }[];
          };
          strictSelectors?: boolean;
          timezoneId?: string;
          userAgent?: string;
          videoSize?: {
              height: number;
              width: number;
          };
          videosPath?: string;
          viewport?: null | {
              height: number;
              width: number;
          };
      }
      • OptionalacceptDownloads?: boolean

        Whether to automatically download all the attachments. Defaults to true where all the downloads are accepted.

      • OptionalbaseURL?: string

        When using page.goto(url[, options]), page.route(url, handler[, options]), page.waitForURL(url[, options]), page.waitForRequest(urlOrPredicate[, options]), or page.waitForResponse(urlOrPredicate[, options]) it takes the base URL in consideration by using the URL() constructor for building the corresponding URL. Unset by default. Examples:

        • baseURL: http://localhost:3000 and navigating to /bar.html results in http://localhost:3000/bar.html
        • baseURL: http://localhost:3000/foo/ and navigating to ./bar.html results in http://localhost:3000/foo/bar.html
        • baseURL: http://localhost:3000/foo (without trailing slash) and navigating to ./bar.html results in http://localhost:3000/bar.html
      • OptionalbypassCSP?: boolean

        Toggles bypassing page's Content-Security-Policy. Defaults to false.

      • OptionalclientCertificates?: {
            cert?: Buffer<ArrayBufferLike>;
            certPath?: string;
            key?: Buffer<ArrayBufferLike>;
            keyPath?: string;
            origin: string;
            passphrase?: string;
            pfx?: Buffer<ArrayBufferLike>;
            pfxPath?: string;
        }[]

        TLS Client Authentication allows the server to request a client certificate and verify it.

        Details

        An array of client certificates to be used. Each certificate object must have either both certPath and keyPath, a single pfxPath, or their corresponding direct value equivalents (cert and key, or pfx). Optionally, passphrase property should be provided if the certificate is encrypted. The origin property should be provided with an exact match to the request origin that the certificate is valid for.

        NOTE When using WebKit on macOS, accessing localhost will not pick up client certificates. You can make it work by replacing localhost with local.playwright.

      • OptionalcolorScheme?:
            | null
            | "light"
            | "dark"
            | "no-preference"

        Emulates prefers-colors-scheme media feature, supported values are 'light' and 'dark'. See page.emulateMedia([options]) for more details. Passing null resets emulation to system defaults. Defaults to 'light'.

      • OptionaldeviceScaleFactor?: number

        Specify device scale factor (can be thought of as dpr). Defaults to 1. Learn more about emulating devices with device scale factor.

      • OptionalextraHTTPHeaders?: {
            [key: string]: string;
        }

        An object containing additional HTTP headers to be sent with every request. Defaults to none.

        • [key: string]: string
      • OptionalforcedColors?: null | "none" | "active"

        Emulates 'forced-colors' media feature, supported values are 'active', 'none'. See page.emulateMedia([options]) for more details. Passing null resets emulation to system defaults. Defaults to 'none'.

      • Optionalgeolocation?: {
            accuracy?: number;
            latitude: number;
            longitude: number;
        }
        • Optionalaccuracy?: number

          Non-negative accuracy value. Defaults to 0.

        • latitude: number

          Latitude between -90 and 90.

        • longitude: number

          Longitude between -180 and 180.

      • OptionalhasTouch?: boolean

        Specifies if viewport supports touch events. Defaults to false. Learn more about mobile emulation.

      • OptionalhttpCredentials?: {
            origin?: string;
            password: string;
            send?: "always" | "unauthorized";
            username: string;
        }

        Credentials for HTTP authentication. If no origin is specified, the username and password are sent to any servers upon unauthorized responses.

        • Optionalorigin?: string

          Restrain sending http credentials on specific origin (scheme://host:port).

        • password: string
        • Optionalsend?: "always" | "unauthorized"

          This option only applies to the requests sent from corresponding APIRequestContext and does not affect requests sent from the browser. 'always' - Authorization header with basic authentication credentials will be sent with the each API request. 'unauthorized - the credentials are only sent when 401 (Unauthorized) response with WWW-Authenticate header is received. Defaults to 'unauthorized'.

        • username: string
      • OptionalignoreHTTPSErrors?: boolean

        Whether to ignore HTTPS errors when sending network requests. Defaults to false.

      • OptionalisMobile?: boolean

        Whether the meta viewport tag is taken into account and touch events are enabled. isMobile is a part of device, so you don't actually need to set it manually. Defaults to false and is not supported in Firefox. Learn more about mobile emulation.

      • OptionaljavaScriptEnabled?: boolean

        Whether or not to enable JavaScript in the context. Defaults to true. Learn more about disabling JavaScript.

      • Optionallocale?: string

        Specify user locale, for example en-GB, de-DE, etc. Locale will affect navigator.language value, Accept-Language request header value as well as number and date formatting rules. Defaults to the system default locale. Learn more about emulation in our emulation guide.

      • Optionallogger?: Logger

        Logger sink for Playwright logging.

      • Optionaloffline?: boolean

        Whether to emulate network being offline. Defaults to false. Learn more about network emulation.

      • Optionalpermissions?: string[]

        A list of permissions to grant to all pages in this context. See browserContext.grantPermissions(permissions[, options]) for more details. Defaults to none.

      • Optionalproxy?: {
            bypass?: string;
            password?: string;
            server: string;
            username?: string;
        }

        Network proxy settings to use with this context. Defaults to none.

        • Optionalbypass?: string

          Optional comma-separated domains to bypass proxy, for example ".com, chromium.org, .domain.com".

        • Optionalpassword?: string

          Optional password to use if HTTP proxy requires authentication.

        • server: string

          Proxy to be used for all requests. HTTP and SOCKS proxies are supported, for example http://myproxy.com:3128 or socks5://myproxy.com:3128. Short form myproxy.com:3128 is considered an HTTP proxy.

        • Optionalusername?: string

          Optional username to use if HTTP proxy requires authentication.

      • OptionalrecordHar?: {
            content?: "embed" | "attach" | "omit";
            mode?: "minimal" | "full";
            omitContent?: boolean;
            path: string;
            urlFilter?: string | RegExp;
        }

        Enables HAR recording for all pages into recordHar.path file. If not specified, the HAR is not recorded. Make sure to await browserContext.close([options]) for the HAR to be saved.

        • Optionalcontent?: "embed" | "attach" | "omit"

          Optional setting to control resource content management. If omit is specified, content is not persisted. If attach is specified, resources are persisted as separate files or entries in the ZIP archive. If embed is specified, content is stored inline the HAR file as per HAR specification. Defaults to attach for .zip output files and to embed for all other file extensions.

        • Optionalmode?: "minimal" | "full"

          When set to minimal, only record information necessary for routing from HAR. This omits sizes, timing, page, cookies, security and other types of HAR information that are not used when replaying from HAR. Defaults to full.

        • OptionalomitContent?: boolean

          Optional setting to control whether to omit request content from the HAR. Defaults to false. Deprecated, use content policy instead.

        • path: string

          Path on the filesystem to write the HAR file to. If the file name ends with .zip, content: 'attach' is used by default.

        • OptionalurlFilter?: string | RegExp

          A glob or regex pattern to filter requests that are stored in the HAR. When a baseURL via the context options was provided and the passed URL is a path, it gets merged via the new URL() constructor. Defaults to none.

      • OptionalrecordVideo?: {
            dir: string;
            size?: {
                height: number;
                width: number;
            };
        }

        Enables video recording for all pages into recordVideo.dir directory. If not specified videos are not recorded. Make sure to await browserContext.close([options]) for videos to be saved.

        • dir: string

          Path to the directory to put videos into.

        • Optionalsize?: {
              height: number;
              width: number;
          }

          Optional dimensions of the recorded videos. If not specified the size will be equal to viewport scaled down to fit into 800x800. If viewport is not configured explicitly the video size defaults to 800x450. Actual picture of each page will be scaled down if necessary to fit the specified size.

          • height: number

            Video frame height.

          • width: number

            Video frame width.

      • OptionalreducedMotion?: null | "reduce" | "no-preference"

        Emulates 'prefers-reduced-motion' media feature, supported values are 'reduce', 'no-preference'. See page.emulateMedia([options]) for more details. Passing null resets emulation to system defaults. Defaults to 'no-preference'.

      • Optionalscreen?: {
            height: number;
            width: number;
        }

        Emulates consistent window screen size available inside web page via window.screen. Is only used when the viewport is set.

        • height: number

          page height in pixels.

        • width: number

          page width in pixels.

      • OptionalserviceWorkers?: "block" | "allow"

        Whether to allow sites to register Service workers. Defaults to 'allow'.

        • 'allow': Service Workers can be registered.
        • 'block': Playwright will block all registration of Service Workers.
      • OptionalstorageState?: string | {
            cookies: {
                domain: string;
                expires: number;
                httpOnly: boolean;
                name: string;
                path: string;
                sameSite: "None" | "Strict" | "Lax";
                secure: boolean;
                value: string;
            }[];
            origins: {
                localStorage: {
                    name: string;
                    value: string;
                }[];
                origin: string;
            }[];
        }

        Learn more about storage state and auth.

        Populates context with given storage state. This option can be used to initialize context with logged-in information obtained via browserContext.storageState([options]).

      • OptionalstrictSelectors?: boolean

        If set to true, enables strict selectors mode for this context. In the strict selectors mode all operations on selectors that imply single target DOM element will throw when more than one element matches the selector. This option does not affect any Locator APIs (Locators are always strict). Defaults to false. See Locator to learn more about the strict mode.

      • OptionaltimezoneId?: string

        Changes the timezone of the context. See ICU's metaZones.txt for a list of supported timezone IDs. Defaults to the system timezone.

      • OptionaluserAgent?: string

        Specific user agent to use in this context.

      • OptionalvideoSize?: {
            height: number;
            width: number;
        }

        Deprecated

        Use recordVideo instead.

        • height: number

          Video frame height.

        • width: number

          Video frame width.

      • OptionalvideosPath?: string

        Deprecated

        Use recordVideo instead.

      • Optionalviewport?: null | {
            height: number;
            width: number;
        }

        Emulates consistent viewport for each page. Defaults to an 1280x720 viewport. Use null to disable the consistent viewport emulation. Learn more about viewport emulation.

        NOTE The null value opts out from the default presets, makes viewport depend on the host window size defined by the operating system. It makes the execution of the tests non-deterministic.

    Returns Promise<Page>

off

  • off(event, listener): this

  • Removes an event listener added by on or addListener.

    Parameters

    • event: "disconnected"
    • listener: ((browser: Browser) => any)
        • (browser): any

        • Parameters

          Returns any

    Returns this

on

  • on(event, listener): this

  • Emitted when Browser gets disconnected from the browser application. This might happen because of one of the following:

    Parameters

    • event: "disconnected"
    • listener: ((browser: Browser) => any)
        • (browser): any

        • Parameters

          Returns any

    Returns this

once

  • once(event, listener): this

  • Adds an event listener that will be automatically removed after it is triggered once. See addListener for more information about this event.

    Parameters

    • event: "disconnected"
    • listener: ((browser: Browser) => any)
        • (browser): any

        • Parameters

          Returns any

    Returns this

prependListener

  • prependListener(event, listener): this

  • Emitted when Browser gets disconnected from the browser application. This might happen because of one of the following:

    Parameters

    • event: "disconnected"
    • listener: ((browser: Browser) => any)
        • (browser): any

        • Parameters

          Returns any

    Returns this

removeAllListeners

  • removeAllListeners(type?): this

  • Removes all the listeners of the given type (or all registered listeners if no type given). Allows to wait for async listeners to complete or to ignore subsequent errors from these listeners.

    Parameters

    • Optionaltype: string

    Returns this

  • removeAllListeners(type, options): Promise<void>

  • Removes all the listeners of the given type (or all registered listeners if no type given). Allows to wait for async listeners to complete or to ignore subsequent errors from these listeners.

    Parameters

    • type: undefined | string
    • options: {
          behavior?: "default" | "wait" | "ignoreErrors";
      }
      • Optionalbehavior?: "default" | "wait" | "ignoreErrors"

        Specifies whether to wait for already running listeners and what to do if they throw errors:

        • 'default' - do not wait for current listener calls (if any) to finish, if the listener throws, it may result in unhandled error
        • 'wait' - wait for current listener calls (if any) to finish
        • 'ignoreErrors' - do not wait for current listener calls (if any) to finish, all errors thrown by the listeners after removal are silently caught

    Returns Promise<void>

removeListener

  • removeListener(event, listener): this

  • Removes an event listener added by on or addListener.

    Parameters

    • event: "disconnected"
    • listener: ((browser: Browser) => any)
        • (browser): any

        • Parameters

          Returns any

    Returns this

startTracing

  • startTracing(page?, options?): Promise<void>

  • NOTE This API controls Chromium Tracing which is a low-level chromium-specific debugging tool. API to control Playwright Tracing could be found here.

    You can use browser.startTracing([page, options]) and browser.stopTracing() to create a trace file that can be opened in Chrome DevTools performance panel.

    Usage

    await browser.startTracing(page, { path: 'trace.json' });
    await page.goto('https://www.google.com');
    await browser.stopTracing();

    Parameters

    • Optionalpage: Page

      Optional, if specified, tracing includes screenshots of the given page.

    • Optionaloptions: {
          categories?: string[];
          path?: string;
          screenshots?: boolean;
      }
      • Optionalcategories?: string[]

        specify custom categories to use instead of default.

      • Optionalpath?: string

        A path to write the trace file to.

      • Optionalscreenshots?: boolean

        captures screenshots in the trace.

    Returns Promise<void>

stopTracing

  • stopTracing(): Promise<Buffer<ArrayBufferLike>>

  • NOTE This API controls Chromium Tracing which is a low-level chromium-specific debugging tool. API to control Playwright Tracing could be found here.

    Returns the buffer with trace data.

    Returns Promise<Buffer<ArrayBufferLike>>

version

  • version(): string

  • Returns the browser version.

    Returns string

Settings

Member Visibility

On This Page

Methods