API响应

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

---

方法

body

添加于：v1.16 apiResponse.body

返回包含响应体的 buffer。

用法

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#