WebSocket

Class in @minecraft/server-net

Basalt’s own, as the browser’s WebSocket: a ws or wss connection, text messages each way. Mojang’s @minecraft/server-net has none. Messages arrive between the plugin’s other work, and a plugin’s sockets close (code 1001) when it’s disposed or reloaded.

const ws = new WebSocket("wss://example.org/feed", { headers: { Authorization: "Bearer x" } });
ws.onopen = () => ws.send("hello");
ws.onmessage = (event) => world.sendMessage(event.data);
ws.onclose = (event) => console.warn(`closed ${event.code} ${event.reason}`);

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

Constructor

constructor(url: string, options?: WebSocketOptions);

Starts opening a socket to url.

Parameters

url

string

optionsoptional

WebSocketOptions

Throws

• SyntaxError if url isn’t a ws or wss URL, and SecurityError if basalt.toml doesn’t allow its host.

Types

WebSocketOptions

Properties

CONNECTING

static read-only

static readonly CONNECTING: 0;

OPEN

static read-only

static readonly OPEN: 1;

CLOSING

static read-only

static readonly CLOSING: 2;

CLOSED

static read-only

static readonly CLOSED: 3;

url

read-only

readonly url: string;

The URL it was opened with.

readyState

read-only

readonly readyState: 0 | 1 | 2 | 3;

WebSocket.CONNECTING, OPEN, CLOSING or CLOSED.

protocol

read-only

readonly protocol: string;

The subprotocol the server chose, empty for none.

onopen

onopen: ((event: WebSocketOpenEvent) => void) | null;

Types

WebSocketOpenEvent

onmessage

onmessage: ((event: WebSocketMessageEvent) => void) | null;

Types

WebSocketMessageEvent

onclose

onclose: ((event: WebSocketCloseEvent) => void) | null;

Types

WebSocketCloseEvent

onerror

onerror: ((event: WebSocketErrorEvent) => void) | null;

Types

WebSocketErrorEvent

Methods

send

send(data: string): void;

Sends a text message. Does nothing once closing.

Parameters

data

string

Throws

• InvalidStateError while still connecting.

close

close(code?: number, reason?: string): void;

Starts closing, waiting for the server’s goodbye before onclose.

Parameters

codeoptional

number1000, the default, or 3000 to 4999.

reasonoptional

string

Throws

• InvalidAccessError for any other code.

addEventListener

addEventListener<K extends keyof WebSocketEventMap>(
    type: K,
    listener: (event: WebSocketEventMap[K]) => void,
): void;

Parameters

type

K

listener

(event: WebSocketEventMap[K]) => void

Types

WebSocketEventMap

removeEventListener

removeEventListener<K extends keyof WebSocketEventMap>(
    type: K,
    listener: (event: WebSocketEventMap[K]) => void,
): void;

Parameters

type

K

listener

(event: WebSocketEventMap[K]) => void

Types

WebSocketEventMap

Used by

WebSocketMessageEvent.target, WebSocketCloseEvent.target, WebSocketErrorEvent.target, WebSocketOpenEvent.target