GuildPreview

Represent Discord Guild Preview Object

Link

https://discord.com/developers/docs/resources/guild#guild-preview-object

Extends

• AnonymousGuild

Constructors

new GuildPreview(client, data)

new GuildPreview(client: UsingClient, data: APIGuildPreview): GuildPreview

Parameters

Parameter	Type
client	UsingClient
data	APIGuildPreview

Returns

GuildPreview

Overrides

AnonymousGuild.constructor

Source

seyfert/src/structures/GuildPreview.ts:10

Properties

Property	Modifier	Type	Inherited from
banner	public	undefined | null | string	AnonymousGuild.banner
client	readonly	UsingClient	AnonymousGuild.client
description	public	undefined | null | string	AnonymousGuild.description
features	public	undefined | GuildFeature[]	AnonymousGuild.features
icon	public	null | string	AnonymousGuild.icon
id	public	string	AnonymousGuild.id
name	public	string	AnonymousGuild.name
splash	public	null | string	AnonymousGuild.splash
vanityUrlCode	public	undefined | null | string	AnonymousGuild.vanityUrlCode
verificationLevel	public	undefined | GuildVerificationLevel	AnonymousGuild.verificationLevel
welcomeScreen	public	undefined | Object	AnonymousGuild.welcomeScreen

Accessors

createdAt

get createdAt(): Date

createdAt gets the creation Date instace of the current object.

Returns

Date

Source

seyfert/src/structures/extra/DiscordBase.ts:27

---

createdTimestamp

get createdTimestamp(): number

Create a timestamp for the current object.

Returns

number

Source

seyfert/src/structures/extra/DiscordBase.ts:20

---

partnered

get partnered(): boolean

Returns

boolean

Source

seyfert/src/structures/extra/BaseGuild.ts:11

---

verified

get verified(): boolean

If the guild is verified.

Link

https://discord.com/developers/docs/resources/guild#guild-object-guild-features

Returns

boolean

Source

seyfert/src/structures/extra/BaseGuild.ts:22

Methods

bannerURL()

bannerURL(options?: CDNUrlOptions): undefined | string

bannerURL gets the current guild banner as a string.

Parameters

Parameter	Type	Description
options?	CDNUrlOptions	Image options for the banner url.

Returns

undefined | string

Banner url or void

Inherited from

AnonymousGuild.bannerURL

Link

https://discord.com/developers/docs/reference#image-formatting

Source

seyfert/src/structures/extra/BaseGuild.ts:67

---

fetch()

fetch(): Promise<BaseGuild>

Fetch guild on API

Returns

Promise<BaseGuild>

Inherited from

AnonymousGuild.fetch

Source

seyfert/src/structures/extra/BaseGuild.ts:32

---

iconURL()

iconURL(options?: CDNUrlOptions): undefined | string

iconURL gets the current guild icon.

Parameters

Parameter	Type
options?	CDNUrlOptions

Returns

undefined | string

Inherited from

AnonymousGuild.iconURL

Link

https://discord.com/developers/docs/reference#image-formatting

Source

seyfert/src/structures/extra/BaseGuild.ts:41

---

splashURL()

splashURL(options?: CDNUrlOptions): undefined | string

splashURL gets the current guild splash as a string.

Parameters

Parameter	Type	Description
options?	CDNUrlOptions	Image options for the splash url.

Returns

undefined | string

Splash url or void.

Inherited from

AnonymousGuild.splashURL

Link

https://discord.com/developers/docs/reference#image-formatting

Source

seyfert/src/structures/extra/BaseGuild.ts:54

---

toString()

toString(): string

Returns

string

Inherited from

AnonymousGuild.toString

Source

seyfert/src/structures/extra/BaseGuild.ts:74