Five On It

Appearance

five-on-it / apps/server/src/fleet-client / FleetClientOptions

Interface: FleetClientOptions ​

Defined in: apps/server/src/fleet-client.ts:26

Where the registry is and who this server is.

Properties ​

capacity ​

capacity: number

Defined in: apps/server/src/fleet-client.ts:36

fetchImpl? ​

optional fetchImpl?: {(input, init?): Promise<Response>; (input, init?): Promise<Response>; }

Defined in: apps/server/src/fleet-client.ts:43

Call Signature ​

(input, init?): Promise<Response>

MDN Reference

Parameters ​
input ​

URL | RequestInfo

init? ​

RequestInit

Returns ​

Promise<Response>

Call Signature ​

(input, init?): Promise<Response>

MDN Reference

Parameters ​
input ​

string | URL | Request

init? ​

RequestInit

Returns ​

Promise<Response>

id ​

id: string

Defined in: apps/server/src/fleet-client.ts:31

internalUrl ​

internalUrl: string

Defined in: apps/server/src/fleet-client.ts:33

log? ​

optional log?: (message) => void

Defined in: apps/server/src/fleet-client.ts:44

Parameters ​

message ​

string

Returns ​

void

maxRooms? ​

optional maxRooms?: number

Defined in: apps/server/src/fleet-client.ts:38

The rooms it takes at most, when it was given a cap (FOI_MAX_ROOMS).

maxRuns? ​

optional maxRuns?: number

Defined in: apps/server/src/fleet-client.ts:40

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

protocolVersion ​

protocolVersion: number

Defined in: apps/server/src/fleet-client.ts:35

publicUrl ​

publicUrl: string

Defined in: apps/server/src/fleet-client.ts:32

secret ​

secret: string

Defined in: apps/server/src/fleet-client.ts:30

The fleet's shared secret.

status ​

status: () => Pick<FleetHeartbeat, "players" | "stepP95Ms" | "draining" | "rooms" | "runs">

Defined in: apps/server/src/fleet-client.ts:42

What the server reports now (what changes: the rest is fixed when it starts).

Returns ​

Pick<FleetHeartbeat, "players" | "stepP95Ms" | "draining" | "rooms" | "runs">

url ​

url: string

Defined in: apps/server/src/fleet-client.ts:28

The registry's base URL (the API's internal listener).

version ​

version: string

Defined in: apps/server/src/fleet-client.ts:34