class InviteGuild

export class InviteGuild extends AnonymousGuild

Represents a guild received from an invite, includes welcome screen data if available.

The hash of the guild banner

readonly
client : Client

The client that instantiated this

readonly
createdAt : Date

The time this guild was created at

readonly
createdTimestamp : number

The timestamp this guild was created at

optional
description? : string

The description of the guild, if any

features : Array<GuildFeature>

An array of features available to this guild

optional
icon? : string

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

nsfwLevel : GuildNSFWLevel

The NSFW level of this guild

readonly
partnered : boolean

Whether this guild is partnered

optional
premiumSubscriptionCount? : number

The total number of boosts for this server

optional
splash? : string

The hash of the guild invite splash image

optional
vanityURLCode? : string

The vanity invite code of the guild, if any

verificationLevel : GuildVerificationLevel

The verification level of the guild

readonly
verified : boolean

Whether this guild is verified

welcomeScreen : WelcomeScreen | null

The welcome screen for this invite guild

bannerURL(
options?: ImageURLOptions
) : string | null

The URL to this guild's banner.

Inherited from: AnonymousGuild

fetch() : Promise<Guild>

Fetches this guild.

Inherited from: BaseGuild

iconURL(
options?: ImageURLOptions
) : string | null

The URL to this guild's icon.

Inherited from: BaseGuild

splashURL(
options?: ImageURLOptions
) : string | null

The URL to this guild's invite splash image.

Inherited from: AnonymousGuild

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.

Inherited from: BaseGuild

valueOf() : string

Inherited from: Base