BrowserType

BrowserTypeは、特定のブラウザインスタンスを起動したり、既存のインスタンスに接続したりするためのメソッドを提供します。Playwrightを使用して自動化を推進する典型的な例を以下に示します。

const { chromium } = require('playwright');  // Or 'firefox' or 'webkit'.

(async () => {
  const browser = await chromium.launch();
  const page = await browser.newPage();
  await page.goto('https://example.com');
  // other actions...
  await browser.close();
})();

メソッド

connect

v1.9より前に追加

browserType.connect

このメソッドは、Node.jsのBrowserType.launchServerによって作成された既存のブラウザインスタンスにPlaywrightを接続します。

注

接続するPlaywrightインスタンスのメジャーバージョンとマイナーバージョンは、ブラウザを起動するPlaywrightのバージョンと一致する必要があります (1.2.3 → 1.2.xと互換性があります)。

使用法

await browserType.connect(wsEndpoint);
await browserType.connect(wsEndpoint, options);

引数

wsEndpoint string追加バージョン: v1.10#

接続するPlaywrightブラウザのwebsocketエンドポイント。このエンドポイントはBrowserServer.wsEndpoint経由で取得します。
options Object (optional)
- exposeNetwork string (optional)追加されたバージョン: v1.37#
  
  このオプションは、接続クライアントで利用可能なネットワークを接続先のブラウザに公開します。カンマで区切られたルールリストで構成されます。
  
  利用可能なルール
  1. ホスト名パターン。例: example.com, *.org:99, x.*.y.com, *foo.org。
  2. IPリテラル。例: 127.0.0.1, 0.0.0.0:99, [::1], [0:0::1]:99。
  3. ローカルループバックインターフェースに一致する<loopback>: localhost, *.localhost, 127.0.0.1, [::1]。
  いくつかの一般的な例
  1. すべてのネットワークを公開する"*"。
  2. localhostネットワークを公開する"<loopback>"。
  3. テスト/ステージングデプロイメントとlocalhostを公開する"*.test.internal-domain,*.staging.internal-domain,<loopback>"。
- headers Object<string, string> (optional)追加されたバージョン: v1.11#
  
  Webソケット接続リクエストと共に送信される追加のHTTPヘッダー。オプション。
- logger Logger (optional)追加されたバージョン: v1.14#
  
  非推奨
  ロガーによって受信されるログは不完全です。代わりにトレースを使用してください。
  
  Playwrightログ用のロガーシンク。オプション。
- slowMo number (optional)追加バージョン: v1.10#
  
  指定されたミリ秒数だけPlaywrightの操作を遅くします。何が起こっているかを確認するのに便利です。デフォルトは0です。
- timeout number (optional)追加バージョン: v1.10#
  
  接続が確立されるまで待機する最大時間（ミリ秒単位）。デフォルトは0（タイムアウトなし）です。

戻り値

Promise<Browser>#

connectOverCDP

追加バージョン: v1.9

browserType.connectOverCDP

このメソッドは、Chrome DevTools Protocolを使用して既存のブラウザインスタンスにPlaywrightを接続します。

デフォルトのブラウザコンテキストはbrowser.contexts()からアクセスできます。

注

Chrome DevTools Protocol経由の接続は、Chromiumベースのブラウザでのみサポートされています。

注

この接続は、browserType.connect()経由のPlaywrightプロトコル接続よりもはるかに忠実度が低いです。問題が発生している場合や高度な機能を使用しようとしている場合は、おそらくbrowserType.connect()を使用することをお勧めします。

使用法

const browser = await playwright.chromium.connectOverCDP('https://:9222');
const defaultContext = browser.contexts()[0];
const page = defaultContext.pages()[0];

引数

endpointURL string追加されたバージョン: v1.11#

接続するCDP websocketエンドポイントまたはhttp url。例: https://:9222/ または ws://127.0.0.1:9222/devtools/browser/387adf4c-243f-4051-a181-46798f4a46f4。
options Object (optional)
- endpointURL string (optional)追加されたバージョン: v1.14#
  
  非推奨
  代わりに最初の引数を使用してください。
- headers Object<string, string> (optional)追加されたバージョン: v1.11#
  
  接続要求とともに送信される追加のHTTPヘッダー。オプション。
- logger Logger (optional)追加されたバージョン: v1.14#
  
  非推奨
  ロガーによって受信されるログは不完全です。代わりにトレースを使用してください。
  
  Playwrightログ用のロガーシンク。オプション。
- slowMo number (optional)追加されたバージョン: v1.11#
  
  指定されたミリ秒数だけPlaywrightの操作を遅くします。何が起こっているかを確認するのに便利です。デフォルトは0です。
- timeout number (optional)追加されたバージョン: v1.11#
  
  接続が確立されるまで待機する最大時間（ミリ秒単位）。デフォルトは30000（30秒）です。タイムアウトを無効にするには0を渡します。

戻り値

Promise<Browser>#

executablePath

v1.9より前に追加

browserType.executablePath

Playwrightがバンドルされたブラウザ実行ファイルを見つけると予想されるパス。

使用法

browserType.executablePath();

戻り値

string #

launch

v1.9より前に追加

browserType.launch

ブラウザインスタンスを返します。

使用法

--mute-audioをデフォルト引数から除外するにはignoreDefaultArgsを使用できます。

const browser = await chromium.launch({  // Or 'firefox' or 'webkit'.
  ignoreDefaultArgs: ['--mute-audio']
});

Chromiumのみ PlaywrightはGoogle ChromeまたはMicrosoft Edgeブラウザを制御するためにも使用できますが、バンドルされているChromiumバージョンで最適に動作します。他のバージョンで動作することは保証されません。executablePathオプションは細心の注意を払って使用してください。

Google Chrome（Chromiumではない）を好む場合は、Chrome CanaryまたはDev Channelビルドが推奨されます。

Google ChromeやMicrosoft Edgeのような純正ブラウザは、ビデオ再生に独自のメディアコーデックを必要とするテストに適しています。ChromiumとChromeのその他の違いについては、こちらの記事を参照してください。こちらの記事では、Linuxユーザー向けのいくつかの違いを説明しています。

引数

options Object (optional)
- args Array<string> (optional)#
  
  警告
  一部のカスタムブラウザ引数はPlaywrightの機能を破壊する可能性があるため、自己責任で使用してください。
  
  ブラウザインスタンスに渡す追加の引数。Chromiumフラグのリストはこちらで見つけることができます。
- channel string (optional)#
  
  ブラウザ配布チャネル。
  
  新しいヘッドレスモードにオプトインするには"chromium"を使用します。
  
  ブランドのGoogle ChromeおよびMicrosoft Edgeを使用するには、"chrome", "chrome-beta", "chrome-dev", "chrome-canary", "msedge", "msedge-beta", "msedge-dev", または "msedge-canary"を使用します。
- chromiumSandbox boolean (optional)#
  
  Chromiumサンドボックスを有効にします。デフォルトはfalseです。
- devtools boolean (optional)#
  
  非推奨
  代わりにデバッグツールを使用してください。
  
  Chromiumのみ 各タブのデベロッパーツールパネルを自動的に開くかどうか。このオプションがtrueの場合、headlessオプションはfalseに設定されます。
- downloadsPath string (optional)#
  
  指定されている場合、受け入れられたダウンロードはこのディレクトリにダウンロードされます。そうでない場合、一時ディレクトリが作成され、ブラウザが閉じられると削除されます。いずれの場合も、ダウンロードは作成されたブラウザコンテキストが閉じられると削除されます。
- env Object<string, string | number | boolean> (optional)#
  
  ブラウザに表示される環境変数を指定します。デフォルトはprocess.envです。
- executablePath string (optional)#
  
  バンドルされたブラウザの代わりに実行するブラウザ実行ファイルへのパス。executablePathが相対パスの場合、現在の作業ディレクトリを基準に解決されます。PlaywrightはバンドルされたChromium、Firefox、またはWebKitでのみ動作することに注意し、自己責任で使用してください。
- firefoxUserPrefs Object<string, string | number | boolean> (optional)#
  
  Firefoxのユーザー設定。Firefoxのユーザー設定の詳細については、about:configを参照してください。
  
  カスタムのpolicies.jsonファイルへのパスをPLAYWRIGHT_FIREFOX_POLICIES_JSON環境変数経由で提供することもできます。
- handleSIGHUP boolean (optional)#
  
  SIGHUPでブラウザプロセスを閉じます。デフォルトはtrueです。
- handleSIGINT boolean (optional)#
  
  Ctrl-Cでブラウザプロセスを閉じます。デフォルトはtrueです。
- handleSIGTERM boolean (optional)#
  
  SIGTERMでブラウザプロセスを閉じます。デフォルトはtrueです。
- headless boolean (optional)#
  
  ブラウザをヘッドレスモードで実行するかどうか。ChromiumとFirefoxの詳細。デフォルトはtrueですが、devtoolsオプションがtrueの場合はfalseになります。
- ignoreDefaultArgs boolean | Array<string> (optional)#
  
  trueの場合、Playwrightは独自の構成引数を渡さず、argsからの引数のみを使用します。配列が与えられた場合、指定されたデフォルト引数をフィルタリングします。危険なオプションなので、注意して使用してください。デフォルトはfalseです。
- logger Logger (optional)#
  
  非推奨
  ロガーによって受信されるログは不完全です。代わりにトレースを使用してください。
  
  Playwrightログ用のロガーシンク。
- proxy Object (optional)#
  - server string
    
    すべてのリクエストに使用するプロキシ。HTTPおよびSOCKSプロキシがサポートされており、例としてhttp://myproxy.com:3128またはsocks5://myproxy.com:3128があります。短縮形myproxy.com:3128はHTTPプロキシと見なされます。
  - bypass string (optional)
    
    プロキシをバイパスするオプションのカンマ区切りドメイン。例: ".com, chromium.org, .domain.com"。
  - username string (optional)
    
    HTTPプロキシが認証を必要とする場合に使用するオプションのユーザー名。
  - password string (optional)
    
    HTTPプロキシが認証を必要とする場合に使用するオプションのパスワード。
  ネットワークプロキシ設定。
- slowMo number (optional)#
  
  Playwrightの操作を、指定されたミリ秒数だけ遅らせます。何が起こっているかを確認するのに役立ちます。
- timeout number (optional)#
  
  ブラウザインスタンスが起動するまで待機する最大時間（ミリ秒単位）。デフォルトは30000（30秒）です。タイムアウトを無効にするには0を渡します。
- tracesDir string (optional)#
  
  指定されている場合、トレースはこのディレクトリに保存されます。

戻り値

Promise<Browser>#

launchPersistentContext

v1.9より前に追加

browserType.launchPersistentContext

永続的なブラウザコンテキストインスタンスを返します。

userDataDirに配置された永続ストレージを使用するブラウザを起動し、唯一のコンテキストを返します。このコンテキストを閉じると、ブラウザも自動的に閉じられます。

使用法

await browserType.launchPersistentContext(userDataDir);
await browserType.launchPersistentContext(userDataDir, options);

引数

userDataDir string #

クッキーやローカルストレージなどのブラウザセッションデータを保存するユーザーデータディレクトリへのパス。一時ディレクトリを作成するには空の文字列を渡します。

ChromiumおよびFirefoxの詳細。Chromiumのユーザーデータディレクトリは、chrome://versionで表示される「プロファイルパス」の親ディレクトリです。

ブラウザは同じユーザーデータディレクトリで複数のインスタンスを起動できないことに注意してください。

警告
Chromium/Chrome: 最近のChromeポリシー変更により、デフォルトのChromeユーザープロファイルの自動化はサポートされていません。userDataDirをChromeのメインの「ユーザーデータ」ディレクトリ（通常のブラウジングに使用されるプロファイル）に指定すると、ページの読み込みが失敗したり、ブラウザが終了したりする可能性があります。代わりに、独自の自動化プロファイルとして別のディレクトリ（例：空のフォルダ）を作成して使用してください。詳細については、https://developer.chrome.com/blog/remote-debugging-portを参照してください。
options Object (optional)
- acceptDownloads boolean (optional)#
  
  すべての添付ファイルを自動的にダウンロードするかどうか。デフォルトはtrueで、すべてのダウンロードが受け入れられます。
- args Array<string> (optional)#
  
  警告
  一部のカスタムブラウザ引数はPlaywrightの機能を破壊する可能性があるため、自己責任で使用してください。
  
  ブラウザインスタンスに渡す追加の引数。Chromiumフラグのリストはこちらで見つけることができます。
- baseURL string (optional)#
  
  page.goto(), page.route(), page.waitForURL(), page.waitForRequest(), または page.waitForResponse()を使用する場合、URL()コンストラクタを使用して対応するURLを構築することにより、ベースURLが考慮されます。デフォルトでは未設定です。例
  - baseURL: https://:3000で/bar.htmlにナビゲートすると、https://:3000/bar.htmlになります。
  - baseURL: https://:3000/foo/で./bar.htmlにナビゲートすると、https://:3000/foo/bar.htmlになります。
  - baseURL: https://:3000/foo（末尾にスラッシュなし）で./bar.htmlにナビゲートすると、https://:3000/bar.htmlになります。
- bypassCSP boolean (optional)#
  
  ページのコンテンツセキュリティポリシーをバイパスするかどうかを切り替えます。デフォルトはfalseです。
- channel string (optional)#
  
  ブラウザ配布チャネル。
  
  新しいヘッドレスモードにオプトインするには"chromium"を使用します。
  
  ブランドのGoogle ChromeおよびMicrosoft Edgeを使用するには、"chrome", "chrome-beta", "chrome-dev", "chrome-canary", "msedge", "msedge-beta", "msedge-dev", または "msedge-canary"を使用します。
- chromiumSandbox boolean (optional)#
  
  Chromiumサンドボックスを有効にします。デフォルトはfalseです。
- clientCertificates Array<Object> (optional)追加されたバージョン: 1.46#
  - origin string
    
    証明書が有効な正確なオリジン。オリジンにはhttpsプロトコル、ホスト名、オプションでポートが含まれます。
  - certPath string (optional)
    
    PEM形式の証明書ファイルへのパス。
  - cert Buffer (optional)
    
    PEM形式の証明書の直接値。
  - keyPath string (optional)
    
    PEM形式の秘密鍵ファイルへのパス。
  - key Buffer (optional)
    
    PEM形式の秘密鍵の直接値。
  - pfxPath string (optional)
    
    PFXまたはPKCS12形式でエンコードされた秘密鍵と証明書チェーンへのパス。
  - pfx Buffer (optional)
    
    PFXまたはPKCS12形式でエンコードされた秘密鍵と証明書チェーンの直接値。
  - passphrase string (optional)
    
    秘密鍵（PEMまたはPFX）のパスフレーズ。
  TLSクライアント認証により、サーバーはクライアント証明書を要求し、それを検証できます。
  
  詳細
  
  使用するクライアント証明書の配列。各証明書オブジェクトは、certPathとkeyPathの両方、単一のpfxPath、またはそれらに対応する直接値（certとkey、またはpfx）のいずれかを持っている必要があります。オプションで、証明書が暗号化されている場合はpassphraseプロパティを提供する必要があります。originプロパティは、証明書が有効なリクエストオリジンと正確に一致するように提供する必要があります。
  
  クライアント証明書認証は、少なくとも1つのクライアント証明書が提供された場合にのみ有効になります。サーバーから送信されたすべてのクライアント証明書を拒否したい場合は、訪問する予定のドメインのいずれとも一致しないoriginを持つクライアント証明書を提供する必要があります。
  
  注
  macOSでWebKitを使用している場合、localhostにアクセスしてもクライアント証明書は取得されません。localhostをlocal.playwrightに置き換えることで機能させることができます。
- colorScheme null | "light" | "dark" | "no-preference" (optional)#
  
  prefers-colors-schemeメディア機能をエミュレートします。サポートされている値は'light'と'dark'です。詳細についてはpage.emulateMedia()を参照してください。nullを渡すと、エミュレーションがシステムデフォルトにリセットされます。デフォルトは'light'です。
- contrast null | "no-preference" | "more" (optional)#
  
  'prefers-contrast'メディア機能をエミュレートします。サポートされている値は'no-preference'、'more'です。詳細についてはpage.emulateMedia()を参照してください。nullを渡すと、エミュレーションがシステムデフォルトにリセットされます。デフォルトは'no-preference'です。
- deviceScaleFactor number (optional)#
  
  デバイスのスケールファクタ（dprと考えることができます）を指定します。デフォルトは1です。デバイススケールファクタによるデバイスエミュレーションについて詳しく学びましょう。
- devtools boolean (optional)#
  
  非推奨
  代わりにデバッグツールを使用してください。
  
  Chromiumのみ 各タブのデベロッパーツールパネルを自動的に開くかどうか。このオプションがtrueの場合、headlessオプションはfalseに設定されます。
- downloadsPath string (optional)#
  
  指定されている場合、受け入れられたダウンロードはこのディレクトリにダウンロードされます。そうでない場合、一時ディレクトリが作成され、ブラウザが閉じられると削除されます。いずれの場合も、ダウンロードは作成されたブラウザコンテキストが閉じられると削除されます。
- env Object<string, string | number | boolean> (optional)#
  
  ブラウザに表示される環境変数を指定します。デフォルトはprocess.envです。
- executablePath string (optional)#
  
  バンドルされたブラウザの代わりに実行するブラウザ実行ファイルへのパス。executablePathが相対パスの場合、現在の作業ディレクトリを基準に解決されます。PlaywrightはバンドルされたChromium、Firefox、またはWebKitでのみ動作することに注意し、自己責任で使用してください。
- extraHTTPHeaders Object<string, string> (optional)#
  
  すべてのリクエストと一緒に送信される追加のHTTPヘッダーを含むオブジェクト。デフォルトはなし。
- firefoxUserPrefs Object<string, string | number | boolean> (optional)追加されたバージョン: v1.40#
  
  Firefoxのユーザー設定。Firefoxのユーザー設定の詳細については、about:configを参照してください。
  
  カスタムのpolicies.jsonファイルへのパスをPLAYWRIGHT_FIREFOX_POLICIES_JSON環境変数経由で提供することもできます。
- forcedColors null | "active" | "none" (optional)#
  
  'forced-colors'メディア機能をエミュレートします。サポートされている値は'active'、'none'です。詳細についてはpage.emulateMedia()を参照してください。nullを渡すと、エミュレーションがシステムデフォルトにリセットされます。デフォルトは'none'です。
- geolocation Object (optional)#
  - latitude number
    
    -90から90の間の緯度。
  - longitude number
    
    -180から180の間の経度。
  - accuracy number (optional)
    
    非負の精度値。デフォルトは0です。
- handleSIGHUP boolean (optional)#
  
  SIGHUPでブラウザプロセスを閉じます。デフォルトはtrueです。
- handleSIGINT boolean (optional)#
  
  Ctrl-Cでブラウザプロセスを閉じます。デフォルトはtrueです。
- handleSIGTERM boolean (optional)#
  
  SIGTERMでブラウザプロセスを閉じます。デフォルトはtrueです。
- hasTouch boolean (optional)#
  
  ビューポートがタッチイベントをサポートするかどうかを指定します。デフォルトはfalseです。モバイルエミュレーションについて詳しく学びましょう。
- headless boolean (optional)#
  
  ブラウザをヘッドレスモードで実行するかどうか。ChromiumとFirefoxの詳細。デフォルトはtrueですが、devtoolsオプションがtrueの場合はfalseになります。
- httpCredentials Object (optional)#
  - username string
  - password string
  - origin string (optional)
    
    特定のオリジン(scheme://host:port)でのhttp資格情報の送信を制限します:ポート).
  - send "unauthorized" | "always" (optional)
    
    このオプションは、対応するAPIRequestContextから送信されたリクエストにのみ適用され、ブラウザから送信されたリクエストには影響しません。'always' - 基本認証資格情報を含むAuthorizationヘッダーは、各APIリクエストとともに送信されます。'unauthorized - 資格情報は、WWW-Authenticateヘッダーを持つ401（Unauthorized）応答が受信された場合にのみ送信されます。デフォルトは'unauthorized'です。
  HTTP認証用の資格情報。オリジンが指定されていない場合、ユーザー名とパスワードは、不正な応答があった場合にすべてのサーバーに送信されます。
- ignoreDefaultArgs boolean | Array<string> (optional)#
  
  trueの場合、Playwrightは独自の構成引数を渡さず、argsからの引数のみを使用します。配列が与えられた場合、指定されたデフォルト引数をフィルタリングします。危険なオプションなので、注意して使用してください。デフォルトはfalseです。
- ignoreHTTPSErrors boolean (optional)#
  
  ネットワークリクエストを送信する際にHTTPSエラーを無視するかどうか。デフォルトはfalseです。
- isMobile boolean (optional)#
  
  meta viewportタグが考慮され、タッチイベントが有効になるかどうか。isMobileはデバイスの一部なので、手動で設定する必要はありません。デフォルトはfalseで、Firefoxではサポートされていません。モバイルエミュレーションについて詳しく学びましょう。
- javaScriptEnabled boolean (optional)#
  
  コンテキストでJavaScriptを有効にするかどうか。デフォルトはtrueです。JavaScriptの無効化について詳しく学びましょう。
- locale string (optional)#
  
  ユーザーロケールを指定します。例: en-GB, de-DEなど。ロケールはnavigator.languageの値、Accept-Languageリクエストヘッダーの値、および数値と日付のフォーマット規則に影響します。デフォルトはシステムのデフォルトロケールです。エミュレーションガイドでエミュレーションの詳細について学びましょう。
- logger Logger (optional)#
  
  非推奨
  ロガーによって受信されるログは不完全です。代わりにトレースを使用してください。
  
  Playwrightログ用のロガーシンク。
- offline boolean (optional)#
  
  ネットワークがオフラインであるとエミュレートするかどうか。デフォルトはfalseです。ネットワークエミュレーションについて詳しく学びましょう。
- permissions Array<string> (optional)#
  
  このコンテキストのすべてのページに付与する権限のリスト。詳細についてはbrowserContext.grantPermissions()を参照してください。デフォルトはなしです。
- proxy Object (optional)#
  - server string
    
    すべてのリクエストに使用するプロキシ。HTTPおよびSOCKSプロキシがサポートされており、例としてhttp://myproxy.com:3128またはsocks5://myproxy.com:3128があります。短縮形myproxy.com:3128はHTTPプロキシと見なされます。
  - bypass string (optional)
    
    プロキシをバイパスするオプションのカンマ区切りドメイン。例: ".com, chromium.org, .domain.com"。
  - username string (optional)
    
    HTTPプロキシが認証を必要とする場合に使用するオプションのユーザー名。
  - password string (optional)
    
    HTTPプロキシが認証を必要とする場合に使用するオプションのパスワード。
  ネットワークプロキシ設定。
- recordHar Object (optional)#
  - omitContent boolean (optional)
    
    HARからリクエストコンテンツを省略するかどうかを制御するオプションの設定。デフォルトはfalseです。非推奨、代わりにcontentポリシーを使用してください。
  - content "omit" | "embed" | "attach" (optional)
    
    リソースコンテンツ管理を制御するオプション設定。omitが指定されている場合、コンテンツは永続化されません。attachが指定されている場合、リソースは個別のファイルまたはZIPアーカイブのエントリとして永続化されます。embedが指定されている場合、HAR仕様に従ってコンテンツはHARファイルにインラインで保存されます。.zip出力ファイルの場合はデフォルトでattach、その他のすべてのファイル拡張子の場合はembedです。
  - path string
    
    HARファイルを書き込むファイルシステム上のパス。ファイル名が.zipで終わる場合、デフォルトでcontent: 'attach'が使用されます。
  - mode "full" | "minimal" (optional)
    
    minimalに設定すると、HARからのルーティングに必要な情報のみが記録されます。これにより、HARからリプレイするときに使用されないサイズ、タイミング、ページ、クッキー、セキュリティ、その他の種類のHAR情報が省略されます。デフォルトはfullです。
  - urlFilter string | RegExp (optional)
    
    HARに保存されるリクエストをフィルタリングするためのグロブまたは正規表現パターン。コンテキストオプション経由でbaseURLが提供され、渡されたURLがパスである場合、new URL()コンストラクタ経由でマージされます。デフォルトはなし。
  すべてのページのHAR記録をrecordHar.pathファイルに有効にします。指定されていない場合、HARは記録されません。HARが保存されるようにbrowserContext.close()を待機していることを確認してください。
- recordVideo Object (optional)#
  - dir string
    
    ビデオを保存するディレクトリへのパス。
  - size Object (optional)
    - width number
      
      ビデオフレームの幅。
    - height number
      
      ビデオフレームの高さ。
    記録されたビデオのオプションの寸法。指定されていない場合、サイズは800x800に収まるようにスケールダウンされたviewportと等しくなります。viewportが明示的に構成されていない場合、ビデオサイズはデフォルトで800x450になります。必要に応じて、各ページの実際の画像は指定されたサイズに収まるようにスケールダウンされます。
  すべてのページのビデオ録画をrecordVideo.dirディレクトリに有効にします。指定されていない場合、ビデオは記録されません。ビデオが保存されるようにbrowserContext.close()を待機していることを確認してください。
- reducedMotion null | "reduce" | "no-preference" (optional)#
  
  'prefers-reduced-motion'メディア機能をエミュレートします。サポートされている値は'reduce'、'no-preference'です。詳細についてはpage.emulateMedia()を参照してください。nullを渡すと、エミュレーションがシステムデフォルトにリセットされます。デフォルトは'no-preference'です。
- screen Object (optional)#
  - width number
    
    ページ幅（ピクセル単位）。
  - height number
    
    ページ高さ（ピクセル単位）。
  ウェブページ内でwindow.screen経由で利用可能な一貫したウィンドウ画面サイズをエミュレートします。viewportが設定されている場合にのみ使用されます。
- serviceWorkers "allow" | "block" (optional)#
  
  サイトがサービスワーカーを登録することを許可するかどうか。デフォルトは'allow'です。
  - 'allow': サービスワーカーを登録できます。
  - 'block': Playwrightはすべてのサービスワーカーの登録をブロックします。
- slowMo number (optional)#
  
  Playwrightの操作を、指定されたミリ秒数だけ遅らせます。何が起こっているかを確認するのに役立ちます。
- strictSelectors boolean (optional)#
  
  trueに設定すると、このコンテキストに対して厳格セレクタモードが有効になります。厳格セレクタモードでは、単一のターゲットDOM要素を意味するセレクタに対するすべての操作は、複数の要素がセレクタに一致する場合にスローされます。このオプションはLocator APIには影響しません（Locatorsは常に厳格です）。デフォルトはfalseです。厳格モードの詳細については、Locatorを参照してください。
- timeout number (optional)#
  
  ブラウザインスタンスが起動するまで待機する最大時間（ミリ秒単位）。デフォルトは30000（30秒）です。タイムアウトを無効にするには0を渡します。
- timezoneId string (optional)#
  
  コンテキストのタイムゾーンを変更します。サポートされているタイムゾーンIDのリストについては、ICUのmetaZones.txtを参照してください。デフォルトはシステムのタイムゾーンです。
- tracesDir string (optional)#
  
  指定されている場合、トレースはこのディレクトリに保存されます。
- userAgent string (optional)#
  
  このコンテキストで使用する特定のユーザーエージェント。
- videoSize Object (optional)#
  
  非推奨
  代わりにrecordVideoを使用してください。
  - width number
    
    ビデオフレームの幅。
  - height number
    
    ビデオフレームの高さ。
- videosPath string (optional)#
  
  非推奨
  代わりにrecordVideoを使用してください。
- viewport null | Object (optional)#
  - width number
    
    ページ幅（ピクセル単位）。
  - height number
    
    ページ高さ（ピクセル単位）。
  各ページの一貫したビューポートをエミュレートします。デフォルトは1280x720ビューポートです。一貫したビューポートエミュレーションを無効にするにはnullを使用します。ビューポートエミュレーションについて詳しく学びましょう。
  
  注
  null値はデフォルトのプリセットからオプトアウトし、ビューポートをオペレーティングシステムによって定義されるホストウィンドウサイズに依存させます。これにより、テストの実行が非決定論的になります。

戻り値

Promise<BrowserContext>#

launchServer

v1.9より前に追加

browserType.launchServer

ブラウザアプリインスタンスを返します。browserType.connect()経由で接続できます。これには、クライアント/サーバーのメジャー/マイナーバージョンが一致する必要があります (1.2.3 → 1.2.xと互換性があります)。

使用法

クライアントが接続できるブラウザサーバーを起動します。ブラウザ実行ファイルを起動して後で接続する例

const { chromium } = require('playwright');  // Or 'webkit' or 'firefox'.

(async () => {
  const browserServer = await chromium.launchServer();
  const wsEndpoint = browserServer.wsEndpoint();
  // Use web socket endpoint later to establish a connection.
  const browser = await chromium.connect(wsEndpoint);
  // Close browser instance.
  await browserServer.close();
})();

引数

options Object (optional)
- args Array<string> (optional)#
  
  警告
  一部のカスタムブラウザ引数はPlaywrightの機能を破壊する可能性があるため、自己責任で使用してください。
  
  ブラウザインスタンスに渡す追加の引数。Chromiumフラグのリストはこちらで見つけることができます。
- channel string (optional)#
  
  ブラウザ配布チャネル。
  
  新しいヘッドレスモードにオプトインするには"chromium"を使用します。
  
  ブランドのGoogle ChromeおよびMicrosoft Edgeを使用するには、"chrome", "chrome-beta", "chrome-dev", "chrome-canary", "msedge", "msedge-beta", "msedge-dev", または "msedge-canary"を使用します。
- chromiumSandbox boolean (optional)#
  
  Chromiumサンドボックスを有効にします。デフォルトはfalseです。
- devtools boolean (optional)#
  
  非推奨
  代わりにデバッグツールを使用してください。
  
  Chromiumのみ 各タブのデベロッパーツールパネルを自動的に開くかどうか。このオプションがtrueの場合、headlessオプションはfalseに設定されます。
- downloadsPath string (optional)#
  
  指定されている場合、受け入れられたダウンロードはこのディレクトリにダウンロードされます。そうでない場合、一時ディレクトリが作成され、ブラウザが閉じられると削除されます。いずれの場合も、ダウンロードは作成されたブラウザコンテキストが閉じられると削除されます。
- env Object<string, string | number | boolean> (optional)#
  
  ブラウザに表示される環境変数を指定します。デフォルトはprocess.envです。
- executablePath string (optional)#
  
  バンドルされたブラウザの代わりに実行するブラウザ実行ファイルへのパス。executablePathが相対パスの場合、現在の作業ディレクトリを基準に解決されます。PlaywrightはバンドルされたChromium、Firefox、またはWebKitでのみ動作することに注意し、自己責任で使用してください。
- firefoxUserPrefs Object<string, string | number | boolean> (optional)#
  
  Firefoxのユーザー設定。Firefoxのユーザー設定の詳細については、about:configを参照してください。
  
  カスタムのpolicies.jsonファイルへのパスをPLAYWRIGHT_FIREFOX_POLICIES_JSON環境変数経由で提供することもできます。
- handleSIGHUP boolean (optional)#
  
  SIGHUPでブラウザプロセスを閉じます。デフォルトはtrueです。
- handleSIGINT boolean (optional)#
  
  Ctrl-Cでブラウザプロセスを閉じます。デフォルトはtrueです。
- handleSIGTERM boolean (optional)#
  
  SIGTERMでブラウザプロセスを閉じます。デフォルトはtrueです。
- headless boolean (optional)#
  
  ブラウザをヘッドレスモードで実行するかどうか。ChromiumとFirefoxの詳細。デフォルトはtrueですが、devtoolsオプションがtrueの場合はfalseになります。
- host string (optional)追加されたバージョン: v1.45#
  
  ウェブソケットに使用するホスト。オプションであり、省略された場合、サーバーはIPv6が利用可能な場合は指定されていないIPv6アドレス（::）で、それ以外の場合は指定されていないIPv4アドレス（0.0.0.0）で接続を受け入れます。特定のインターフェースを選択して強化することを検討してください。
- ignoreDefaultArgs boolean | Array<string> (optional)#
  
  trueの場合、Playwrightは独自の構成引数を渡さず、argsからの引数のみを使用します。配列が与えられた場合、指定されたデフォルト引数をフィルタリングします。危険なオプションなので、注意して使用してください。デフォルトはfalseです。
- logger Logger (optional)#
  
  非推奨
  ロガーによって受信されるログは不完全です。代わりにトレースを使用してください。
  
  Playwrightログ用のロガーシンク。
- port number (optional)#
  
  ウェブソケットに使用するポート。デフォルトは0で、利用可能なポートを任意に選択します。
- proxy Object (optional)#
  - server string
    
    すべてのリクエストに使用するプロキシ。HTTPおよびSOCKSプロキシがサポートされており、例としてhttp://myproxy.com:3128またはsocks5://myproxy.com:3128があります。短縮形myproxy.com:3128はHTTPプロキシと見なされます。
  - bypass string (optional)
    
    プロキシをバイパスするオプションのカンマ区切りドメイン。例: ".com, chromium.org, .domain.com"。
  - username string (optional)
    
    HTTPプロキシが認証を必要とする場合に使用するオプションのユーザー名。
  - password string (optional)
    
    HTTPプロキシが認証を必要とする場合に使用するオプションのパスワード。
  ネットワークプロキシ設定。
- timeout number (optional)#
  
  ブラウザインスタンスが起動するまで待機する最大時間（ミリ秒単位）。デフォルトは30000（30秒）です。タイムアウトを無効にするには0を渡します。
- tracesDir string (optional)#
  
  指定されている場合、トレースはこのディレクトリに保存されます。
- wsPath string (optional)追加されたバージョン: v1.15#
  
  ブラウザサーバーをサービスするパス。セキュリティのため、これはデフォルトで推測不可能な文字列になります。
  
  警告
  wsPathを知っているプロセスまたはウェブページ（Playwrightで実行されているものも含む）は、OSユーザーを制御できます。このため、このオプションを使用する場合は、推測不可能なトークンを使用する必要があります。

戻り値

Promise<BrowserServer>#

name

v1.9より前に追加

browserType.name

ブラウザ名を返します。例えば、'chromium'、'webkit'、または'firefox'です。

使用法

browserType.name();

戻り値

string #

メソッド​

connect​

connectOverCDP​

executablePath​

launch​

launchPersistentContext​

launchServer​

name​

メソッド

connect

connectOverCDP

executablePath

launch

launchPersistentContext

launchServer

name