APIResponse

APIResponse 類別代表由 apiRequestContext.get() 和類似方法傳回的回應。

---

方法

body

加入版本：v1.16 apiResponse.body

傳回包含回應 body 的緩衝區。

用法

await apiResponse.body();

傳回

• Promise<Buffer>#

---

dispose

加入版本：v1.16 apiResponse.dispose

處置此回應的 body。如果未呼叫，則 body 將保留在記憶體中，直到內容關閉為止。

用法

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

傳回回應 body 的 JSON 表示法。

如果回應 body 無法透過 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

傳回回應 body 的文字表示法。

用法

await apiResponse.text();

傳回

• Promise<string>#

---

url

加入版本：v1.16 apiResponse.url

包含回應的 URL。

用法

apiResponse.url();

傳回

• string#