Link Search Menu Expand Document (external link)
Documentation

Birb / GuildPartial

Class: GuildPartial

Hierarchy

Table of contents

Constructors

Properties

Methods

Constructors

constructor

• new GuildPartial(client, guild)

Parameters

Name Type
client Birb
guild APIGuild | APIGuildPartial

Defined in

src/classes/GuildPartial.ts:23

Properties

available

• available: boolean = false

It is recommended to check if this value is true before performing actions on the guild. If this value is false, the guild is unavailable due to a temporary Discord outage.

Defined in

src/classes/GuildPartial.ts:21

client

• client: Birb

The Birb client

Defined in

src/classes/GuildPartial.ts:11

id

• Readonly id: string

The guild’s ID (snowflake) as a string

Defined in

src/classes/GuildPartial.ts:15

Methods

fetch

▸ fetch(): Promise<Guild>

Returns

Promise<Guild>

Defined in

src/classes/GuildPartial.ts:36

isPartial

▸ isPartial(): boolean

Returns

boolean

true if this is a partial guild, false otherwise.

Defined in

src/classes/GuildPartial.ts:60