Playwright コアクラス API
この付録では、Playwright コアクラスの一般的な API を一覧表示し、簡単に参照できるようにしています。
Playwright クラス
Playwright は Playwright Library のエントリポイントオブジェクトです。
| メソッド/プロパティ | 説明 |
|---|---|
playwright.chromium | Chromium の BrowserType オブジェクトを返します。 |
playwright.firefox | Firefox の BrowserType オブジェクトを返します。 |
playwright.webkit | WebKit の BrowserType オブジェクトを返します。 |
playwright.request | APIRequest オブジェクトを返します。 |
playwright.selectors | Selectors オブジェクトを返します。 |
BrowserType クラス
BrowserType はブラウザの起動と接続に使用されます。
| メソッド | 説明 |
|---|---|
browserType.launch(options?) | ブラウザインスタンスを起動する |
browserType.launchPersistentContext(userDataDir, options?) | 永続的な Context を起動する(ローカルユーザーデータディレクトリを使用) |
browserType.connect(url, options?) | 実行中のブラウザに接続する |
browserType.connectOverCDP(url, options?) | CDP プロトコルを介して実行中のブラウザに接続する |
browserType.executablePath() | ブラウザの実行可能ファイルのパスを返す |
browserType.name() | ブラウザ名を返す |
Browser クラス
Browser はブラウザインスタンスを表します。
| メソッド/プロパティ | 説明 |
|---|---|
browser.newContext(options?) | 新しい BrowserContext を作成する |
browser.newPage(options?) | 新しい Context 内で新しい Page を作成する |
browser.contexts() | すべての Context のリストを返す |
browser.close() | ブラウザとすべてのページを閉じる |
browser.browserType() | 対応する BrowserType を返す |
browser.version() | ブラウザのバージョンを返す |
browser.isConnected() | 接続されているかどうか |
BrowserContext クラス
BrowserContext は独立したブラウザコンテキストを表します。
| メソッド | 説明 |
|---|---|
context.newPage() | 新しいページを作成する |
context.pages() | 開いているすべてのページを返す |
context.close() | Context を閉じる |
context.cookies(urls?) | Cookie を取得する |
context.addCookies(cookies) | Cookie を追加する |
context.clearCookies() | すべての Cookie をクリアする |
context.storageState(options?) | 現在のストレージ状態を取得する(認証の再利用用) |
context.grantPermissions(permissions) | 権限を付与する |
context.clearPermissions() | 権限をクリアする |
context.setGeolocation(geolocation) | 地理位置情報を設定する |
context.setExtraHTTPHeaders(headers) | 追加の HTTP ヘッダーを設定する |
context.route(url, handler) | ネットワークリクエストをインターセプトする |
context.unroute(url, handler?) | インターセプトをキャンセルする |
context.exposeFunction(name, fn) | ページに関数を公開する |
context.exposeBinding(name, callback) | ページにバインディングを公開する |
BrowserServer クラス
BrowserServer は、次の方法でlaunchServer()起動されたブラウザプロセスを表します。
| メソッド | 説明 |
|---|---|
browserServer.wsEndpoint() | WebSocket エンドポイント URL を返す(リモート接続用) |
browserServer.close() | サーバーとブラウザを閉じる |
browserServer.kill() | ブラウザプロセスを強制終了する |