Class Server

Represents a Minecraft Classic server.

Hierarchy

TypedEmitter
- Server

Constructors

constructor

new Server(port?: number, host?: string): Server
Creates a new Server instance.
Parameters
- Optionalport: number = 25565
  The port to listen on. Defaults to 25565.
- Optionalhost: string
  The host to listen on. Defaults to all interfaces.
Returns Server
Overrides TypedEmitter.constructor
- Defined in class/Server.mjs:106

Properties

appName

appName: string

connectionTimeout

connectionTimeout: number

cpeEnabled

cpeEnabled: boolean

extensions

extensions: extension[]

httpServer

httpServer: UpgradingHttpServer

isTrustedWebSocketProxy

isTrustedWebSocketProxy: (remoteAddress: any) => boolean

tcpServer

tcpServer: Server

utils

utils: __module

`Static`defaultMaxListeners

defaultMaxListeners: number

`Static`maximumBufferSize

maximumBufferSize: number = 5000

`Static`websocketUpgradeFlag

websocketUpgradeFlag: string = "upgrade"

Methods

addListener

addListener(
 event: U,
 listener: {
 clientConnected: (
 player: Client,
 authInfo: { extensions: extension[]; key: string; username: string },
 ) => void;
 }[U],
): this
Type Parameters
- U extends "clientConnected"
Parameters
- event: U
- listener: {
 clientConnected: (
 player: Client,
 authInfo: { extensions: extension[]; key: string; username: string },
 ) => void;
 }[U]
Returns this
Inherited from TypedEmitter.addListener
- Defined in node_modules/.pnpm/tiny-typed-emitter@2.1.0/node_modules/tiny-typed-emitter/lib/index.d.ts:11

emit

emit(
 event: U,
 ...args: Parameters<
 {
 clientConnected: (
 player: Client,
 authInfo: { extensions: extension[]; key: string; username: string },
 ) => void;
 }[U],
 >,
): boolean
Type Parameters
- U extends "clientConnected"
Parameters
- event: U
- ...args: Parameters<
 {
 clientConnected: (
 player: Client,
 authInfo: { extensions: extension[]; key: string; username: string },
 ) => void;
 }[U],
 >
Returns boolean
Inherited from TypedEmitter.emit
- Defined in node_modules/.pnpm/tiny-typed-emitter@2.1.0/node_modules/tiny-typed-emitter/lib/index.d.ts:19

eventNames

eventNames(): U[]
Type Parameters
- U extends "clientConnected"
Returns U[]
Inherited from TypedEmitter.eventNames
- Defined in node_modules/.pnpm/tiny-typed-emitter@2.1.0/node_modules/tiny-typed-emitter/lib/index.d.ts:20

getMaxListeners

getMaxListeners(): number
Returns number
Inherited from TypedEmitter.getMaxListeners
- Defined in node_modules/.pnpm/tiny-typed-emitter@2.1.0/node_modules/tiny-typed-emitter/lib/index.d.ts:24

listenerCount

listenerCount(type: "clientConnected"): number
Parameters
- type: "clientConnected"
Returns number
Inherited from TypedEmitter.listenerCount
- Defined in node_modules/.pnpm/tiny-typed-emitter@2.1.0/node_modules/tiny-typed-emitter/lib/index.d.ts:21

listeners

listeners(
 type: U,
): {
 clientConnected: (
 player: Client,
 authInfo: { extensions: extension[]; key: string; username: string },
 ) => void;
}[U][]
Type Parameters
- U extends "clientConnected"
Parameters
- type: U
Returns {
 clientConnected: (
 player: Client,
 authInfo: { extensions: extension[]; key: string; username: string },
 ) => void;
}[U][]
Inherited from TypedEmitter.listeners
- Defined in node_modules/.pnpm/tiny-typed-emitter@2.1.0/node_modules/tiny-typed-emitter/lib/index.d.ts:22

off

off(
 event: U,
 listener: {
 clientConnected: (
 player: Client,
 authInfo: { extensions: extension[]; key: string; username: string },
 ) => void;
 }[U],
): this
Type Parameters
- U extends "clientConnected"
Parameters
- event: U
- listener: {
 clientConnected: (
 player: Client,
 authInfo: { extensions: extension[]; key: string; username: string },
 ) => void;
 }[U]
Returns this
Inherited from TypedEmitter.off
- Defined in node_modules/.pnpm/tiny-typed-emitter@2.1.0/node_modules/tiny-typed-emitter/lib/index.d.ts:18

on

on(
 event: U,
 listener: {
 clientConnected: (
 player: Client,
 authInfo: { extensions: extension[]; key: string; username: string },
 ) => void;
 }[U],
): this
Type Parameters
- U extends "clientConnected"
Parameters
- event: U
- listener: {
 clientConnected: (
 player: Client,
 authInfo: { extensions: extension[]; key: string; username: string },
 ) => void;
 }[U]
Returns this
Inherited from TypedEmitter.on
- Defined in node_modules/.pnpm/tiny-typed-emitter@2.1.0/node_modules/tiny-typed-emitter/lib/index.d.ts:17

once

once(
 event: U,
 listener: {
 clientConnected: (
 player: Client,
 authInfo: { extensions: extension[]; key: string; username: string },
 ) => void;
 }[U],
): this
Type Parameters
- U extends "clientConnected"
Parameters
- event: U
- listener: {
 clientConnected: (
 player: Client,
 authInfo: { extensions: extension[]; key: string; username: string },
 ) => void;
 }[U]
Returns this
Inherited from TypedEmitter.once
- Defined in node_modules/.pnpm/tiny-typed-emitter@2.1.0/node_modules/tiny-typed-emitter/lib/index.d.ts:16

prependListener

prependListener(
 event: U,
 listener: {
 clientConnected: (
 player: Client,
 authInfo: { extensions: extension[]; key: string; username: string },
 ) => void;
 }[U],
): this
Type Parameters
- U extends "clientConnected"
Parameters
- event: U
- listener: {
 clientConnected: (
 player: Client,
 authInfo: { extensions: extension[]; key: string; username: string },
 ) => void;
 }[U]
Returns this
Inherited from TypedEmitter.prependListener
- Defined in node_modules/.pnpm/tiny-typed-emitter@2.1.0/node_modules/tiny-typed-emitter/lib/index.d.ts:12

prependOnceListener

prependOnceListener(
 event: U,
 listener: {
 clientConnected: (
 player: Client,
 authInfo: { extensions: extension[]; key: string; username: string },
 ) => void;
 }[U],
): this
Type Parameters
- U extends "clientConnected"
Parameters
- event: U
- listener: {
 clientConnected: (
 player: Client,
 authInfo: { extensions: extension[]; key: string; username: string },
 ) => void;
 }[U]
Returns this
Inherited from TypedEmitter.prependOnceListener
- Defined in node_modules/.pnpm/tiny-typed-emitter@2.1.0/node_modules/tiny-typed-emitter/lib/index.d.ts:13

rawListeners

rawListeners(
 type: U,
): {
 clientConnected: (
 player: Client,
 authInfo: { extensions: extension[]; key: string; username: string },
 ) => void;
}[U][]
Type Parameters
- U extends "clientConnected"
Parameters
- type: U
Returns {
 clientConnected: (
 player: Client,
 authInfo: { extensions: extension[]; key: string; username: string },
 ) => void;
}[U][]
Inherited from TypedEmitter.rawListeners
- Defined in node_modules/.pnpm/tiny-typed-emitter@2.1.0/node_modules/tiny-typed-emitter/lib/index.d.ts:23

removeAllListeners

removeAllListeners(event?: "clientConnected"): this
Parameters
- Optionalevent: "clientConnected"
Returns this
Inherited from TypedEmitter.removeAllListeners
- Defined in node_modules/.pnpm/tiny-typed-emitter@2.1.0/node_modules/tiny-typed-emitter/lib/index.d.ts:15

removeListener

removeListener(
 event: U,
 listener: {
 clientConnected: (
 player: Client,
 authInfo: { extensions: extension[]; key: string; username: string },
 ) => void;
 }[U],
): this
Type Parameters
- U extends "clientConnected"
Parameters
- event: U
- listener: {
 clientConnected: (
 player: Client,
 authInfo: { extensions: extension[]; key: string; username: string },
 ) => void;
 }[U]
Returns this
Inherited from TypedEmitter.removeListener
- Defined in node_modules/.pnpm/tiny-typed-emitter@2.1.0/node_modules/tiny-typed-emitter/lib/index.d.ts:14

setMaxListeners

setMaxListeners(n: number): this
Parameters
- n: number
Returns this
Inherited from TypedEmitter.setMaxListeners
- Defined in node_modules/.pnpm/tiny-typed-emitter@2.1.0/node_modules/tiny-typed-emitter/lib/index.d.ts:25

setupWebSocketServer

setupWebSocketServer(): Promise<typeof UpgradingHttpServer>
Sets up a WebSocket server and allow WebSocket connections under the same port.

Returns Promise<typeof UpgradingHttpServer>
The UpgradingHttpServer instance.
- Defined in class/Server.mjs:147

`Static`tcpPacketHandler

tcpPacketHandler(client: Client, data?: Buffer<ArrayBufferLike>): void | Socket
Handles incoming packets from the client.
Parameters
- client: Client
 A client instance.
- Optionaldata: Buffer<ArrayBufferLike>
 The data received from the client.
Returns void | Socket
- Defined in class/Server.mjs:157

Class Server

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Server

Properties

appName

connectionTimeout

cpeEnabled

extensions

httpServer

isTrustedWebSocketProxy

tcpServer

utils

StaticdefaultMaxListeners

StaticmaximumBufferSize

StaticwebsocketUpgradeFlag

Methods

addListener

Type Parameters

Parameters

Returns this

emit

Type Parameters

Parameters

Returns boolean

eventNames

Type Parameters

Returns U[]

getMaxListeners

Returns number

listenerCount

Parameters

Returns number

listeners

Type Parameters

Parameters

Returns { clientConnected: ( player: Client, authInfo: { extensions: extension[]; key: string; username: string }, ) => void;}[U][]

off

Type Parameters

Parameters

Returns this

on

Type Parameters

Parameters

Returns this

once

Type Parameters

Parameters

Returns this

prependListener

Type Parameters

Parameters

Returns this

prependOnceListener

Type Parameters

Parameters

Returns this

rawListeners

Type Parameters

Parameters

Returns { clientConnected: ( player: Client, authInfo: { extensions: extension[]; key: string; username: string }, ) => void;}[U][]

removeAllListeners

Parameters

Returns this

removeListener

Type Parameters

Parameters

Returns this

setMaxListeners

Parameters

Returns this

setupWebSocketServer

Returns Promise<typeof UpgradingHttpServer>

StatictcpPacketHandler

`Static`defaultMaxListeners

`Static`maximumBufferSize

`Static`websocketUpgradeFlag

Returns {
clientConnected: (
player: Client,
authInfo: { extensions: extension[]; key: string; username: string },
) => void;
}[U][]

Returns {
clientConnected: (
player: Client,
authInfo: { extensions: extension[]; key: string; username: string },
) => void;
}[U][]

`Static`tcpPacketHandler