Class HttpClient

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

Methods

cancelAll get request

Methods

cancelAll

  • cancelAll(reason: string): void

  • Parameters

    • reason: string

    Returns void

    Remarks

    Cancels all pending requests.

    This function can't be called in read-only mode.

get

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

  • Parameters

    • uri: string

      URL to make an HTTP Request to.

    Returns Promise<HttpResponse>

    An awaitable promise that contains the HTTP response.

    Remarks

    Performs a simple HTTP get request.

    This function can't be called in read-only mode.

request

  • request(config: HttpRequest): Promise<HttpResponse>

  • 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.

    Remarks

    Performs an HTTP request.

    This function can't be called in read-only mode.

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

Settings

Member Visibility

On This Page

Methods