@zikeji/hypixel / Guild

Class: Guild

Example

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

Extends

• Method

Methods

API

id()

id(id): Promise<ResultObject<GuildResponse, ["guild"]>>

Returns the guild by the requested ID if found.

Parameters

id

string

Returns

Promise<ResultObject<GuildResponse, ["guild"]>>

Example

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

---

name()

name(name): Promise<ResultObject<GuildResponse, ["guild"]>>

Returns the guild by the requested guild name if found.

Parameters

name

string

Returns

Promise<ResultObject<GuildResponse, ["guild"]>>

Example

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

---

player()

player(player): Promise<ResultObject<GuildResponse, ["guild"]>>

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

Parameters

player

string

Returns

Promise<ResultObject<GuildResponse, ["guild"]>>

Example

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