Skip to content

Commit 5e0f225

Browse files
committed
improve typedoc, export PlaywrightBrowserContextService
1 parent 9c7f5d0 commit 5e0f225

File tree

3 files changed

+25
-3
lines changed

3 files changed

+25
-3
lines changed

src/experimental/environment.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ import type { PlaywrightError } from "../errors";
77
/**
88
* Most of the time you want to use the same kind of browser and configuration every time you use Playwright.
99
* `PlaywrightEnvironment` is a service that allows you to configure how browsers are launched once. You can then
10-
* use {@link PlaywrightEnvironment.browser} to start browsers scoped to the current lifetime. They will be closed when the scope is closed.
10+
* use `PlaywrightEnvironment.browser` to start browsers scoped to the current lifetime. They will be closed when the scope is closed.
1111
*
12-
* You can use {@link PlaywrightEnvironment.withBrowser} to provide the `PlaywrightBrowser` service to the wrapped effect. This
12+
* You can use {@link withBrowser} to provide the `PlaywrightBrowser` service to the wrapped effect. This
1313
* also allows you to re-use the same browser as many times as you want.
1414
*
1515
* @since 0.1.0

src/index.ts

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,10 @@
1515
*/
1616

1717
export * from "./browser";
18-
export { PlaywrightBrowserContext } from "./browser-context";
18+
export {
19+
PlaywrightBrowserContext,
20+
type PlaywrightBrowserContextService,
21+
} from "./browser-context";
1922
export * from "./common";
2023
export type { PlaywrightErrorReason } from "./errors";
2124
export { PlaywrightError } from "./errors";

typedoc.json

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,25 @@
4343
"Page.locator": "https://playwright.dev/docs/api/class-page#page-locator",
4444
"Page.url": "https://playwright.dev/docs/api/class-page#page-url",
4545
"Page.click": "https://playwright.dev/docs/api/class-page#page-click",
46+
"Page.waitForURL": "https://playwright.dev/docs/api/class-page#page-wait-for-url",
47+
"Page.getByRole": "https://playwright.dev/docs/api/class-page#page-get-by-role",
48+
"Page.getByText": "https://playwright.dev/docs/api/class-page#page-get-by-text",
49+
"Page.getByLabel": "https://playwright.dev/docs/api/class-page#page-get-by-label",
50+
"Page.getByTestId": "https://playwright.dev/docs/api/class-page#page-get-by-test-id",
51+
"Page.reload": "https://playwright.dev/docs/api/class-page#page-reload",
52+
"Page.close": "https://playwright.dev/docs/api/class-page#page-close",
53+
"Page.on": "https://playwright.dev/docs/api/class-page#page-on",
54+
"Browser.newPage": "https://playwright.dev/docs/api/class-browser#browser-new-page",
55+
"Browser.close": "https://playwright.dev/docs/api/class-browser#browser-close",
56+
"Browser.contexts": "https://playwright.dev/docs/api/class-browser#browser-contexts",
57+
"Browser.browserType": "https://playwright.dev/docs/api/class-browser#browser-browser-type",
58+
"Browser.version": "https://playwright.dev/docs/api/class-browser#browser-version",
59+
"Browser.isConnected": "https://playwright.dev/docs/api/class-browser#browser-is-connected",
60+
"Browser.on": "https://playwright.dev/docs/api/class-browser#browser-on",
61+
"BrowserContext.pages": "https://playwright.dev/docs/api/class-browsercontext#browser-context-pages",
62+
"BrowserContext.newPage": "https://playwright.dev/docs/api/class-browsercontext#browser-context-new-page",
63+
"BrowserContext.close": "https://playwright.dev/docs/api/class-browsercontext#browser-context-close",
64+
"BrowserContext.on": "https://playwright.dev/docs/api/class-browsercontext#browser-context-on",
4665
"Locator.click": "https://playwright.dev/docs/api/class-locator#locator-click",
4766
"Locator.fill": "https://playwright.dev/docs/api/class-locator#locator-fill",
4867
"Locator.getAttribute": "https://playwright.dev/docs/api/class-locator#locator-get-attribute",

0 commit comments

Comments
 (0)