Skip to content

@minecraft/server-net


@minecraft/server-net / HttpClient

Class: HttpClient

Defined in: index.d.ts:58

Constructors

Constructor

protected new HttpClient(): HttpClient

Defined in: index.d.ts:87

Returns

HttpClient

Methods

cancelAll()

cancelAll(reason): void

Defined in: index.d.ts:64

Parameters

reason

string

Returns

void

Remarks

Cancels all pending requests.


get()

get(uri): Promise<HttpResponse>

Defined in: index.d.ts:73

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.


request()

request(config): Promise<HttpResponse>

Defined in: index.d.ts:83

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.


testOnly_fulfillRequest()

testOnly_fulfillRequest(requestId, headers, body, status): void

Defined in: index.d.ts:84

Parameters

requestId

number

headers

HttpHeader[]

body

string

status

number

Returns

void


testOnly_getRequests()

testOnly_getRequests(): number[]

Defined in: index.d.ts:85

Returns

number[]


testOnly_rejectRequest()

testOnly_rejectRequest(requestId, reason): void

Defined in: index.d.ts:86

Parameters

requestId

number

reason

string

Returns

void