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 stringv1.10 で追加#

接続先の Playwright ブラウザの WebSocket エンドポイント。このエンドポイントは BrowserServer.wsEndpoint を介して取得します。
options Object (オプション)
- exposeNetwork string (オプション)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. "<loopback>" localhost ネットワークを公開します。
  3. "*.test.internal-domain,*.staging.internal-domain,<loopback>" テスト/ステージング環境と localhost を公開します。
- headers Object<string, string> (オプション)v1.11 で追加#
  
  WebSocket 接続リクエストとともに送信される追加の HTTP ヘッダー。オプション。
- logger Logger (オプション)v1.14 で追加#
  
  Playwright ロギング用のロガーシンク。オプション。
- slowMo number (オプション)v1.10 で追加#
  
  指定されたミリ秒数だけ Playwright の操作を遅くします。何が起こっているかを確認するのに役立ちます。デフォルトは 0 です。
- timeout number (オプション)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('http://localhost:9222');
const defaultContext = browser.contexts()[0];
const page = defaultContext.pages()[0];

引数

endpointURL stringv1.11 で追加#

接続先の CDP WebSocket エンドポイントまたは HTTP URL。例：http://localhost:9222/ または ws://127.0.0.1:9222/devtools/browser/387adf4c-243f-4051-a181-46798f4a46f4。
options Object (オプション)
- endpointURL string (オプション)v1.14 で追加#
  
  非推奨。代わりに最初の引数を使用してください。オプション。
- headers Object<string, string> (オプション)v1.11 で追加#
  
  接続リクエストとともに送信される追加の HTTP ヘッダー。オプション。
- logger Logger (オプション)v1.14 で追加#
  
  Playwright ロギング用のロガーシンク。オプション。
- slowMo number (オプション)v1.11 で追加#
  
  指定されたミリ秒数だけ Playwright の操作を遅くします。何が起こっているかを確認するのに役立ちます。デフォルトは 0 です。
- timeout number (オプション)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 オプションは、細心の注意を払って使用してください。

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

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

引数

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

戻り値

Promise<Browser>#

launchPersistentContext

v1.9 より前に追加

browserType.launchPersistentContext

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

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

使用法

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

引数

userDataDir string #

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

戻り値

Promise<BrowserServer>#

name

v1.9 より前に追加

browserType.name

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

使用法

browserType.name();

戻り値

文字列 #

メソッド​

connect​

connectOverCDP​

executablePath​

launch​

launchPersistentContext​

launchServer​

name​

メソッド

connect

connectOverCDP

executablePath

launch

launchPersistentContext

launchServer

name