Interface GameListingConfig

Hierarchy

  • GameListingConfig

Properties

ignorePrivacy: boolean

Whether to ignore the privacy of a room, and return even private ones.

Default

false

ignoreSearchTerms: boolean | ValidSearchTerm[]

Whether to ignore filtering for game listings, and just list every game on the server.

Or specify which search terms ("map", "impostors", "chat", "chatType") to ignore by passing an array.

Default

false

maxResults: number | "all"

The maximum number of results to return to a client at once. Set to 0 or "all" for this to be infinite

Default

10

requirePefectMatches: boolean

Whether to only return results that are a perfect match to all of the sort terms. Otherwise, Hindenburg will sort results by relevance to the search terms.

Default

false

Generated using TypeDoc