Skip to content

five-on-it / apps/api/src/config / GameServerRef

Interface: GameServerRef ​

Defined in: apps/api/src/config.ts:66

A game server the API can open rooms on.

Properties ​

api? ​

optional api?: string

Defined in: apps/api/src/config.ts:72

Where it reaches the API, when not at the API's own URL (a fleet server: FOI_API_FLEET_URL).


capacity? ​

optional capacity?: number

Defined in: apps/api/src/config.ts:74

The players it takes (DEFAULT_CAPACITY when it does not say).


internal ​

internal: string

Defined in: apps/api/src/config.ts:68

Where the API reaches it (http).


maxRuns? ​

optional maxRuns?: number

Defined in: apps/api/src/config.ts:76

The runs it plays at once at most (its FOI_MAX_RUNS), when it said: at its cap, the fleet passes it by for a run.


public ​

public: string

Defined in: apps/api/src/config.ts:70

Where players reach it (ws or wss).


version? ​

optional version?: string

Defined in: apps/api/src/config.ts:78

Its release, when it registered (a server named in FOI_GAME_SERVERS says none, and takes any game).