tiny-essentials
Version:
Collection of small, essential scripts designed to be used across various projects. These simple utilities are crafted for speed, ease of use, and versatility.
18 lines • 820 B
text/typescript
/**
* Fetches the public widget data for a Discord guild (server).
* This includes online members, presence counts, and basic guild information,
* but only if the widget is enabled in the server settings.
*
* @param {string} guildID - The ID of the guild whose widget is to be fetched.
*
* @returns {Promise<Record<string, any>>} Resolves with the guild widget data if successful.
*
* @throws {Record<string, any>} If the request fails or the widget is disabled, rejects with an object containing a `code` and `message`.
*
* @example
* getGuildWidget('123456789012345678')
* .then((data) => console.log(data))
* .catch((err) => console.error('Widget error:', err));
*/
export default function getGuildWidget(guildID: string): Promise<Record<string, any>>;
//# sourceMappingURL=getGuildWidget.d.mts.map