Class HttpRequest

Main object for structuring a request.

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

Hierarchy

  • HttpRequest

Constructors

constructor

Properties

body headers method timeout uri

Methods

addHeader setBody setHeaders setMethod setTimeout

Constructors

constructor

Properties

body

body: string

Remarks

Content of the body of the HTTP request.

This property can't be edited in read-only mode.

headers

headers: HttpHeader[]

Remarks

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

This property can't be edited in read-only mode.

method

method: HttpRequestMethod

Remarks

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

This property can't be edited in read-only mode.

timeout

timeout: number

Remarks

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

This property can't be edited in read-only mode.

uri

uri: string

Remarks

The HTTP resource to access.

This property can't be edited in read-only mode.

Methods

addHeader

  • Parameters

    Returns HttpRequest

    Remarks

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

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

setBody

  • Parameters

    • body: string

    Returns HttpRequest

    Remarks

    Updates the content of the body of the HTTP request.

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

setHeaders

  • Parameters

    Returns HttpRequest

    Remarks

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

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

setMethod

  • Parameters

    Returns HttpRequest

    Remarks

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

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

setTimeout

  • Parameters

    • timeout: number

    Returns HttpRequest

    Remarks

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

Settings

Member Visibility

Theme

On This Page