Playwright has ability to mock clock and passage of time.
Virtual WebAuthn authenticator for this context. Lets tests seed credentials and intercept
navigator.credentials.create() / navigator.credentials.get() ceremonies.
Debugger allows to pause and resume the execution.
API testing helper associated with this context. Requests made with this API will use context cookies.
Adds cookies into this browser context. All pages within this context will have these cookies installed. Cookies can be obtained via browserContext.cookies([urls]).
Usage
await browserContext.addCookies([cookieObject1, cookieObject2]);
Adds a script which would be evaluated in one of the following scenarios:
The script is evaluated after the document was created but before any of its scripts were run. This is useful to
amend the JavaScript environment, e.g. to seed Math.random.
Usage
An example of overriding Math.random before the page loads:
// preload.js
Math.random = () => 42;
// In your playwright script, assuming the preload.js file is in same directory.
await browserContext.addInitScript({
path: 'preload.js'
});
NOTE The order of evaluation of multiple scripts installed via browserContext.addInitScript(script[, arg, options]) and page.addInitScript(script[, arg, options]) is not defined.
This event is not emitted.
Emitted when Browser context gets closed. This might happen because of one of the following:
Emitted when JavaScript within the page calls one of console API methods, e.g. console.log or console.dir.
The arguments passed into console.log and the page are available on the
ConsoleMessage event handler argument.
Usage
context.on('console', async msg => {
const values = [];
for (const arg of msg.args())
values.push(await arg.jsonValue());
console.log(...values);
});
await page.evaluate(() => console.log('hello', 5, { foo: 'bar' }));
Emitted when a JavaScript dialog appears, such as alert, prompt, confirm or beforeunload. Listener must
either dialog.accept([promptText]) or
dialog.dismiss() the dialog - otherwise the page
will freeze waiting for the
dialog, and actions like click will never finish.
Usage
context.on('dialog', dialog => {
dialog.accept();
});
NOTE When no page.on('dialog') or browserContext.on('dialog') listeners are present, all dialogs are automatically dismissed.
Emitted when attachment download started in any page belonging to this context. User can access basic file operations on downloaded content via the passed Download instance. See also page.on('download') to receive events about a specific page.
Emitted when a frame is attached in any page belonging to this context. See also page.on('frameattached') to receive events about a specific page.
Emitted when a frame is detached in any page belonging to this context. See also page.on('framedetached') to receive events about a specific page.
Emitted when a frame is navigated to a new url in any page belonging to this context. See also page.on('framenavigated') to receive events about navigations in a specific page.
The event is emitted when a new Page is created in the BrowserContext. The page may still be loading. The event will also fire for popup pages. See also page.on('popup') to receive events about popups relevant to a specific page.
The earliest moment that page is available is when it has navigated to the initial url. For example, when opening a
popup with window.open('http://example.com'), this event will fire when the network request to
"http://example.com" is done and its response has started loading in the popup. If you would like to route/listen
to this network request, use
browserContext.route(url, handler[, options])
and
browserContext.on('request')
respectively instead of similar methods on the Page.
const newPagePromise = context.waitForEvent('page');
await page.getByText('open new page').click();
const newPage = await newPagePromise;
console.log(await newPage.evaluate('location.href'));
NOTE Use page.waitForLoadState([state, options]) to wait until the page gets to a particular state (you should not need it in most cases).
Emitted when a page in this context is closed. See also page.on('close') to receive events about a specific page.
Emitted when the JavaScript load event is dispatched
in any page belonging to this context. See also
page.on('load') to receive events about a specific
page.
Emitted when a request is issued from any pages created through this context. The [request] object is read-only. To only listen for requests from a particular page, use page.on('request').
In order to intercept and mutate requests, see browserContext.route(url, handler[, options]) or page.route(url, handler[, options]).
Emitted when a request fails, for example by timing out. To only listen for failed requests from a particular page, use page.on('requestfailed').
NOTE HTTP Error responses, such as 404 or 503, are still successful responses from HTTP standpoint, so request will complete with browserContext.on('requestfinished') event and not with browserContext.on('requestfailed').
Emitted when a request finishes successfully after downloading the response body. For a successful response, the
sequence of events is request, response and requestfinished. To listen for successful requests from a
particular page, use
page.on('requestfinished').
Emitted when [response] status and headers are received for a request. For a successful response, the sequence of
events is request, response and requestfinished. To listen for response events from a particular page, use
page.on('response').
NOTE Service workers are only supported on Chromium-based browsers.
Emitted when new service worker is created in the context.
Emitted when exception is unhandled in any of the pages in this context. To listen for errors from a particular page, use page.on('pageerror') instead.
Returns an empty list.
Gets the browser instance that owns the context. Returns null if the context is created outside of normal
browser, e.g. Android or Electron.
Removes cookies from context. Accepts optional filter.
Usage
await context.clearCookies();
await context.clearCookies({ name: 'session-id' });
await context.clearCookies({ domain: 'my-origin.com' });
await context.clearCookies({ domain: /.*my-origin\.com/ });
await context.clearCookies({ path: '/api/v1' });
await context.clearCookies({ name: 'session-id', domain: 'my-origin.com' });
Optionaloptions: { domain?: string | RegExp; name?: string | RegExp; path?: string | RegExp }
Optionaldomain?: string | RegExpOnly removes cookies with the given domain.
Optionalname?: string | RegExpOnly removes cookies with the given name.
Optionalpath?: string | RegExpOnly removes cookies with the given path.
Clears all permission overrides for the browser context.
Usage
const context = await browser.newContext();
await context.grantPermissions(['clipboard-read']);
// do stuff ..
context.clearPermissions();
Closes the browser context. All the pages that belong to the browser context will be closed.
NOTE The default browser context cannot be closed.
Optionaloptions: { reason?: string }
Optionalreason?: stringThe reason to be reported to the operations interrupted by the context closure.
If no URLs are specified, this method returns all cookies. If URLs are specified, only cookies that affect those URLs are returned.
Optionalurls: string | readonly string[]
Optional list of URLs.
The method adds a function called
name on the
window object of every frame in every page in the context. When called, the function executes
callback
and returns a [Promise] which resolves to the return value of
callback.
If the
callback
returns a [Promise], it will be awaited.
The first argument of the
callback
function contains information about the caller: { browserContext: BrowserContext, page: Page, frame: Frame }.
See page.exposeBinding(name, callback) for page-only version.
Usage
An example of exposing page URL to all frames in all pages in the context:
const { webkit } = require('playwright'); // Or 'chromium' or 'firefox'.
(async () => {
const browser = await webkit.launch({ headless: false });
const context = await browser.newContext();
await context.exposeBinding('pageURL', ({ page }) => page.url());
const page = await context.newPage();
await page.setContent(`
<script>
async function onClick() {
document.querySelector('div').textContent = await window.pageURL();
}
</script>
<button onclick="onClick()">Click me</button>
<div></div>
`);
await page.getByRole('button').click();
})();
Name of the function on the window object.
The method adds a function called
name on the
window object of every frame in every page in the context. When called, the function executes
callback
and returns a [Promise] which resolves to the return value of
callback.
If the
callback
returns a [Promise], it will be awaited.
See page.exposeFunction(name, callback) for page-only version.
Usage
An example of adding a sha256 function to all pages in the context:
const { webkit } = require('playwright'); // Or 'chromium' or 'firefox'.
const crypto = require('crypto');
(async () => {
const browser = await webkit.launch({ headless: false });
const context = await browser.newContext();
await context.exposeFunction('sha256', text =>
crypto.createHash('sha256').update(text).digest('hex'),
);
const page = await context.newPage();
await page.setContent(`
<script>
async function onClick() {
document.querySelector('div').textContent = await window.sha256('PLAYWRIGHT');
}
</script>
<button onclick="onClick()">Click me</button>
<div></div>
`);
await page.getByRole('button').click();
})();
Name of the function on the window object.
Callback function that will be called in the Playwright's context.
Grants specified permissions to the browser context. Only grants corresponding permissions to the given origin if specified.
A list of permissions to grant.
NOTE Supported permissions differ between browsers, and even between different versions of the same browser. Any permission may stop working after an update.
Here are some permissions that may be supported by some browsers:
'accelerometer''ambient-light-sensor''background-sync''camera''clipboard-read''clipboard-write''geolocation''gyroscope''local-fonts''local-network-access''magnetometer''microphone''midi-sysex' (system-exclusive midi)'midi''notifications''payment-handler''storage-access''screen-wake-lock'Optionaloptions: { origin?: string }
Optionalorigin?: stringThe [origin] to grant permissions to, e.g. "https://example.com".
Indicates that the browser context is in the process of closing or has already been closed.
NOTE CDP sessions are only supported on Chromium-based browsers.
Returns the newly created session.
Creates a new page in the browser context.
Removes an event listener added by on or addListener.
Removes an event listener added by on or addListener.
Removes an event listener added by on or addListener.
Removes an event listener added by on or addListener.
Removes an event listener added by on or addListener.
Removes an event listener added by on or addListener.
Removes an event listener added by on or addListener.
Removes an event listener added by on or addListener.
Removes an event listener added by on or addListener.
Removes an event listener added by on or addListener.
Removes an event listener added by on or addListener.
Removes an event listener added by on or addListener.
Removes an event listener added by on or addListener.
Removes an event listener added by on or addListener.
Removes an event listener added by on or addListener.
Removes an event listener added by on or addListener.
Removes an event listener added by on or addListener.
This event is not emitted.
Emitted when Browser context gets closed. This might happen because of one of the following:
Emitted when JavaScript within the page calls one of console API methods, e.g. console.log or console.dir.
The arguments passed into console.log and the page are available on the
ConsoleMessage event handler argument.
Usage
context.on('console', async msg => {
const values = [];
for (const arg of msg.args())
values.push(await arg.jsonValue());
console.log(...values);
});
await page.evaluate(() => console.log('hello', 5, { foo: 'bar' }));
Emitted when a JavaScript dialog appears, such as alert, prompt, confirm or beforeunload. Listener must
either dialog.accept([promptText]) or
dialog.dismiss() the dialog - otherwise the page
will freeze waiting for the
dialog, and actions like click will never finish.
Usage
context.on('dialog', dialog => {
dialog.accept();
});
NOTE When no page.on('dialog') or browserContext.on('dialog') listeners are present, all dialogs are automatically dismissed.
Emitted when attachment download started in any page belonging to this context. User can access basic file operations on downloaded content via the passed Download instance. See also page.on('download') to receive events about a specific page.
Emitted when a frame is attached in any page belonging to this context. See also page.on('frameattached') to receive events about a specific page.
Emitted when a frame is detached in any page belonging to this context. See also page.on('framedetached') to receive events about a specific page.
Emitted when a frame is navigated to a new url in any page belonging to this context. See also page.on('framenavigated') to receive events about navigations in a specific page.
The event is emitted when a new Page is created in the BrowserContext. The page may still be loading. The event will also fire for popup pages. See also page.on('popup') to receive events about popups relevant to a specific page.
The earliest moment that page is available is when it has navigated to the initial url. For example, when opening a
popup with window.open('http://example.com'), this event will fire when the network request to
"http://example.com" is done and its response has started loading in the popup. If you would like to route/listen
to this network request, use
browserContext.route(url, handler[, options])
and
browserContext.on('request')
respectively instead of similar methods on the Page.
const newPagePromise = context.waitForEvent('page');
await page.getByText('open new page').click();
const newPage = await newPagePromise;
console.log(await newPage.evaluate('location.href'));
NOTE Use page.waitForLoadState([state, options]) to wait until the page gets to a particular state (you should not need it in most cases).
Emitted when a page in this context is closed. See also page.on('close') to receive events about a specific page.
Emitted when the JavaScript load event is dispatched
in any page belonging to this context. See also
page.on('load') to receive events about a specific
page.
Emitted when a request is issued from any pages created through this context. The [request] object is read-only. To only listen for requests from a particular page, use page.on('request').
In order to intercept and mutate requests, see browserContext.route(url, handler[, options]) or page.route(url, handler[, options]).
Emitted when a request fails, for example by timing out. To only listen for failed requests from a particular page, use page.on('requestfailed').
NOTE HTTP Error responses, such as 404 or 503, are still successful responses from HTTP standpoint, so request will complete with browserContext.on('requestfinished') event and not with browserContext.on('requestfailed').
Emitted when a request finishes successfully after downloading the response body. For a successful response, the
sequence of events is request, response and requestfinished. To listen for successful requests from a
particular page, use
page.on('requestfinished').
Emitted when [response] status and headers are received for a request. For a successful response, the sequence of
events is request, response and requestfinished. To listen for response events from a particular page, use
page.on('response').
NOTE Service workers are only supported on Chromium-based browsers.
Emitted when new service worker is created in the context.
Emitted when exception is unhandled in any of the pages in this context. To listen for errors from a particular page, use page.on('pageerror') instead.
Adds an event listener that will be automatically removed after it is triggered once. See addListener for more information about this event.
Adds an event listener that will be automatically removed after it is triggered once. See addListener for more information about this event.
Adds an event listener that will be automatically removed after it is triggered once. See addListener for more information about this event.
Adds an event listener that will be automatically removed after it is triggered once. See addListener for more information about this event.
Adds an event listener that will be automatically removed after it is triggered once. See addListener for more information about this event.
Adds an event listener that will be automatically removed after it is triggered once. See addListener for more information about this event.
Adds an event listener that will be automatically removed after it is triggered once. See addListener for more information about this event.
Adds an event listener that will be automatically removed after it is triggered once. See addListener for more information about this event.
Adds an event listener that will be automatically removed after it is triggered once. See addListener for more information about this event.
Adds an event listener that will be automatically removed after it is triggered once. See addListener for more information about this event.
Adds an event listener that will be automatically removed after it is triggered once. See addListener for more information about this event.
Adds an event listener that will be automatically removed after it is triggered once. See addListener for more information about this event.
Adds an event listener that will be automatically removed after it is triggered once. See addListener for more information about this event.
Adds an event listener that will be automatically removed after it is triggered once. See addListener for more information about this event.
Adds an event listener that will be automatically removed after it is triggered once. See addListener for more information about this event.
Adds an event listener that will be automatically removed after it is triggered once. See addListener for more information about this event.
Adds an event listener that will be automatically removed after it is triggered once. See addListener for more information about this event.
Returns all open pages in the context.
This event is not emitted.
Emitted when Browser context gets closed. This might happen because of one of the following:
Emitted when JavaScript within the page calls one of console API methods, e.g. console.log or console.dir.
The arguments passed into console.log and the page are available on the
ConsoleMessage event handler argument.
Usage
context.on('console', async msg => {
const values = [];
for (const arg of msg.args())
values.push(await arg.jsonValue());
console.log(...values);
});
await page.evaluate(() => console.log('hello', 5, { foo: 'bar' }));
Emitted when a JavaScript dialog appears, such as alert, prompt, confirm or beforeunload. Listener must
either dialog.accept([promptText]) or
dialog.dismiss() the dialog - otherwise the page
will freeze waiting for the
dialog, and actions like click will never finish.
Usage
context.on('dialog', dialog => {
dialog.accept();
});
NOTE When no page.on('dialog') or browserContext.on('dialog') listeners are present, all dialogs are automatically dismissed.
Emitted when attachment download started in any page belonging to this context. User can access basic file operations on downloaded content via the passed Download instance. See also page.on('download') to receive events about a specific page.
Emitted when a frame is attached in any page belonging to this context. See also page.on('frameattached') to receive events about a specific page.
Emitted when a frame is detached in any page belonging to this context. See also page.on('framedetached') to receive events about a specific page.
Emitted when a frame is navigated to a new url in any page belonging to this context. See also page.on('framenavigated') to receive events about navigations in a specific page.
The event is emitted when a new Page is created in the BrowserContext. The page may still be loading. The event will also fire for popup pages. See also page.on('popup') to receive events about popups relevant to a specific page.
The earliest moment that page is available is when it has navigated to the initial url. For example, when opening a
popup with window.open('http://example.com'), this event will fire when the network request to
"http://example.com" is done and its response has started loading in the popup. If you would like to route/listen
to this network request, use
browserContext.route(url, handler[, options])
and
browserContext.on('request')
respectively instead of similar methods on the Page.
const newPagePromise = context.waitForEvent('page');
await page.getByText('open new page').click();
const newPage = await newPagePromise;
console.log(await newPage.evaluate('location.href'));
NOTE Use page.waitForLoadState([state, options]) to wait until the page gets to a particular state (you should not need it in most cases).
Emitted when a page in this context is closed. See also page.on('close') to receive events about a specific page.
Emitted when the JavaScript load event is dispatched
in any page belonging to this context. See also
page.on('load') to receive events about a specific
page.
Emitted when a request is issued from any pages created through this context. The [request] object is read-only. To only listen for requests from a particular page, use page.on('request').
In order to intercept and mutate requests, see browserContext.route(url, handler[, options]) or page.route(url, handler[, options]).
Emitted when a request fails, for example by timing out. To only listen for failed requests from a particular page, use page.on('requestfailed').
NOTE HTTP Error responses, such as 404 or 503, are still successful responses from HTTP standpoint, so request will complete with browserContext.on('requestfinished') event and not with browserContext.on('requestfailed').
Emitted when a request finishes successfully after downloading the response body. For a successful response, the
sequence of events is request, response and requestfinished. To listen for successful requests from a
particular page, use
page.on('requestfinished').
Emitted when [response] status and headers are received for a request. For a successful response, the sequence of
events is request, response and requestfinished. To listen for response events from a particular page, use
page.on('response').
NOTE Service workers are only supported on Chromium-based browsers.
Emitted when new service worker is created in the context.
Emitted when exception is unhandled in any of the pages in this context. To listen for errors from a particular page, use page.on('pageerror') instead.
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.
Optionaltype: stringRemoves 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.
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 caughtRemoves an event listener added by on or addListener.
Removes an event listener added by on or addListener.
Removes an event listener added by on or addListener.
Removes an event listener added by on or addListener.
Removes an event listener added by on or addListener.
Removes an event listener added by on or addListener.
Removes an event listener added by on or addListener.
Removes an event listener added by on or addListener.
Removes an event listener added by on or addListener.
Removes an event listener added by on or addListener.
Removes an event listener added by on or addListener.
Removes an event listener added by on or addListener.
Removes an event listener added by on or addListener.
Removes an event listener added by on or addListener.
Removes an event listener added by on or addListener.
Removes an event listener added by on or addListener.
Removes an event listener added by on or addListener.
Routing provides the capability to modify network requests that are made by any page in the browser context. Once route is enabled, every request matching the url pattern will stall unless it's continued, fulfilled or aborted.
NOTE
browserContext.route(url, handler[, options])
will not intercept requests intercepted by Service Worker. See
this issue. We recommend disabling Service Workers when
using request interception by setting
serviceWorkers to
'block'.
Usage
An example of a naive handler that aborts all image requests:
const context = await browser.newContext();
await context.route('**/*.{png,jpg,jpeg}', route => route.abort());
const page = await context.newPage();
await page.goto('https://example.com');
await browser.close();
or the same snippet using a regex pattern instead:
const context = await browser.newContext();
await context.route(/(\.png$)|(\.jpg$)/, route => route.abort());
const page = await context.newPage();
await page.goto('https://example.com');
await browser.close();
It is possible to examine the request to decide the route action. For example, mocking all requests that contain some post data, and leaving all other requests as is:
await context.route('/api/**', async route => {
if (route.request().postData().includes('my-string'))
await route.fulfill({ body: 'mocked-data' });
else
await route.continue();
});
Page routes (set up with page.route(url, handler[, options])) take precedence over browser context routes when request matches both handlers.
To remove a route with its handler you can use browserContext.unroute(url[, handler]).
NOTE Enabling routing disables http cache.
If specified the network requests that are made in the context will be served from the HAR file. Read more about Replaying from HAR.
Playwright will not serve requests intercepted by Service Worker from the HAR file. See
this issue. We recommend disabling Service Workers when
using request interception by setting
serviceWorkers to
'block'.
Path to a HAR file with prerecorded network data. If path is a
relative path, then it is resolved relative to the current working directory.
Optionaloptions: {OptionalnotFound?: "abort" | "fallback"Defaults to abort.
Optionalupdate?: booleanIf specified, updates the given HAR with the actual network information instead of serving from file. The file is written to disk when browserContext.close([options]) is called.
OptionalupdateContent?: "embed" | "attach"Optional setting to control resource content management. 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.
OptionalupdateMode?: "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
minimal.
Optionalurl?: string | RegExpA glob pattern, regular expression or predicate to match the request URL. Only requests with URL matching the pattern will be served from the HAR file. If not specified, all requests are served from the HAR file.
This method allows to modify websocket connections that are made by any page in the browser context.
Note that only WebSockets created after this method was called will be routed. It is recommended to call this
method before creating any pages.
Usage
Below is an example of a simple handler that blocks some websocket messages. See WebSocketRoute for more details and examples.
await context.routeWebSocket('/ws', async ws => {
ws.routeSend(message => {
if (message === 'to-be-blocked')
return;
ws.send(message);
});
await ws.connect();
});
Only WebSockets with the url matching this pattern will be routed. A string pattern can be relative to the
baseURL context option.
Handler function to route the WebSocket.
NOTE Service workers are only supported on Chromium-based browsers.
All existing service workers in the context.
This setting will change the default maximum navigation time for the following methods and related shortcuts:
NOTE page.setDefaultNavigationTimeout(timeout) and page.setDefaultTimeout(timeout) take priority over browserContext.setDefaultNavigationTimeout(timeout).
Maximum navigation time in milliseconds
This setting will change the default maximum time for all the methods accepting
timeout
option.
NOTE page.setDefaultNavigationTimeout(timeout), page.setDefaultTimeout(timeout) and browserContext.setDefaultNavigationTimeout(timeout) take priority over browserContext.setDefaultTimeout(timeout).
Maximum time in milliseconds. Pass 0 to disable timeout.
The extra HTTP headers will be sent with every request initiated by any page in the context. These headers are merged with page-specific extra HTTP headers set with page.setExtraHTTPHeaders(headers). If page overrides a particular header, page-specific header value will be used instead of the browser context header value.
NOTE browserContext.setExtraHTTPHeaders(headers) does not guarantee the order of headers in the outgoing requests.
An object containing additional HTTP headers to be sent with every request. All header values must be strings.
Sets the context's geolocation. Passing null or undefined emulates position unavailable.
Usage
await browserContext.setGeolocation({ latitude: 59.95, longitude: 30.31667 });
NOTE Consider using browserContext.grantPermissions(permissions[, options]) to grant permissions for the browser context pages to read its geolocation.
Optionalaccuracy?: numberNon-negative accuracy value. Defaults to 0.
Latitude between -90 and 90.
Longitude between -180 and 180.
Whether to emulate network being offline for the browser context.
Clears the existing cookies, local storage, IndexedDB entries and virtual WebAuthn credentials, and sets the new storage state. When the storage state contains credentials, the virtual WebAuthn authenticator is installed (equivalent to credentials.install()), preventing all real authenticators from working in this context.
Usage
// Load storage state from a file and apply it to the context.
await context.setStorageState('state.json');
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]).
Cookies to set for context
Returns storage state for this browser context, contains current cookies, local storage snapshot, IndexedDB snapshot and virtual WebAuthn credentials.
Optionaloptions: { credentials?: boolean; indexedDB?: boolean; path?: string }
Optionalcredentials?: booleanSet to true to include the context's virtual WebAuthn
browserContext.credentials
(passkeys) in the storage state snapshot. The captured credentials carry their private keys, so they can be
re-seeded into a later context via the
storageState option or
browserContext.setStorageState(storageState).
Note that restoring the storage state that contains credentials will automatically install the virtual WebAuthn
authenticator (see credentials.install()),
and prevent all real authenticators from working in this context.
OptionalindexedDB?: booleanSet to true to include IndexedDB in the storage
state snapshot. If your application uses IndexedDB to store authentication tokens, like Firebase Authentication,
enable this.
Optionalpath?: stringThe file path to save the storage state to. If
path is a
relative path, then it is resolved relative to current working directory. If no path is provided, storage state is
still returned, but won't be saved to the disk.
Removes a route created with
browserContext.route(url, handler[, options]).
When handler is
not specified, removes all routes for the
url.
A glob pattern, regex pattern, URL pattern, or predicate receiving [URL] used to register a routing with browserContext.route(url, handler[, options]).
Optionalhandler: (route: Route, request: Request) => any
Optional handler function used to register a routing with browserContext.route(url, handler[, options]).
Removes all routes created with browserContext.route(url, handler[, options]) and browserContext.routeFromHAR(har[, options]).
Optionaloptions: { behavior?: "default" | "wait" | "ignoreErrors" }
Optionalbehavior?: "default" | "wait" | "ignoreErrors"Specifies whether to wait for already running handlers and what to do if they throw errors:
'default' - do not wait for current handler calls (if any) to finish, if unrouted handler throws, it may
result in unhandled error'wait' - wait for current handler calls (if any) to finish'ignoreErrors' - do not wait for current handler calls (if any) to finish, all errors thrown by the handlers
after unrouting are silently caughtEmitted when Browser context gets closed. This might happen because of one of the following:
OptionaloptionsOrPredicate: Emitted when JavaScript within the page calls one of console API methods, e.g. console.log or console.dir.
The arguments passed into console.log and the page are available on the
ConsoleMessage event handler argument.
Usage
context.on('console', async msg => {
const values = [];
for (const arg of msg.args())
values.push(await arg.jsonValue());
console.log(...values);
});
await page.evaluate(() => console.log('hello', 5, { foo: 'bar' }));
OptionaloptionsOrPredicate: Emitted when a JavaScript dialog appears, such as alert, prompt, confirm or beforeunload. Listener must
either dialog.accept([promptText]) or
dialog.dismiss() the dialog - otherwise the page
will freeze waiting for the
dialog, and actions like click will never finish.
Usage
context.on('dialog', dialog => {
dialog.accept();
});
NOTE When no page.on('dialog') or browserContext.on('dialog') listeners are present, all dialogs are automatically dismissed.
Emitted when attachment download started in any page belonging to this context. User can access basic file operations on downloaded content via the passed Download instance. See also page.on('download') to receive events about a specific page.
Emitted when a frame is attached in any page belonging to this context. See also page.on('frameattached') to receive events about a specific page.
Emitted when a frame is detached in any page belonging to this context. See also page.on('framedetached') to receive events about a specific page.
Emitted when a frame is navigated to a new url in any page belonging to this context. See also page.on('framenavigated') to receive events about navigations in a specific page.
The event is emitted when a new Page is created in the BrowserContext. The page may still be loading. The event will also fire for popup pages. See also page.on('popup') to receive events about popups relevant to a specific page.
The earliest moment that page is available is when it has navigated to the initial url. For example, when opening a
popup with window.open('http://example.com'), this event will fire when the network request to
"http://example.com" is done and its response has started loading in the popup. If you would like to route/listen
to this network request, use
browserContext.route(url, handler[, options])
and
browserContext.on('request')
respectively instead of similar methods on the Page.
const newPagePromise = context.waitForEvent('page');
await page.getByText('open new page').click();
const newPage = await newPagePromise;
console.log(await newPage.evaluate('location.href'));
NOTE Use page.waitForLoadState([state, options]) to wait until the page gets to a particular state (you should not need it in most cases).
Emitted when a page in this context is closed. See also page.on('close') to receive events about a specific page.
Emitted when the JavaScript load event is dispatched
in any page belonging to this context. See also
page.on('load') to receive events about a specific
page.
Emitted when a request is issued from any pages created through this context. The [request] object is read-only. To only listen for requests from a particular page, use page.on('request').
In order to intercept and mutate requests, see browserContext.route(url, handler[, options]) or page.route(url, handler[, options]).
Emitted when a request fails, for example by timing out. To only listen for failed requests from a particular page, use page.on('requestfailed').
NOTE HTTP Error responses, such as 404 or 503, are still successful responses from HTTP standpoint, so request will complete with browserContext.on('requestfinished') event and not with browserContext.on('requestfailed').
Emitted when a request finishes successfully after downloading the response body. For a successful response, the
sequence of events is request, response and requestfinished. To listen for successful requests from a
particular page, use
page.on('requestfinished').
Emitted when [response] status and headers are received for a request. For a successful response, the sequence of
events is request, response and requestfinished. To listen for response events from a particular page, use
page.on('response').
NOTE Service workers are only supported on Chromium-based browsers.
Emitted when new service worker is created in the context.
Emitted when exception is unhandled in any of the pages in this context. To listen for errors from a particular page, use page.on('pageerror') instead.
BrowserContexts provide a way to operate multiple independent browser sessions.
If a page opens another page, e.g. with a
window.opencall, the popup will belong to the parent page's browser context.Playwright allows creating isolated non-persistent browser contexts with browser.newContext([options]) method. Non-persistent browser contexts don't write any browsing data to disk.