class BaseGuild

extends

abstract

export abstract class BaseGuild extends Base

The base class for Guild, OAuth2Guild and InviteGuild.

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

class BaseGuild

extends

Table of contents

Properties

Methods

Properties

readonly
client : Client<true>

readonly
createdAt : Date

readonly
createdTimestamp : number

features : `${GuildFeature}`[]

icon : string | null

id : Snowflake

name : string

readonly
nameAcronym : string

readonly
partnered : boolean

readonly
verified : boolean

Methods

fetch() : Promise<Guild>

iconURL(
options?: ImageURLOptions = {}
) : string | null

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

toString() : string

valueOf() : string

class BaseGuild

extends

Table of contents

Properties

Methods

Properties

readonlyclient : Client<true>

readonlycreatedAt : Date

readonlycreatedTimestamp : number

features : `${GuildFeature}`[]

icon : string | null

id : Snowflake

name : string

readonlynameAcronym : string

readonlypartnered : boolean

readonlyverified : boolean

Methods

fetch() : Promise<Guild>

iconURL(options?: ImageURLOptions = {}) : string | null

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

toString() : string

valueOf() : string

readonly
client : Client<true>

readonly
createdAt : Date

readonly
createdTimestamp : number

readonly
nameAcronym : string

readonly
partnered : boolean

readonly
verified : boolean

iconURL(
options?: ImageURLOptions = {}
) : string | null

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