Preview environment

class BaseGuild

extends

Base
abstract
export abstract class BaseGuild extends Base

The base class for Guild, OAuth2Guild and InviteGuild.

Constructors

constructor(
client: Client<true>
data: RawBaseGuildData
)

Constructs a new instance of the BaseGuild class

readonly
client : Client<true>

The client that instantiated this

Inherited from: Base

readonly
createdAt : Date

The time this guild was created at

readonly
createdTimestamp : number

The timestamp this guild was created at

features : `${GuildFeature}`[]

An array of features available to this guild

icon : string | null

The icon hash of this guild

id : Snowflake

The guild's id

name : string

The name of this guild

readonly
nameAcronym : string

The acronym that shows up in place of a guild icon

readonly
partnered : boolean

Whether this guild is partnered

readonly
verified : boolean

Whether this guild is verified

fetch() : Promise<Guild>

Fetches this guild.

iconURL(
options?: ImageURLOptions
) : string | null

The URL to this guild's icon.

toJSON(
...props: Record<string, boolean | string>[]
) : unknown

Inherited from: Base

toString() : string

When concatenated with a string, this automatically returns the guild's name instead of the Guild object.

valueOf() : string

Inherited from: Base