Emitted when Browser gets disconnected from the browser application. This might happen because of one of the following:
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() on any [BrowserContext]'s you explicitly created earlier with browser.newContext([options]) before calling browser.close().
The [Browser] object itself is considered to be disposed and cannot be used anymore.
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`
Synchronously calls each of the listeners registered for the event namedeventName, in the order they were registered, passing the supplied arguments
to each.
Returns true if the event had listeners, false otherwise.
import { EventEmitter } from 'node:events';
const myEmitter = new EventEmitter();
// First listener
myEmitter.on('event', function firstListener() {
console.log('Helloooo! first listener');
});
// Second listener
myEmitter.on('event', function secondListener(arg1, arg2) {
console.log(`event with parameters ${arg1}, ${arg2} in second listener`);
});
// Third listener
myEmitter.on('event', function thirdListener(...args) {
const parameters = args.join(', ');
console.log(`event with parameters ${parameters} in third listener`);
});
console.log(myEmitter.listeners('event'));
myEmitter.emit('event', 1, 2, 3, 4, 5);
// Prints:
// [
// [Function: firstListener],
// [Function: secondListener],
// [Function: thirdListener]
// ]
// Helloooo! first listener
// event with parameters 1, 2 in second listener
// event with parameters 1, 2, 3, 4, 5 in third listener
Rest...args: any[]Returns an array listing the events for which the emitter has registered
listeners. The values in the array are strings or Symbols.
import { EventEmitter } from 'node:events';
const myEE = new EventEmitter();
myEE.on('foo', () => {});
myEE.on('bar', () => {});
const sym = Symbol('symbol');
myEE.on(sym, () => {});
console.log(myEE.eventNames());
// Prints: [ 'foo', 'bar', Symbol(symbol) ]
Returns the number of listeners listening for the event named eventName.
If listener is provided, it will return how many times the listener is found
in the list of the listeners of the event.
The name of the event being listened for
Optionallistener: FunctionThe event handler function
Returns a copy of the array of listeners for the event named eventName.
server.on('connection', (stream) => {
console.log('someone connected!');
});
console.log(util.inspect(server.listeners('connection')));
// Prints: [ [Function] ]
Creates a new browser context. It won't share cookies/cache with other browser contexts.
NOTE If directly using this method to create [BrowserContext]s, it is best practice to explicitly close the
returned context via
browserContext.close() when your code
is done with the [BrowserContext], and before calling
browser.close(). 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();
})();
Optionaloptions: BrowserContextOptionsCreates 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.
Optionaloptions: { OptionalacceptWhether to automatically download all the attachments. Defaults to true where all the downloads are accepted.
OptionalbaseURL?: stringWhen 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.
Examples:
http://localhost:3000 and navigating to /bar.html results in http://localhost:3000/bar.htmlhttp://localhost:3000/foo/ and navigating to ./bar.html results in
http://localhost:3000/foo/bar.htmlhttp://localhost:3000/foo (without trailing slash) and navigating to ./bar.html results in
http://localhost:3000/bar.htmlOptionalbypassCSP?: booleanToggles bypassing page's Content-Security-Policy.
OptionalcolorEmulates 'prefers-colors-scheme' media feature, supported values are 'light', 'dark', 'no-preference'. See
page.emulateMedia([options]) for more details.
Passing null resets emulation to system defaults. Defaults to 'light'.
OptionaldeviceSpecify device scale factor (can be thought of as dpr). Defaults to 1.
OptionalextraHTTPHeaders?: { An object containing additional HTTP headers to be sent with every request.
OptionalforcedEmulates '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?: { Latitude between -90 and 90.
Longitude between -180 and 180.
Optionalaccuracy?: numberNon-negative accuracy value. Defaults to 0.
OptionalhasSpecifies if viewport supports touch events. Defaults to false.
OptionalhttpCredentials for HTTP authentication.
OptionalignoreHTTPSErrors?: booleanWhether to ignore HTTPS errors when sending network requests. Defaults to false.
OptionalisWhether the meta viewport tag is taken into account and touch events are enabled. Defaults to false. Not
supported in Firefox.
OptionaljavaWhether or not to enable JavaScript in the context. Defaults to true.
Optionallocale?: stringSpecify 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.
Optionallogger?: LoggerLogger sink for Playwright logging.
Optionaloffline?: booleanWhether to emulate network being offline. Defaults to false.
Optionalpermissions?: string[]A list of permissions to grant to all pages in this context. See browserContext.grantPermissions(permissions[, options]) for more details.
Optionalproxy?: { Network proxy settings to use with this context.
NOTE For Chromium on Windows the browser needs to be launched with the global proxy for this option to work. If
all contexts override the proxy, global proxy will be never used and can be any string, for example launch({ proxy: { server: 'http://per-context' } }).
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.
Optionalbypass?: stringOptional comma-separated domains to bypass proxy, for example ".com, chromium.org, .domain.com".
Optionalpassword?: stringOptional password to use if HTTP proxy requires authentication.
Optionalusername?: stringOptional username to use if HTTP proxy requires authentication.
OptionalrecordEnables HAR recording for all pages into recordHar.path file.
If not specified, the HAR is not recorded. Make sure to await
browserContext.close() for the HAR to
be saved.
Path on the filesystem to write the HAR file to. If the file name ends with .zip, content: 'attach' is used by
default.
Optionalcontent?: "embed" | "omit" | "attach"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?: "full" | "minimal"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.
OptionalomitOptional setting to control whether to omit request content from the HAR. Defaults to false. Deprecated, use
content policy instead.
OptionalurlA 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.
OptionalrecordEnables video recording for all pages into recordVideo.dir directory. If not specified videos are not recorded.
Make sure to await
browserContext.close() for videos to
be saved.
Path to the directory to put videos into.
Optionalsize?: { 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.
Video frame height.
Video frame width.
OptionalreducedEmulates '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?: { Emulates consistent window screen size available inside web page via window.screen. Is only used when the
viewport is set.
page height in pixels.
page width in pixels.
OptionalserviceWhether 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.OptionalstoragePopulates context with given storage state. This option can be used to initialize context with logged-in information obtained via browserContext.storageState([options]). Either a path to the file with saved storage, or an object with the following fields:
OptionalstrictIf 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). See [Locator] to learn more about the strict mode.
OptionaltimezoneChanges the timezone of the context. See ICU's metaZones.txt for a list of supported timezone IDs.
OptionaluserSpecific user agent to use in this context.
OptionalvideoVideo frame height.
Video frame width.
OptionalvideosOptionalviewport?: null | { Emulates consistent viewport for each page. Defaults to an 1280x720 viewport. Use null to disable the consistent
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.
Emitted when Browser gets disconnected from the browser application. This might happen because of one of the following:
Emitted when Browser gets disconnected from the browser application. This might happen because of one of the following:
Adds a one-timelistener function for the event named eventName to the beginning of the listeners array. The next time eventName is triggered, this
listener is removed, and then invoked.
server.prependOnceListener('connection', (stream) => {
console.log('Ah, we have our first user!');
});
Returns a reference to the EventEmitter, so that calls can be chained.
The name of the event.
The callback function
Rest...args: any[]Returns a copy of the array of listeners for the event named eventName,
including any wrappers (such as those created by .once()).
import { EventEmitter } from 'node:events';
const emitter = new EventEmitter();
emitter.once('log', () => console.log('log once'));
// Returns a new Array with a function `onceWrapper` which has a property
// `listener` which contains the original listener bound above
const listeners = emitter.rawListeners('log');
const logFnWrapper = listeners[0];
// Logs "log once" to the console and does not unbind the `once` event
logFnWrapper.listener();
// Logs "log once" to the console and removes the listener
logFnWrapper();
emitter.on('log', () => console.log('log persistently'));
// Will return a new Array with a single function bound by `.on()` above
const newListeners = emitter.rawListeners('log');
// Logs "log persistently" twice
newListeners[0]();
emitter.emit('log');
Removes all listeners, or those of the specified eventName.
It is bad practice to remove listeners added elsewhere in the code,
particularly when the EventEmitter instance was created by some other
component or module (e.g. sockets or file streams).
Returns a reference to the EventEmitter, so that calls can be chained.
Optionalevent: string | symbolBy default EventEmitters will print a warning if more than 10 listeners are
added for a particular event. This is a useful default that helps finding
memory leaks. The emitter.setMaxListeners() method allows the limit to be
modified for this specific EventEmitter instance. The value can be set toInfinity (or 0) to indicate an unlimited number of listeners.
Returns a reference to the EventEmitter, so that calls can be chained.
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();
Optionalpage: PageOptional, if specified, tracing includes screenshots of the given page.
Optionaloptions: { Optionalcategories?: string[]specify custom categories to use instead of default.
Optionalpath?: stringA path to write the trace file to.
Optionalscreenshots?: booleancaptures screenshots in the trace.
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.
Optional[capture
A Browser is created via browserType.launch([options]). An example of using a [Browser] to create a [Page]: