BaseGuild

Base guild class

Signature

export interface BaseGuild extends ObjectToLower<APIPartialGuild>

Properties

shardIdGetter
get shardId(): number;

Shard ID of the guild.

Returns

Shard ID or -1 if the client is not gateway based.

shardGetter
get shard(): Shard | undefined;

Shard of the guild.

Returns

Shard or undefined, if the client is not gateway based always undefined.

get createdTimestamp(): number;

Create a timestamp for the current object.

get createdAt(): Date;

createdAt gets the creation Date instace of the current object.

icon: string | null;
banner?: string | null | undefined;
welcomeScreen?: { description: string | null; welcomeChannels: { channelId: string; description: string; emojiId: string | null; emojiName: string | null; }[]; } | undefined;

Methods

leave(): Promise<void | undefined>;

Leave the guild.

toString(): string;

Returns a string representation of an object.