Class MCAPI_SERVERS

Hierarchy

MCAPI_SERVERS

Index

Constructors

Methods

blockedServers get ping

Constructors

constructor

new MCAPI_SERVERS(): MCAPI_SERVERS
Returns MCAPI_SERVERS

Methods

`Static` blockedServers

blockedServers(): Promise<string[]>
The list of blocked servers. Expressed as SHA1 encoded IP addresses.

Returns Promise<string[]>

See
Refer to the 'Blocked Servers' section of the wiki.
- Defined in apis/Servers.ts:10

`Static` get

get(host, port?): Promise<Server>
Pings and retreives info on the requested server.
Parameters
- host: string
  
  The server IP or hostname. Supports attaching the port number, e.g. play.example.net:3000
- Optional port: number
  
  The server port number. If not specified, the ":port" postfix in the host string is used. Otherwise, it will fallback to the default of 25565.
Returns Promise<Server>
- Defined in apis/Servers.ts:34

`Static` ping

ping(host, port?): Promise<PingedServer | OnlineServer>
Internal
Parameters
- host: string
- Optional port: number
Returns Promise<PingedServer | OnlineServer>
- Defined in apis/Servers.ts:42