Guild

Guild

Represents a guild (server) on serverlist.space

Constructor

new Guild(obj)

Parameters:
Name Type Description
obj object
Source:

Extends

Members

childFriendlyIcon :boolean

Whether or not the guild's icon is child friendly.
Type:
  • boolean
Source:

compliance :boolean

Whether or not the guild is complied to show emojis on the site.
Type:
  • boolean
Source:

createdTimestamp :number

The timestamp of when the guild was established on Discord.
Type:
  • number
Source:

(nullable) fullDescription :string

The guild's full description on serverlist.space
Type:
  • string
Source:

icon :string

The server's Discord icon.
Type:
  • string
Source:

id :string

The guild's Discord ID.
Type:
  • string
Source:

lastUpdateTimestamp :number

The timestamp of the latest guild update on serverlist.space
Type:
  • number
Source:

memberCount :number

The amount of members in the guild.
Type:
  • number
Source:

name :string

The guild's name on Discord.
Type:
  • string
Source:

(readonly) owner :User

The guild's main owner. This is not always the guild owner.
Type:
Source:

(readonly) owners :Array.<User>

The guild's owners, both primary and secondary.
Type:
Source:

(readonly) ownersMap :Store.<string, User>

The owners of the guild, mapped by their IDs.
Type:
  • Store.<string, User>
Source:

(readonly) pageURL :string

The guild's page on serverlist.space
Type:
  • string
Source:

public :boolean

Whether or not the guild is listed publicly on serverlist.space; Usually not public if the server invite has expired.
Type:
  • boolean
Source:

(readonly) raw :object

The raw object of the class, giving the class properties value.
Type:
  • object
Inherited From:
Source:

(readonly) secondaryOwners :Array.<User>

The secondary owners of the guild.
Type:
Source:

shortDescription :string

The guild's short description on serverlist.space
Type:
  • string
Source:

tags :Array.<string>

All tags that the guild represents.
Type:
  • Array.<string>
Source:

(nullable) vanityCode :string

The guild's vanity code.
Type:
  • string
Source:

(readonly) vanityURL :string

The guild's vanity URL on serverlist.space
Type:
  • string
Source:

Methods

toString() → {string}

Returns the guild's name.
Source:
Returns:
Type
string
Example
TextChannel.send(`${guild} is nice.`); // GuildName is nice.