Class STServer

Class representing a server.

Hierarchy

Constructors

constructor

Properties

clients country description descriptionStyled fetched game host info isFull masterMode maxClients port rank totalGames version zombie

Methods

fetch fetchActivity isFetched set list

Constructors

constructor

  • new STServer(host: string, port: number): STServer

  • Parameters

    • host: string

      The host or IP of the server.

    • port: number

      The port of the server.

    Returns STServer

Properties

Optional clients

clients?: number

The number of clients on the server.

Optional country

country?: STCountry

Where the server is based.

Optional description

description?: string

The server's description.

Optional descriptionStyled

descriptionStyled?: string

The description styled with html.

Protected fetched

fetched: boolean = false

True if the class was fetched

Optional game

game?: STLiveGame

The game that's currently in progress on the server.

host

host: string

The host or IP of the server.

Optional info

info?: STServerInfo

The server info.

Optional isFull

isFull?: boolean

Whether or not the server is full.

Optional masterMode

masterMode?: string

The current master mode of the server.

Optional maxClients

maxClients?: number

The maximum number of clients the server supports.

port

port: number

The port of the server.

Optional rank

rank?: number

The server's rank.

Optional totalGames

totalGames?: number

How many games have been played on the server.

Optional version

version?: number

The version the server is running.

Optional zombie

zombie?: boolean

Whether or not the server is a zombie server.

Methods

fetch

  • Fetches the data from the API, filling out the current object. This should be an asynchronous function.

    Returns

    This object after fetching

    Returns Promise<STServer>

fetchActivity

isFetched

  • isFetched(): boolean

  • Returns

    True if this object is fetched

    Returns boolean

set

  • Sets properties based on the response sent from a request

    Returns

    This object after setting properties

    Parameters

    • data: any

      The response data from the API

    Returns STServer

Static list

  • List all servers online

    Returns Promise<STServer[]>

Settings

Member Visibility

Theme

Generated using TypeDoc