APIResponse

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

¥APIResponse class represents responses returned by apiRequestContext.get() and similar methods.

---

方法

¥Methods

body

Added in: v1.16 apiResponse.body

返回带有响应正文的缓冲区。

¥Returns the buffer with response body.

用法

¥Usage

await apiResponse.body();

返回

¥Returns

• Promise<Buffer>#

---

dispose

Added in: v1.16 apiResponse.dispose

处理此响应的正文。如果没有被调用，那么主体将保留在内存中，直到上下文关闭。

¥Disposes the body of this response. If not called then the body will stay in memory until the context closes.

用法

¥Usage

await apiResponse.dispose();

返回

¥Returns

• Promise<void>#

---

headers

Added in: v1.16 apiResponse.headers

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

¥An object with all the response HTTP headers associated with this response.

用法

¥Usage

apiResponse.headers();

返回

¥Returns

• Object<string, string>#

---

headersArray

Added in: v1.16 apiResponse.headersArray

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

¥An array with all the response HTTP headers associated with this response. Header names are not lower-cased. Headers with multiple entries, such as Set-Cookie, appear in the array multiple times.

用法

¥Usage

apiResponse.headersArray();

返回

¥Returns

• Array<Object>#

  • name string

标头的名称。

¥Name of the header.

• value string

标头的值。

¥Value of the header.

---

json

Added in: v1.16 apiResponse.json

返回响应正文的 JSON 表示形式。

¥Returns the JSON representation of response body.

如果响应正文无法通过 JSON.parse 进行解析，则此方法将抛出异常。

¥This method will throw if the response body is not parsable via JSON.parse.

用法

¥Usage

await apiResponse.json();

返回

¥Returns

• Promise<Serializable>#

---

ok

Added in: v1.16 apiResponse.ok

包含一个布尔值，说明响应是否成功（状态范围为 200-299）。

¥Contains a boolean stating whether the response was successful (status in the range 200-299) or not.

用法

¥Usage

apiResponse.ok();

返回

¥Returns

• boolean#

---

status

Added in: v1.16 apiResponse.status

包含响应的状态代码（例如，200 表示成功）。

¥Contains the status code of the response (e.g., 200 for a success).

用法

¥Usage

apiResponse.status();

返回

¥Returns

• number#

---

statusText

Added in: v1.16 apiResponse.statusText

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

¥Contains the status text of the response (e.g. usually an "OK" for a success).

用法

¥Usage

apiResponse.statusText();

返回

¥Returns

• string#

---

text

Added in: v1.16 apiResponse.text

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

¥Returns the text representation of response body.

用法

¥Usage

await apiResponse.text();

返回

¥Returns

• Promise<string>#

---

url

Added in: v1.16 apiResponse.url

包含响应的 URL。

¥Contains the URL of the response.

用法

¥Usage

apiResponse.url();

返回

¥Returns

• string#