Preview environment

class Widget

extends

Base
export class Widget extends Base

Represents a Widget.

channels : Collection<Snowflake, WidgetChannel>

The list of channels in the guild.

readonly
client : Client<true>

The client that instantiated this

Inherited from: Base

id : Snowflake

The id of the guild.

optional
instantInvite? : string

The invite of the guild.

members : Collection<string, WidgetMember>

The list of members in the guild. These strings are just arbitrary numbers, they aren't Snowflakes.

name : string

The name of the guild.

presenceCount : number

The number of members online.

fetch() : Promise<Widget>

Update the Widget.

imageURL(
style?: GuildWidgetStyle
) : string

Returns a URL for the PNG widget of the guild.

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

Inherited from: Base

valueOf() : string

Inherited from: Base