GuildBoost

classe · Source

Represents a guild boost in a guild on Discord.

Extends: Base

Properties

id

id: Snowflake

The id of the guild boost Source

subscriptionId

subscriptionId: Snowflake

The id of the subscription Source

premiumGuildSubscriptionId

nullable

premiumGuildSubscriptionId: Snowflake

The premium guild subscription id Source

guildId

nullable

guildId: Snowflake

Guild id Source

ended

nullable

ended: boolean

Ended ??? Source

canceled

canceled: boolean

Whether the subscription is canceled Source

cooldownEndsAt

cooldownEndsAt: Date

The cooldown end date Source

guilld

readonly · nullable

guilld: Guild

The guild of the boost Source

client

readonly

client: Client

The client that instantiated this Source

Methods

unsubscribe

async

async unsubscribe(): Promise<GuildBoost>

Cancel the boost Returns: Promise<GuildBoost>Source

subscribe

async

async subscribe(guild: GuildResolvable): Promise<GuildBoost>

Use the boost Parameters

Name	Type	Description
guild	GuildResolvable	The guild to use the boost on

Returns: Promise<GuildBoost>Source