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 (オプション)
- 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. localhost ネットワークを公開するには "<loopback>"。
  3. テスト/ステージングのデプロイと localhost を公開するには "*.test.internal-domain,*.staging.internal-domain,<loopback>"。
- 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('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 (オプション)
- 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

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

使用方法

ignoreDefaultArgs を使用して、デフォルトの引数から --mute-audio を除外できます。

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 のユーザー設定。about:config で Firefox のユーザー設定の詳細を確認してください。
- 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: 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 (オプション)#
  
  ページの 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> (オプション)追加日: 1.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 ヘッダーを含むオブジェクト。デフォルトはなしです。
- firefoxUserPrefs Object<string, string | number | boolean> (オプション)追加日: v1.40#
  
  Firefox のユーザー設定。about:config で Firefox のユーザー設定の詳細を確認してください。
- forcedColors null | "active" | "none" (オプション)#
  
  'forced-colors' メディア機能をエミュレートします。サポートされる値は 'active', 'none' です。詳細については page.emulateMedia() を参照してください。null を渡すと、エミュレーションがシステムデフォルトにリセットされます。デフォルトは 'none' です。
- geolocation Object (オプション)#
  - latitude number
    
    -90 から 90 の間の緯度。
  - longitude number
    
    -180 から 180 の間の経度。
  - accuracy number (オプション)
    
    非負の精度値。デフォルトは 0 です。
- handleSIGHUP boolean (オプション)#
  
  SIGHUP でブラウザプロセスを閉じます。デフォルトは true です。
- handleSIGINT boolean (オプション)#
  
  Ctrl-C でブラウザプロセスを閉じます。デフォルトは true です。
- handleSIGTERM boolean (オプション)#
  
  SIGTERM でブラウザプロセスを閉じます。デフォルトは true です。
- hasTouch boolean (オプション)#
  
  ビューポートがタッチイベントをサポートするかどうかを指定します。デフォルトは false です。モバイルエミュレーションの詳細。
- headless boolean (オプション)#
  
  ブラウザをヘッドレスモードで実行するかどうか。Chromium と Firefox の詳細。デフォルトは true ですが、devtools オプションが true の場合は除きます。
- httpCredentials Object (オプション)#
  - username string
  - password string
  - origin string (オプション)
    
    特定のオリジン (scheme://host) で HTTP 認証情報の送信を制限します。:ポート).
  - send "unauthorized" | "always" (オプション)
    
    このオプションは、対応する APIRequestContext から送信されたリクエストにのみ適用され、ブラウザから送信されたリクエストには影響しません。'always' - 各 API リクエストとともに基本認証資格情報を含む Authorization ヘッダーが送信されます。'unauthorized' - 資格情報は、WWW-Authenticate ヘッダーを含む 401 (Unauthorized) レスポンスが受信された場合にのみ送信されます。デフォルトは 'unauthorized' です。
  HTTP 認証の資格情報。オリジンが指定されていない場合、ユーザー名とパスワードは、不正な応答があった場合に任意のサーバーに送信されます。
- ignoreDefaultArgs boolean | Array<string> (オプション)#
  
  true の場合、Playwright は自身の構成引数を渡さず、args からの引数のみを使用します。配列が指定された場合、指定されたデフォルト引数をフィルターで除外します。危険なオプションですので、注意して使用してください。デフォルトは false です。
- ignoreHTTPSErrors boolean (オプション)#
  
  ネットワークリクエストを送信する際に HTTPS エラーを無視するかどうか。デフォルトは false です。
- isMobile boolean (オプション)#
  
  meta viewport タグが考慮され、タッチイベントが有効になるかどうか。isMobile はデバイスの一部であるため、手動で設定する必要はありません。デフォルトは false で、Firefox ではサポートされていません。モバイルエミュレーションの詳細。
- javaScriptEnabled boolean (オプション)#
  
  コンテキストで JavaScript を有効にするかどうか。デフォルトは true です。JavaScript を無効にする方法の詳細。
- locale string (オプション)#
  
  ユーザーロケールを指定します。例: en-GB, de-DE など。ロケールは navigator.language の値、Accept-Language リクエストヘッダーの値、および数値と日付の書式設定ルールに影響します。デフォルトはシステムデフォルトのロケールです。エミュレーションガイドでエミュレーションの詳細を確認してください。
- logger Logger (オプション)#
  
  Playwright のロギング用ロガーシンク。
- offline boolean (オプション)#
  
  ネットワークがオフラインであるかのようにエミュレートするかどうか。デフォルトは false です。ネットワークエミュレーションの詳細。
- permissions Array<string> (オプション)#
  
  このコンテキスト内のすべてのページに付与する権限のリスト。詳細については browserContext.grantPermissions() を参照してください。デフォルトはなしです。
- 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 プロキシで認証が必要な場合に使用するオプションのパスワード。
  ネットワークプロキシ設定。
- recordHar Object (オプション)#
  - omitContent boolean (オプション)
    
    HAR からリクエストコンテンツを省略するかどうかを制御するオプション設定。デフォルトは false です。非推奨。代わりに content ポリシーを使用してください。
  - content "omit" | "embed" | "attach" (オプション)
    
    リソースコンテンツ管理を制御するオプション設定。omit が指定された場合、コンテンツは永続化されません。attach が指定された場合、リソースは個別のファイルまたは ZIP アーカイブのエントリとして永続化されます。embed が指定された場合、HAR 仕様に従ってコンテンツは HAR ファイル内にインラインで保存されます。.zip 出力ファイルの場合はデフォルトで attach、その他のすべてのファイル拡張子の場合は embed です。
  - path string
    
    HAR ファイルを書き込むファイルシステム上のパス。ファイル名が .zip で終わる場合、デフォルトで content: 'attach' が使用されます。
  - mode "full" | "minimal" (オプション)
    
    minimal に設定すると、HAR からのルーティングに必要な情報のみが記録されます。これにより、HAR からのリプレイ時に使用されないサイズ、タイミング、ページ、Cookie、セキュリティ、その他の種類の HAR 情報が省略されます。デフォルトは full です。
  - urlFilter string | RegExp (オプション)
    
    HAR に保存されるリクエストをフィルタリングするための glob または正規表現パターン。コンテキストオプションを介して baseURL が提供され、渡された URL がパスである場合、new URL() コンストラクタを介してマージされます。デフォルトはなしです。
  recordHar.path ファイルへのすべてのページの HAR 記録を有効にします。指定されていない場合、HAR は記録されません。HAR を保存するには browserContext.close() を待機してください。
- recordVideo Object (オプション)#
  - dir string
    
    ビデオを保存するディレクトリへのパス。
  - size Object (オプション)
    - width number
      
      ビデオフレームの幅。
    - height number
      
      ビデオフレームの高さ。
    記録されるビデオのオプションの寸法。指定されていない場合、サイズは viewport を 800x800 に収まるように縮小したものと等しくなります。viewport が明示的に設定されていない場合、ビデオサイズはデフォルトで 800x450 になります。各ページの実際の画像は、必要に応じて指定されたサイズに収まるように縮小されます。
  recordVideo.dir ディレクトリへのすべてのページのビデオ記録を有効にします。指定されていない場合、ビデオは記録されません。ビデオを保存するには browserContext.close() を待機してください。
- reducedMotion null | "reduce" | "no-preference" (オプション)#
  
  'prefers-reduced-motion' メディア機能をエミュレートします。サポートされる値は 'reduce', 'no-preference' です。詳細については page.emulateMedia() を参照してください。null を渡すと、エミュレーションがシステムデフォルトにリセットされます。デフォルトは 'no-preference' です。
- screen Object (オプション)#
  - width number
    
    ページの幅 (ピクセル単位)。
  - height number
    
    ページの高さ (ピクセル単位)。
  window.screen を介してウェブページ内で利用可能な一貫したウィンドウ画面サイズをエミュレートします。viewport が設定されている場合にのみ使用されます。
- serviceWorkers "allow" | "block" (オプション)#
  
  サイトがサービスワーカーを登録することを許可するかどうか。デフォルトは 'allow' です。
  - 'allow': サービスワーカーを登録できます。
  - 'block': Playwright はサービスワーカーのすべての登録をブロックします。
- slowMo number (オプション)#
  
  指定されたミリ秒単位で Playwright の操作を遅延させます。何が起こっているかを確認するのに役立ちます。
- strictSelectors boolean (オプション)#
  
  true に設定すると、このコンテキストで厳格セレクターモードが有効になります。厳格セレクターモードでは、単一のターゲット DOM 要素を意味するセレクターに対するすべての操作は、複数の要素がセレクターに一致する場合に例外をスローします。このオプションは Locator API には影響しません (Locator は常に厳格です)。デフォルトは false です。Locator で厳格モードの詳細を確認してください。
- timeout number (オプション)#
  
  ブラウザインスタンスが起動するまでの最大待機時間 (ミリ秒単位)。デフォルトは 30000 (30秒) です。0 を渡すとタイムアウトが無効になります。
- timezoneId string (オプション)#
  
  コンテキストのタイムゾーンを変更します。サポートされているタイムゾーン ID のリストについては ICU の metaZones.txt を参照してください。デフォルトはシステムのタイムゾーンです。
- tracesDir string (オプション)#
  
  指定された場合、トレースはこのディレクトリに保存されます。
- userAgent string (オプション)#
  
  このコンテキストで使用する特定のユーザーエージェント。
- videoSize Object (オプション)#
  
  非推奨
  代わりに recordVideo を使用してください。
  - width number
    
    ビデオフレームの幅。
  - height number
    
    ビデオフレームの高さ。
- videosPath string (オプション)#
  
  非推奨
  代わりに recordVideo を使用してください。
- viewport null | Object (オプション)#
  - 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 (オプション)
- 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 のユーザー設定。about:config で Firefox のユーザー設定の詳細を確認してください。
- handleSIGHUP boolean (オプション)#
  
  SIGHUP でブラウザプロセスを閉じます。デフォルトは true です。
- handleSIGINT boolean (オプション)#
  
  Ctrl-C でブラウザプロセスを閉じます。デフォルトは true です。
- handleSIGTERM boolean (オプション)#
  
  SIGTERM でブラウザプロセスを閉じます。デフォルトは true です。
- headless boolean (オプション)#
  
  ブラウザをヘッドレスモードで実行するかどうか。Chromium と Firefox の詳細。デフォルトは true ですが、devtools オプションが true の場合は除きます。
- host string (オプション)追加日: v1.45#
  
  ウェブソケットに使用するホスト。これはオプションであり、省略された場合、サーバーは IPv6 が利用可能な場合は未指定の IPv6 アドレス (::) で、それ以外の場合は未指定の IPv4 アドレス (0.0.0.0) で接続を受け入れます。特定のインターフェースを選択して強化することを検討してください。
- ignoreDefaultArgs boolean | Array<string> (オプション)#
  
  true の場合、Playwright は自身の構成引数を渡さず、args からの引数のみを使用します。配列が指定された場合、指定されたデフォルト引数をフィルターで除外します。危険なオプションですので、注意して使用してください。デフォルトは false です。
- logger Logger (オプション)#
  
  Playwright のロギング用ロガーシンク。
- port number (オプション)#
  
  ウェブソケットに使用するポート。デフォルトは 0 で、利用可能な任意のポートを選択します。
- 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 プロキシで認証が必要な場合に使用するオプションのパスワード。
  ネットワークプロキシ設定。
- timeout number (オプション)#
  
  ブラウザインスタンスが起動するまでの最大待機時間 (ミリ秒単位)。デフォルトは 30000 (30秒) です。0 を渡すとタイムアウトが無効になります。
- tracesDir string (オプション)#
  
  指定された場合、トレースはこのディレクトリに保存されます。
- wsPath string (オプション)追加日: 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