HttpClient Class

Methods

• cancelAll
• get
• request

cancelAll

cancelAll(reason: string): void

Cancels all pending requests.

Parameters

• reason: string

Notes:

• This function can be called in early-execution mode.

get

"get"(uri: string): Promise<HttpResponse>

Performs a simple HTTP get request.

Parameters

• uri: string

  URL to make an HTTP Request to.

Returns Promise<HttpResponse> - An awaitable promise that contains the HTTP response.

Notes:

• This function can be called in early-execution mode.

request

request(config: HttpRequest): Promise<HttpResponse>

Performs an HTTP request.

Parameters

• config: HttpRequest

  Contains an HTTP Request object with configuration data on the HTTP request.

Returns Promise<HttpResponse> - An awaitable promise that contains the HTTP response.

Notes:

• This function can be called in early-execution mode.

Examples

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);
}

(preview) Work with this sample on the MCTools.dev code sandbox.

Examples

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);
}

(preview) Work with this sample on the MCTools.dev code sandbox.