Playwright ネットワークと入力 API

この付録では、ネットワークリクエスト、キーボード、マウス、タッチ操作に関連する API を一覧にします。


Request クラス

メソッド説明
request.url()リクエストURL
request.method()リクエストメソッド(GET/POST など)
request.headers()リクエストヘッダー
request.postData()POST リクエストの body データ
request.postDataJSON()POST リクエストの JSON body
request.postDataBuffer()POST リクエストの Buffer body
request.isNavigationRequest()ナビゲーションリクエストかどうか
request.frame()リクエストを発行した Frame
request.redirectedFrom()リダイレクト元の Request
request.redirectedTo()リダイレクト先の Request
request.failure()リクエスト失敗情報(失敗がない場合は null を返す)
request.timing()リクエストのタイミング情報

Response クラス

メソッド説明
response.url()レスポンスURL
response.status()HTTPステータスコード
response.statusText()ステータステキスト
response.headers()レスポンスヘッダー
response.body()レスポンス body(Buffer)
response.text()レスポンス body(テキスト)
response.json()レスポンス body(JSON)
response.ok()ステータスコードが 200-299 の範囲にあるかどうか
response.request()対応する Request オブジェクト
response.frame()リクエストを発行した Frame

Route クラス

メソッド説明
route.abort(errorCode?)リクエストをブロックする
route.continue(options?)変更後にリクエストを続行する
route.fulfill(options?)カスタムレスポンスを返す
route.fetch(options?)実際にリクエストを送信してレスポンスを取得する
route.request()対応する Request を取得する

WebSocket クラス

メソッド/イベント説明
webSocket.url()WebSocket URL
webSocket.isClosed()閉じているかどうか
webSocket.on('framereceived', handler)フレーム受信イベント
webSocket.on('framesent', handler)フレーム送信イベント
webSocket.on('close', handler)クローズイベント

APIRequestContext クラス

メソッド説明
request.get(url, options?)GET リクエストを送信する
request.post(url, options?)POST リクエストを送信する
request.put(url, options?)PUT リクエストを送信する
request.patch(url, options?)PATCH リクエストを送信する
request.delete(url, options?)DELETE リクエストを送信する
request.head(url, options?)HEAD リクエストを送信する
request.fetch(urlOrRequest, options?)リクエストを送信する(汎用)
request.storageState(options?)ストレージ状態を取得する
request.dispose()リソースを解放する

APIResponse クラス

メソッド説明
response.status()HTTPステータスコード
response.statusText()ステータステキスト
response.headers()レスポンスヘッダー
response.body()body(Buffer)
response.text()body(テキスト)
response.json()body(JSON)
response.ok()ステータスコードが 200-299 の範囲にあるかどうか
response.url()レスポンスの最終URL
response.dispose()リソースを解放する

Keyboard クラス

メソッド説明
keyboard.press(key)キーを押して離す
keyboard.down(key)キーを押したまま離さない
keyboard.up(key)キーを離す
keyboard.type(text, options?)1文字ずつ入力する
keyboard.insertText(text)テキストを直接挿入する

Mouse クラス

メソッド説明
mouse.click(x, y, options?)座標クリック
mouse.dblclick(x, y, options?)座標ダブルクリック
mouse.move(x, y, options?)マウスを座標に移動する
mouse.down(options?)マウスボタンを押す
mouse.up(options?)マウスボタンを離す
mouse.wheel(deltaX, deltaY)ホイールを回す

Touchscreen クラス

メソッド説明
touchscreen.tap(x, y)タップ
その他の拡張