Skip to content

ServerResult

ServerResult = { found: false; } | { events: object[]; found: true; missingPermissions: string | null; periodStart: string; profile: ServerProfile; uniqueUsersThisPeriod: number | null; }

Defined in: packages/client/src/results.ts:235

Answer to a server query. found is false for a server the collector has never seen.

{ found: false; }


{ events: object[]; found: true; missingPermissions: string | null; periodStart: string; profile: ServerProfile; uniqueUsersThisPeriod: number | null; }

events: object[]

The last 100 times the bot joined or left, or the server went down or came back. Newest first.

found: true

missingPermissions: string | null

The permission bits Settings lists as required that the bot lacks here, as a decimal string ('0' for none). null when no permissions are required or the bot’s are unknown.

periodStart: string

First day of the current salt period.

profile: ServerProfile

uniqueUsersThisPeriod: number | null