类 HttpRequest实验性

包含构成 HTTP 请求所需的参数。主要用于发起请求。

Main object for structuring a request.

示例: simpleHttpRequest.ts

import { HttpRequest, HttpHeader, HttpRequestMethod, http } from '@minecraft/server-net';

async function updateScore() {
    const req = new HttpRequest('http://localhost:3000/updateScore');

    req.body = JSON.stringify({
        score: 22,
    });

    req.method = HttpRequestMethod.Post;
    req.headers = [
        new HttpHeader('Content-Type', 'application/json'),
        new HttpHeader('auth', 'my-auth-token'),
    ];

    await http.request(req);
}

构造函数

constructor

属性

body headers method timeout uri

方法

addHeader setBody setHeaders setMethod setTimeout

构造函数

constructor

  • new HttpRequest(uri: string): HttpRequest
  • 实验性

    参数

    • uri: string

    返回 HttpRequest

属性

实验性body

body: string

备注

请求的携带的主体负载内容。

Content of the body of the HTTP request.

无法在只读模式下修改此属性，详见 WorldBeforeEvents。

实验性headers

headers: HttpHeader[]

备注

该请求的请求标头集合。

A collection of HTTP headers to add to the outbound request.

无法在只读模式下修改此属性，详见 WorldBeforeEvents。

实验性method

method: HttpRequestMethod

备注

该请求的请求方法（例如 GET、PUT 或 PATCH）。

HTTP method (e.g., GET or PUT or PATCH) to use for making the request.

无法在只读模式下修改此属性，详见 WorldBeforeEvents。

实验性timeout

timeout: number

备注

在请求被视为超时而取消前的最大时长，单位为秒。

Amount of time, in seconds, before the request times out and is abandoned.

无法在只读模式下修改此属性，详见 WorldBeforeEvents。

实验性uri

uri: string

备注

请求访问的资源 URI。

The HTTP resource to access.

无法在只读模式下修改此属性，详见 WorldBeforeEvents。

方法

addHeader

  • addHeader(key: string, value: string | SecretString): HttpRequest
  • 实验性

    参数

    返回 HttpRequest

    备注

    向当前请求中增加一个请求标头。

    Adds an additional header to the overall list of headers used in the corresponding HTTP request.

    无法在只读模式下调用此函数，详见 WorldBeforeEvents。

setBody

  • setBody(body: string): HttpRequest
  • 实验性

    参数

    • body: string

    返回 HttpRequest

    备注

    将请求的主体负载内容设定为指定内容。

    Updates the content of the body of the HTTP request.

    无法在只读模式下调用此函数，详见 WorldBeforeEvents。

setHeaders

  • setHeaders(headers: HttpHeader[]): HttpRequest
  • 实验性

    参数

    返回 HttpRequest

    备注

    使用指定的请求标头集合增加或替换请求中指定的请求标头。

    Replaces and applies a set of HTTP Headers for the request.

    无法在只读模式下调用此函数，详见 WorldBeforeEvents。

setMethod

  • setMethod(method: HttpRequestMethod): HttpRequest
  • 实验性

    参数

    返回 HttpRequest

    备注

    设置该请求的请求方法（例如 GET、PUT 或 PATCH）。

    Sets the desired HTTP method (e.g., GET or PUT or PATCH) to use for making the request.

    无法在只读模式下调用此函数，详见 WorldBeforeEvents。

setTimeout

  • setTimeout(timeout: number): HttpRequest
  • 实验性

    参数

    • timeout: number

    返回 HttpRequest

    备注

    设置该请求的最大超时时间，单位为秒。

    无法在只读模式下调用此函数，详见 WorldBeforeEvents。

显示设置

成员可见性

目录

构造函数
属性
方法