Skip to main content
Module

x/hypixel/index.ts>FindGuild#byName

With thorough IntelliSense support & 100% test coverage, this is an unopinionated async/await API wrapper for Hypixel's Public API. It is developed in TypeScript complete with documentation, typed interfaces for all API responses (and an OpenAPI 3.0 schema!), built-in rate-limit handling, flexible cache support, helper functions, and support for undocumented endpoints.
zikeji/node-hypixel
Latest
method FindGuild.prototype.byName
Re-export
import { FindGuild } from "https://deno.land/x/hypixel@v3.1.1/index.ts";

Returns the id of the requested guild if found.

Examples

Example 1

const { guild } = await client.findGuild.byName("Mini Squid");
console.log(boosters);
// 553490650cf26f12ae5bac8f

Parameters

name: Components.Parameters.ByGuildName.ByName

Returns

Promise<ResultObject<Paths.FindGuild.Get.Responses.$200, ["success"]>>