oceanic.js
Version:
A NodeJS library for interfacing with Discord.
51 lines (50 loc) • 2.05 kB
TypeScript
/** @module GuildPreview */
import Base from "./Base";
import type Client from "../Client";
import type { GuildFeature, ImageFormat } from "../Constants";
import type { GuildEmoji, RawGuildPreview, RawSticker } from "../types/guilds";
import type { JSONGuildPreview } from "../types/json";
/** Represents a preview of a guild. */
export default class GuildPreview extends Base {
/** The approximate number of members in this guild. */
approximateMemberCount: number;
/** The approximate number of online members in this guild. */
approximatePresenceCount: number;
/** The description of this guild. */
description: string | null;
/** The discovery splash hash of this guild. */
discoverySplash: string | null;
/** The emojis of this guild. */
emojis: Array<GuildEmoji>;
/** The [features](https://discord.com/developers/docs/resources/guild#guild-object-guild-features) of this guild. */
features: Array<GuildFeature>;
/** The icon hash of this guild. */
icon: string | null;
/** The name of this guild. */
name: string;
/** The invite splash of this guild. */
splash: string | null;
/** The stickers in this guild. */
stickers: Array<RawSticker>;
constructor(data: RawGuildPreview, client: Client);
protected update(data: RawGuildPreview): void;
/**
* The url of this guild's discovery splash.
* @param format The format the url should be.
* @param size The dimensions of the image.
*/
discoverySplashURL(format?: ImageFormat, size?: number): string | null;
/**
* The url of this guild's icon.
* @param format The format the url should be.
* @param size The dimensions of the image.
*/
iconURL(format?: ImageFormat, size?: number): string | null;
/**
* The url of this guild's invite splash.
* @param format The format the url should be.
* @param size The dimensions of the image.
*/
splashURL(format?: ImageFormat, size?: number): string | null;
toJSON(): JSONGuildPreview;
}