APIResponse

APIResponse 类表示由 apiRequestContext.get() 及类似方法返回的响应。

---

方法

body

Added in: v1.16 apiResponse.body

返回包含响应体的缓冲区。

用法

await apiResponse.body();

返回值

• Promise<Buffer>#

---

dispose

Added in: v1.16 apiResponse.dispose

释放此响应的响应体。如果不调用此方法，响应体会一直保留在内存中，直到上下文关闭。

用法

await apiResponse.dispose();

返回值

• Promise<void>#

---

headers

Added in: v1.16 apiResponse.headers

包含与此响应关联的所有 HTTP 响应头的对象。

用法

apiResponse.headers();

返回值

• Object<string, string>#

---

headersArray

Added in: v1.16 apiResponse.headersArray

包含与此响应关联的所有 HTTP 响应头的数组。头名称不会转换为小写。具有多个条目的头（如 Set-Cookie）会在数组中多次出现。

用法

apiResponse.headersArray();

返回值

• Array<Object>#

  • name string

    头名称

  • value string

    头值

---

json

Added in: v1.16 apiResponse.json

返回响应体的 JSON 表示形式。

如果响应体无法通过 JSON.parse 解析，此方法将抛出异常。

用法

await apiResponse.json();

返回值

• Promise<Serializable>#

---

ok

Added in: v1.16 apiResponse.ok

包含一个布尔值，表示响应是否成功（状态码在 200-299 范围内）。

用法

apiResponse.ok();

返回值

• boolean#

---

status

Added in: v1.16 apiResponse.status

包含响应的状态码（例如成功时为 200）。

用法

apiResponse.status();

返回值

• number#

---

statusText

Added in: v1.16 apiResponse.statusText

包含响应的状态文本（例如成功时通常为"OK"）。

用法

apiResponse.statusText();

返回值

• string#

---

text

Added in: v1.16 apiResponse.text

返回响应体的文本表示形式。

用法

await apiResponse.text();

返回值

• Promise<string>#

---

url

Added in: v1.16 apiResponse.url

包含响应的 URL。

用法

apiResponse.url();

返回值

• string#