Class Server

Represents a pinged server. An instance of this class is returned after calling Servers

The data parameter must adhere to the ServerData type otherwise some properties may be undefined.
If unspecified, the host parameter will default to localhost.
If unspecified, the port parameter will default to 25565.

Hierarchy

Server

Index

Constructors

Accessors

host icon motd online players port protocol title version

Methods

Constructors

constructor

new Server(data, host?, port?): Server
Parameters
- data: OnlineServer
- host: string = 'localhost'
- port: number = 25565
Returns Server
- Defined in classes/server/Server.ts:105

Accessors

host

get host(): string
Returns string
- Defined in classes/server/Server.ts:34

icon

get icon(): string
Returns string
- Defined in classes/server/Server.ts:51

motd

get motd(): ServerMotd
Returns ServerMotd
- Defined in classes/server/Server.ts:95

online

get online(): boolean
Returns boolean
- Defined in classes/server/Server.ts:103

players

get players(): ServerPlayers
Returns ServerPlayers
- Defined in classes/server/Server.ts:78

port

get port(): number
Returns number
- Defined in classes/server/Server.ts:43

protocol

get protocol(): number | NameVersion[]
Returns number | NameVersion[]
- Defined in classes/server/Server.ts:70

title

get title(): string
Returns string
- Defined in classes/server/Server.ts:86

version

get version(): string
Returns string
- Defined in classes/server/Server.ts:59

Methods

refresh

refresh(): Promise<void>
Returns Promise<void>
- Defined in classes/server/Server.ts:138