Skip to content

Guild

Defined in: packages/structures/src/base.ts:401

Common Discord snowflake-backed structure.

new Guild(data): Guild

Defined in: packages/structures/src/base.ts:454

APIGuild

Guild

BaseStructure.constructor

afkChannelId: string | null

Defined in: packages/structures/src/base.ts:434

AFK voice channel, or null.


optional afkTimeout?: number

Defined in: packages/structures/src/base.ts:436

Seconds before a silent member is moved to the AFK channel.


applicationId: string | null

Defined in: packages/structures/src/base.ts:442

Application that created the guild, if a bot did.


optional approximateMemberCount?: number

Defined in: packages/structures/src/base.ts:414


optional approximatePresenceCount?: number

Defined in: packages/structures/src/base.ts:415


banner: string | null

Defined in: packages/structures/src/base.ts:405


defaultMessageNotifications: number

Defined in: packages/structures/src/base.ts:432

Default notification level for new members.


description: string | null

Defined in: packages/structures/src/base.ts:406


discoverySplash: string | null

Defined in: packages/structures/src/base.ts:418


explicitContentFilter: number

Defined in: packages/structures/src/base.ts:430

Explicit content filter level.


features: string[]

Defined in: packages/structures/src/base.ts:409


icon: string | null

Defined in: packages/structures/src/base.ts:403


readonly id: string

Defined in: packages/structures/src/base.ts:12

BaseStructure.id


maxMembers: number

Defined in: packages/structures/src/base.ts:426

Maximum number of members the guild can have.


maxPresences: number | null

Defined in: packages/structures/src/base.ts:448

Maximum presences (null for the default limit).


optional maxVideoChannelUsers?: number

Defined in: packages/structures/src/base.ts:450

Maximum users in a video channel.


optional memberCount?: number

Defined in: packages/structures/src/base.ts:413


mfaLevel: number

Defined in: packages/structures/src/base.ts:428

Required MFA level for administrators.


name: string

Defined in: packages/structures/src/base.ts:402


nsfwLevel: number

Defined in: packages/structures/src/base.ts:417


optional ownerId?: string

Defined in: packages/structures/src/base.ts:408


preferredLocale: string

Defined in: packages/structures/src/base.ts:407


premiumProgressBarEnabled: boolean

Defined in: packages/structures/src/base.ts:452

Whether the boost progress bar shows.


premiumSubscriptionCount: number

Defined in: packages/structures/src/base.ts:412


premiumTier: number

Defined in: packages/structures/src/base.ts:411


publicUpdatesChannelId: string | null

Defined in: packages/structures/src/base.ts:444

Channel for Discord’s community updates, or null.


rulesChannelId: string | null

Defined in: packages/structures/src/base.ts:420

ID of the rules channel for Community guilds.


safetyAlertsChannelId: string | null

Defined in: packages/structures/src/base.ts:446

Channel for safety alerts, or null.


splash: string | null

Defined in: packages/structures/src/base.ts:404


systemChannelFlags: number

Defined in: packages/structures/src/base.ts:424

Bitfield of system channel flags.


systemChannelId: string | null

Defined in: packages/structures/src/base.ts:422

ID of the system messages channel.


vanityUrlCode: string | null

Defined in: packages/structures/src/base.ts:416


verificationLevel: number

Defined in: packages/structures/src/base.ts:410


widgetChannelId: string | null

Defined in: packages/structures/src/base.ts:440

Channel the widget invites to, or null.


widgetEnabled: boolean

Defined in: packages/structures/src/base.ts:438

Whether the server widget is on.

get boostLevel(): number

Defined in: packages/structures/src/base.ts:559

Alias for premiumTier — the guild’s current Nitro boost level (0–3).

number


get createdAt(): Date

Defined in: packages/structures/src/base.ts:29

Returns the timestamp this snowflake was created at.

Date

BaseStructure.createdAt


get createdTimestamp(): number

Defined in: packages/structures/src/base.ts:25

Milliseconds since the Unix epoch at which this snowflake was created.

number

BaseStructure.createdTimestamp


get hasVanityUrl(): boolean

Defined in: packages/structures/src/base.ts:564

Whether the guild has a vanity URL.

boolean


get isBoosted(): boolean

Defined in: packages/structures/src/base.ts:554

Whether the guild has any active boost subscriptions.

boolean


get isCommunity(): boolean

Defined in: packages/structures/src/base.ts:539

Whether the guild is a Community server.

boolean


get isPartnered(): boolean

Defined in: packages/structures/src/base.ts:544

Whether the guild is an official Discord Partner.

boolean


get isVerified(): boolean

Defined in: packages/structures/src/base.ts:549

Whether the guild is verified by Discord.

boolean


get vanityURL(): string | null

Defined in: packages/structures/src/base.ts:569

Returns the guild’s vanity invite URL, or null if none.

string | null

bannerURL(options?): string | null

Defined in: packages/structures/src/base.ts:508

Returns the guild banner URL, or null if none.

ImageURLOptions = {}

string | null


discoverySplashURL(options?): string | null

Defined in: packages/structures/src/base.ts:514

Returns the guild discovery splash URL, or null if none.

ImageURLOptions = {}

string | null


hasFeature(feature): boolean

Defined in: packages/structures/src/base.ts:534

Whether the guild has a given feature flag.

string

Feature string, e.g. “COMMUNITY”.

boolean


iconURL(options?): string | null

Defined in: packages/structures/src/base.ts:496

Returns the guild icon URL, or null if no icon is set.

ImageURLOptions = {}

string | null


splashURL(options?): string | null

Defined in: packages/structures/src/base.ts:502

Returns the guild splash URL, or null if none.

ImageURLOptions = {}

string | null


toString(): string

Defined in: packages/structures/src/base.ts:576

Returns a human-readable string representation.

string

BaseStructure.toString


widgetImageURL(style?): string

Defined in: packages/structures/src/base.ts:526

Returns a widget image URL for the guild.

"shield" | "banner1" | "banner2" | "banner3" | "banner4"

Widget style: shield (default), banner1, banner2, banner3, banner4.

string