HttpRequest

Class in @minecraft/server-net

An HTTP request for HttpClient.request. Each setter returns the request, so they chain.

const request = new HttpRequest("https://example.org/api")
    .setMethod(HttpRequestMethod.Post)
    .addHeader("Content-Type", "application/json")
    .setBody(JSON.stringify({ hello: "world" }));

import { HttpRequest } from '@minecraft/server-net';

Example

TypeScript JavaScript

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

async function report(message: string): Promise<void> {
    const request = new HttpRequest('https://example.com/api/report')
        .setMethod(HttpRequestMethod.Post)
        .addHeader('Content-Type', 'application/json')
        .setBody(JSON.stringify({ message }))
        .setTimeout(5);
    const response = await http.request(request);
    console.log(`Server answered ${response.status}`);
}

report('Basalt started');

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

async function report(message) {
    const request = new HttpRequest('https://example.com/api/report')
        .setMethod(HttpRequestMethod.Post)
        .addHeader('Content-Type', 'application/json')
        .setBody(JSON.stringify({ message }))
        .setTimeout(5);
    const response = await http.request(request);
    console.log(`Server answered ${response.status}`);
}

report('Basalt started');

Constructor

constructor(uri: string);

Parameters

uri

string

Properties

body

body: string;

The body sent, as text; empty sends none.

headers

headers: HttpHeader[];

Types

HttpHeader

method

method: HttpRequestMethod;

Get unless set.

Types

HttpRequestMethod

timeout

timeout: number;

Seconds to wait for the whole answer before rejecting with reason timeout; 10 unless set.

uri

uri: string;

Where it goes: an http or https URI.

Methods

addHeader

addHeader(key: string, value: string): HttpRequest;

Parameters

key

string

value

string

Returns

HttpRequest

setBody

setBody(body: string): HttpRequest;

Parameters

body

string

Returns

HttpRequest

setHeaders

setHeaders(headers: HttpHeader[]): HttpRequest;

Parameters

headers

HttpHeader[]

Returns

HttpRequest

Types

HttpHeader

setMethod

setMethod(method: HttpRequestMethod): HttpRequest;

Parameters

method

HttpRequestMethod

Returns

HttpRequest

Types

HttpRequestMethod

setTimeout

setTimeout(timeout: number): HttpRequest;

Parameters

timeout

number

Returns

HttpRequest

Used by

HttpResponse.request, HttpClient.request