APIResponse

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

方法​

正文​

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

用法

await apiResponse.body();

返回

• Promise<Buffer>#

dispose​

释放此响应的正文。如果不调用，则正文将保留在内存中，直到上下文关闭。

用法

await apiResponse.dispose();

返回

• Promise<void>#

headers​

一个包含与此响应相关的所有HTTP响应头的对象。

用法

apiResponse.headers();

返回

• Object<string, string>#

headersArray​

一个包含与此响应相关的所有HTTP响应头信息的数组。头部名称不会转换为小写。具有多个条目的头部，例如Set-Cookie，会在数组中多次出现。

用法

apiResponse.headersArray();

返回

• 数组<Object>#

  • name string

    标头的名称。

  • value string

    标头的值。

json​

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

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

用法

await apiResponse.json();

返回

• Promise<Serializable>#

好的​

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

用法

apiResponse.ok();

返回

• boolean#

状态​

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

用法

apiResponse.status();

返回

• number#

状态文本​

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

用法

apiResponse.statusText();

返回

• string#

文本​

返回响应体的文本表示。

用法

await apiResponse.text();

返回

• Promise<string>#

网址​

包含响应的URL。

用法

apiResponse.url();

返回

• string#