Represents an HTTP header - a key/value pair of meta-information about 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

  • HttpHeader

Constructors

Properties

Constructors

Properties

key: string

Remarks

Key of the HTTP header.

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

value: string | SecretString

Remarks

Value of the HTTP header.

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