Skip to main content

guilds

caution

All props/parameters are optional unless they are marked with an asterisk ( * ).

Functions

NameParametersReturn TypeDescription
getCurrentGuildGuild | undefinedGets the currently selected guild object
getGuild* guildId: stringGuild | undefinedGets the guild by its id
getGuildCountnumberGets the number of how many guilds the current user is in
getGuildIdstring | nullGets the id of the currently selected guild
getGuildIdsstring[]Gets all guild ids
getGuildsRecord<string, Guild>Gets all guilds
getLastSelectedGuildIdstring | nullGets the last selected guild id
getLastSelectedTimestamp* guildId: stringnumberGets the timestamp of when a specific guild was last selected
getStateStateGets an object containing some information about guild selections
isLoadedbooleanGets a value indicating whether all initial guilds have been loaded

Types

State

NameTypeDescription
lastSelectedGuildIdstringLast selected guild id
selectedGuildIdstringCurrent selected guild id
selectedGuildTimestampMillisRecord<string, number>Object containing timestamps of when guilds were selected