Class: Guild

Hierarchy

• Method

  ↳ Guild

API Methods

id

▸ id(id: string): Promise<Guild & { meta: Omit<GuildResponse, guild> & DefaultMeta }>

Returns the guild by the requested ID if found.

example

const guild = await client.guild.id("553490650cf26f12ae5bac8f");

Parameters:

Name	Type
id	string

Returns: Promise<Guild & { meta: Omit<GuildResponse, guild> & DefaultMeta }>

Defined in: methods/guild.ts:14 (opens new window)

---

name

▸ name(name: string): Promise<Guild & { meta: Omit<GuildResponse, guild> & DefaultMeta }>

Returns the guild by the requested guild name if found.

example

const guild = await client.guild.name("Mini Squid");

Parameters:

Name	Type
name	string

Returns: Promise<Guild & { meta: Omit<GuildResponse, guild> & DefaultMeta }>

Defined in: methods/guild.ts:52 (opens new window)

---

player

▸ player(player: string): Promise<Guild & { meta: Omit<GuildResponse, guild> & DefaultMeta }>

Returns the guild by the requested player's UUID if found.

example

const guild = await client.guild.player("20934ef9488c465180a78f861586b4cf");

Parameters:

Name	Type
player	string

Returns: Promise<Guild & { meta: Omit<GuildResponse, guild> & DefaultMeta }>

Defined in: methods/guild.ts:33 (opens new window)