Interface LoggingConfig

Hierarchy

LoggingConfig

Index

Properties

connections hideSensitiveInfo players rooms

Properties

connections

connections: {
format?: ConnectionsFormatOptions[];
}

Logging options for client connections.

Type declaration

Optional format?: ConnectionsFormatOptions[]
Custom formatting for the extra information provided when logging client connections. (The part in parenthesis after their username.)

Id
The client's client id.

Ip
The client's ip address.

Ping
The client's round-trip ping.

Room
The client's current room code.

Language
The client's language.

Example
```
{
    // Hide the client's round-trip ping.
    "format": ["id", "ip", "room"]
}

// => weakeyes (140, 127.0.0.1, ABCDEF)
```
Default
["id", "ip", "ping", "room"]

hideSensitiveInfo

hideSensitiveInfo: boolean

Whether to hide sensitive information from logging, such as ip addresses.

Default

false

players

players: {
format?: PlayerFormatOptions[];
}

Logging options for logging players in-game.

Type declaration

Optional format?: PlayerFormatOptions[]
Custom formatting for the extra information provided when players are logged. (The part in parenthesis after the player's name.)

Id
The client ID of the player.

Ping
The player's round-trip ping.

Ishost
Whether this player is host. (Not displayed if the player is not host.)

Example
```
{
    // Don't show the player's ping or whether they are the host.
    "format": ["id"]
}

// => weakeyes (104)
```
Default
["id", "ping", "ishost"]

rooms

rooms: {
format?: RoomFormatOptions[];
}

Logging options for game rooms.

Type declaration

Optional format?: RoomFormatOptions[]
Custom formatting for the extra information provided when rooms are logged. (The part in parenthesis after the game code.)

Players
The total number of players currently connected to the room.

Map
The map that the room is currently playing.

Saah
Whether or not the room is in SaaH.

Example
```
{
    // Don't show any extra information about the room.
    "format": []
}

// => ABCDEF
```
Default
["players", "map", "issaah", "privacy"]

Generated using TypeDoc