APIResponse

APIResponse クラスは、apiRequestContext.get() および同様のメソッドによって返されるレスポンスを表します。

---

メソッド

body

バージョン v1.16 で追加 apiResponse.body

レスポンスボディを持つバッファを返します。

使用例

await apiResponse.body();

戻り値

• Promise<Buffer>#

---

dispose

バージョン v1.16 で追加 apiResponse.dispose

このレスポンスのボディを破棄します。呼び出されない場合、ボディはコンテキストが閉じるまでメモリに保持されます。

使用例

await apiResponse.dispose();

戻り値

• Promise<void>#

---

headers

バージョン v1.16 で追加 apiResponse.headers

このレスポンスに関連付けられたすべてのレスポンス HTTP ヘッダーを持つオブジェクト。

使用例

apiResponse.headers();

戻り値

• Object<string, string>#

---

headersArray

バージョン v1.16 で追加 apiResponse.headersArray

このレスポンスに関連付けられたすべてのレスポンス HTTP ヘッダーを持つ配列。ヘッダー名は大文字小文字を区別しません。Set-Cookie のように複数のエントリを持つヘッダーは、配列に複数回表示されます。

使用例

apiResponse.headersArray();

戻り値

• Array<Object>#

  • name string

    ヘッダーの名前。

  • value string

    ヘッダーの値。

---

json

バージョン v1.16 で追加 apiResponse.json

レスポンスボディの JSON 表現を返します。

レスポンスボディが JSON.parse で解析できない場合、このメソッドはエラーをスローします。

使用例

await apiResponse.json();

戻り値

• Promise<Serializable>#

---

ok

バージョン v1.16 で追加 apiResponse.ok

レスポンスが成功した (ステータスコードが 200-299 の範囲) かどうかを示すブール値を保持します。

使用例

apiResponse.ok();

戻り値

• boolean#

---

status

バージョン v1.16 で追加 apiResponse.status

レスポンスのステータスコード (例: 成功の場合は 200) を保持します。

使用例

apiResponse.status();

戻り値

• number#

---

statusText

バージョン v1.16 で追加 apiResponse.statusText

レスポンスのステータステキスト (例: 通常、成功の場合は "OK") を保持します。

使用例

apiResponse.statusText();

戻り値

• string#

---

text

バージョン v1.16 で追加 apiResponse.text

レスポンスボディのテキスト表現を返します。

使用例

await apiResponse.text();

戻り値

• Promise<string>#

---

url

バージョン v1.16 で追加 apiResponse.url

レスポンスの URL を保持します。

使用例

apiResponse.url();

戻り値

• string#