@@ -154,8 +154,9 @@ type Browser interface {
154154 // opened).
155155 // In case this browser is connected to, clears all created contexts belonging to this browser and disconnects from
156156 // the browser server.
157- // **NOTE** This is similar to force quitting the browser. Therefore, you should call [BrowserContext.Close] on any
158- // [BrowserContext]'s you explicitly created earlier with [Browser.NewContext] **before** calling [Browser.Close].
157+ // **NOTE** This is similar to force-quitting the browser. To close pages gracefully and ensure you receive page close
158+ // events, call [BrowserContext.Close] on any [BrowserContext] instances you explicitly created earlier using
159+ // [Browser.NewContext] **before** calling [Browser.Close].
159160 // The [Browser] object itself is considered to be disposed and cannot be used anymore.
160161 Close (options ... BrowserCloseOptions ) error
161162
@@ -336,9 +337,13 @@ type BrowserContext interface {
336337 // Grants specified permissions to the browser context. Only grants corresponding permissions to the given origin if
337338 // specified.
338339 //
339- // permissions: A permission or an array of permissions to grant. Permissions can be one of the following values:
340+ // permissions: A list of permissions to grant.
341+ //
342+ // **NOTE** Supported permissions differ between browsers, and even between different versions of the same browser.
343+ // Any permission may stop working after an update.
344+ //
345+ // Here are some permissions that may be supported by some browsers:
340346 // - `'accelerometer'`
341- // - `'accessibility-events'`
342347 // - `'ambient-light-sensor'`
343348 // - `'background-sync'`
344349 // - `'camera'`
@@ -428,7 +433,7 @@ type BrowserContext interface {
428433 // **NOTE** [Page.SetDefaultNavigationTimeout], [Page.SetDefaultTimeout] and
429434 // [BrowserContext.SetDefaultNavigationTimeout] take priority over [BrowserContext.SetDefaultTimeout].
430435 //
431- // timeout: Maximum time in milliseconds
436+ // timeout: Maximum time in milliseconds. Pass `0` to disable timeout.
432437 SetDefaultTimeout (timeout float64 )
433438
434439 // The extra HTTP headers will be sent with every request initiated by any page in the context. These headers are
@@ -490,16 +495,19 @@ type BrowserContext interface {
490495// BrowserType provides methods to launch a specific browser instance or connect to an existing one. The following is
491496// a typical example of using Playwright to drive automation:
492497type BrowserType interface {
493- // This method attaches Playwright to an existing browser instance. When connecting to another browser launched via
494- // `BrowserType.launchServer` in Node.js, the major and minor version needs to match the client version (1.2.3 → is
495- // compatible with 1.2.x).
498+ // This method attaches Playwright to an existing browser instance created via `BrowserType.launchServer` in Node.js.
499+ // **NOTE** The major and minor version of the Playwright instance that connects needs to match the version of
500+ // Playwright that launches the browser (1.2.3 → is compatible with 1.2.x).
496501 //
497- // wsEndpoint: A browser websocket endpoint to connect to.
502+ // wsEndpoint: A Playwright browser websocket endpoint to connect to. You obtain this endpoint via `BrowserServer.wsEndpoint` .
498503 Connect (wsEndpoint string , options ... BrowserTypeConnectOptions ) (Browser , error )
499504
500505 // This method attaches Playwright to an existing browser instance using the Chrome DevTools Protocol.
501506 // The default browser context is accessible via [Browser.Contexts].
502507 // **NOTE** Connecting over the Chrome DevTools Protocol is only supported for Chromium-based browsers.
508+ // **NOTE** This connection is significantly lower fidelity than the Playwright protocol connection via
509+ // [BrowserType.Connect]. If you are experiencing issues or attempting to use advanced functionality, you probably
510+ // want to use [BrowserType.Connect].
503511 //
504512 // endpointURL: A CDP websocket endpoint or http url to connect to. For example `http://localhost:9222/` or
505513 // `ws://127.0.0.1:9222/devtools/browser/387adf4c-243f-4051-a181-46798f4a46f4`.
@@ -2597,7 +2605,9 @@ type Locator interface {
25972605 // [assertions guide]: https://playwright.dev/docs/test-assertions
25982606 IsDisabled (options ... LocatorIsDisabledOptions ) (bool , error )
25992607
2600- // Returns whether the element is [editable].
2608+ // Returns whether the element is [editable]. If the target element is not an `<input>`,
2609+ // `<textarea>`, `<select>`, `[contenteditable]` and does not have a role allowing `[aria-readonly]`, this method
2610+ // throws an error.
26012611 // **NOTE** If you need to assert that an element is editable, prefer [LocatorAssertions.ToBeEditable] to avoid
26022612 // flakiness. See [assertions guide] for more details.
26032613 //
@@ -2645,12 +2655,13 @@ type Locator interface {
26452655 Nth (index int ) Locator
26462656
26472657 // Creates a locator matching all elements that match one or both of the two locators.
2648- // Note that when both locators match something, the resulting locator will have multiple matches and violate
2649- // [locator strictness] guidelines .
2658+ // Note that when both locators match something, the resulting locator will have multiple matches, potentially causing
2659+ // a [locator strictness] violation .
26502660 //
26512661 // locator: Alternative locator to match.
26522662 //
26532663 // [locator strictness]: https://playwright.dev/docs/locators#strictness
2664+ // ["strict mode violation" error]: https://playwright.dev/docs/locators#strictness
26542665 Or (locator Locator ) Locator
26552666
26562667 // A page this locator belongs to.
@@ -2911,6 +2922,14 @@ type LocatorAssertions interface {
29112922 // [accessible description]: https://w3c.github.io/accname/#dfn-accessible-description
29122923 ToHaveAccessibleDescription (description interface {}, options ... LocatorAssertionsToHaveAccessibleDescriptionOptions ) error
29132924
2925+ // Ensures the [Locator] points to an element with a given
2926+ // [aria errormessage].
2927+ //
2928+ // errorMessage: Expected accessible error message.
2929+ //
2930+ // [aria errormessage]: https://w3c.github.io/aria/#aria-errormessage
2931+ ToHaveAccessibleErrorMessage (errorMessage interface {}, options ... LocatorAssertionsToHaveAccessibleErrorMessageOptions ) error
2932+
29142933 // Ensures the [Locator] points to an element with a given
29152934 // [accessible name].
29162935 //
@@ -2925,8 +2944,8 @@ type LocatorAssertions interface {
29252944 // 2. value: Expected attribute value.
29262945 ToHaveAttribute (name string , value interface {}, options ... LocatorAssertionsToHaveAttributeOptions ) error
29272946
2928- // Ensures the [Locator] points to an element with given CSS classes. This needs to be a full match or using a relaxed
2929- // regular expression.
2947+ // Ensures the [Locator] points to an element with given CSS classes. When a string is provided, it must fully match
2948+ // the element's `class` attribute. To match individual classes or perform partial matches, use a regular expression:
29302949 //
29312950 // expected: Expected class or RegExp or a list of those.
29322951 ToHaveClass (expected interface {}, options ... LocatorAssertionsToHaveClassOptions ) error
@@ -3659,7 +3678,6 @@ type Page interface {
36593678 Pause () error
36603679
36613680 // Returns the PDF buffer.
3662- // **NOTE** Generating a pdf is currently only supported in Chromium headless.
36633681 // `page.pdf()` generates a pdf of the page with `print` css media. To generate a pdf with `screen` media, call
36643682 // [Page.EmulateMedia] before calling `page.pdf()`:
36653683 // **NOTE** By default, `page.pdf()` generates a pdf with modified colors for printing. Use the
@@ -3875,7 +3893,7 @@ type Page interface {
38753893 // This setting will change the default maximum time for all the methods accepting “[object Object]” option.
38763894 // **NOTE** [Page.SetDefaultNavigationTimeout] takes priority over [Page.SetDefaultTimeout].
38773895 //
3878- // timeout: Maximum time in milliseconds
3896+ // timeout: Maximum time in milliseconds. Pass `0` to disable timeout.
38793897 SetDefaultTimeout (timeout float64 )
38803898
38813899 // The extra HTTP headers will be sent with every request the page initiates.
0 commit comments