APIリファレンス
クラス
| クラス | 説明 |
|---|---|
| Accessibility | Accessibilityクラスは、ブラウザのアクセシビリティツリーを検査するためのメソッドを提供します。アクセシビリティツリーは、スクリーンリーダーやスイッチなどの支援技術で使用されます。 |
| Browser | Browserは、以下のいずれかによって接続されたブラウザインスタンスを表します。 - Puppeteer.connect()経由で接続された、または- PuppeteerNode.launch()によって起動された。 Browserは、BrowserEvent enumにドキュメント化されている様々なイベントを発行します。 |
| BrowserContext | BrowserContextは、ブラウザ内の個々のユーザーコンテキストを表します。 ブラウザが起動されると、デフォルトで単一のブラウザコンテキストを持ちます。他のコンテキストは、Browser.createBrowserContext()を使用して作成できます。各コンテキストは、隔離されたストレージ（cookie/localStorageなど）を持ちます。 BrowserContextは、BrowserContextEvent enumにドキュメント化されている様々なイベントを発行します。 ページが |
| CDPSession | CDPSessionインスタンスは、生のChrome Devtools Protocolと通信するために使用されます。 |
| Connection | |
| ConsoleMessage | ConsoleMessageオブジェクトは、「console」イベントを介してページによってディスパッチされます。 |
| Coverage | Coverageクラスは、ページで使用されたJavaScriptおよびCSSの部分に関する情報を収集するためのメソッドを提供します。 |
| CSSCoverage | |
| DeviceRequestPrompt | デバイスリクエストプロンプトを使用すると、WebBluetoothのようなAPIを介してデバイスを要求するページに応答できます。 |
| DeviceRequestPromptDevice | リクエストプロンプト内のデバイス。 |
| Dialog | Dialogインスタンスは、dialogイベントを介してPageによってディスパッチされます。 |
| ElementHandle | ElementHandleは、ページ内のDOM要素を表します。 |
| EventEmitter | 多くのPuppeteerクラスが拡張するEventEmitterクラス。 |
| FileChooser | ファイル選択ツールを使用すると、ファイルを要求するページに応答できます。 |
| Frame | DOMフレームを表します。 フレームを理解するために、フレームを |
| HTTPRequest | ページによって送信されたHTTPリクエストを表します。 |
| HTTPResponse | HTTPResponseクラスは、Pageクラスによって受信される応答を表します。 |
| JSCoverage | |
| JSHandle | JavaScriptオブジェクトへの参照を表します。インスタンスは、Page.evaluateHandle()を使用して作成できます。 ハンドルは、ハンドルが意図的に破棄されない限り、参照されているJavaScriptオブジェクトがガベージコレクションされるのを防ぎます。JSHandleは、関連付けられたフレームがナビゲートされたり、親コンテキストが破棄されたりすると、自動的に破棄されます。 ハンドルは、Page.$eval()、Page.evaluate()、Page.evaluateHandle()などの評価関数の引数として使用できます。それらは、参照されているオブジェクトに解決されます。 |
| Keyboard | Keyboardは、仮想キーボードを管理するためのAPIを提供します。高レベルAPIは、生の文字を受け取り、ページ上で適切なkeydown、keypress/input、およびkeyupイベントを生成するKeyboard.type()です。 |
| Locator | Locatorは、オブジェクトを特定し、オブジェクトに対してアクションを実行する戦略を記述します。アクションの準備ができていないためにアクションが失敗した場合、操作全体が再試行されます。アクションが成功するためのさまざまな前提条件が自動的にチェックされます。 |
| Mouse | Mouseクラスは、ビューポートの左上隅を基準としたメインフレームCSSピクセルで動作します。 |
| Page | Pageは、ブラウザの単一のタブまたは拡張機能のバックグラウンドページと対話するためのメソッドを提供します。 :::note 1つのBrowserインスタンスに複数のPageインスタンスが存在する可能性があります。 ::: |
| ProductLauncher | ランチャーを記述します。これは、ブラウザインスタンスを作成して起動できるクラスです。 |
| ProtocolError | ProtocolErrorは、プロトコルからのエラーが発生するたびに発行されます。 |
| Puppeteer | メインのPuppeteerクラス。 重要: Node環境でPuppeteerを使用している場合は、 |
| PuppeteerError | すべてのPuppeteer固有のエラーの基本クラス |
| PuppeteerNode | ブラウザの取得とダウンロードのためにNode固有の動作でメインのPuppeteerクラスを拡張します。 Node環境でPuppeteerを使用している場合、 |
| ScreenRecorder | |
| SecurityDetails | SecurityDetailsクラスは、セキュア接続を介して受信された応答のセキュリティ詳細を表します。 |
| Target | Targetは、CDPターゲットを表します。CDPでは、ターゲットは、フレーム、ページ、またはワーカーなど、デバッグ可能なものです。 |
| TimeoutError | TimeoutErrorは、タイムアウトが原因で特定の操作が終了するたびに発行されます。 |
| Touchscreen | Touchscreenクラスは、タッチスクリーンイベントを公開します。 |
| Tracing | Tracingクラスは、トレース監査インターフェースを公開します。 |
| UnsupportedOperation | Puppeteerは、現在使用されているプロトコルでメソッドがサポートされていない場合、このエラーをスローします |
| WebWorker | このクラスは、WebWorkerを表します。 |
列挙型
| 列挙型 | 説明 |
|---|---|
| BrowserContextEvent | |
| BrowserEvent | ブラウザインスタンスが発行する可能性のあるすべてのイベント。 |
| InterceptResolutionAction | |
| LocatorEvent | ロケーターインスタンスが発行する可能性のあるすべてのイベント。 |
| PageEvent | ページインスタンスが発行する可能性のあるすべてのイベント。 |
| TargetType |
関数
インターフェース
名前空間
| 名前空間 | 説明 |
|---|---|
| CDPSessionEvent | CDPSessionクラスが発行するイベント。 |
変数
| 変数 | 説明 |
|---|---|
| DEFAULT_INTERCEPT_RESOLUTION_PRIORITY | デフォルトの協調リクエストインターセプト解決優先度 |
| KnownDevices | Page.emulate()で使用するデバイスのリスト。 |
| MouseButton | 有効なマウスボタンのEnum。 |
| PredefinedNetworkConditions | Page.emulateNetworkConditions()で使用するネットワーク条件のリスト。 |
| puppeteer |