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#