Class: GuildTransformer

Defined in: tagscript-plugin-discord/src/lib/Transformer/Guild.ts:52

Transformer for a Discord APIGuild payload.

Properties:

id: Gives guild id.
name: Gives guild name.
description: Gives guild description.
icon: Gives guild icon.
splash: Gives guild splash.
banner: Gives guild banner.
features: Gives guild features.
ownerId: Gives guild owner id.
createdAt: Gives guild create date.
createdTimestamp: Gives guild create date in ms.
memberCount: Gives guild member count, when the payload was fetched with counts.
roles: Mentions each guild role.
roleIds: Gives guild roles ids.
roleNames: Gives guild roles names.
roleCount: Gives guild roles count.
emojiCount: Gives guild emojis count.
stickerCount: Gives guild stickers count.
afkTimeout: Gives guild afk timeout.
afkChannel: Mentions the guild afk channel.
verificationLevel: Gives guild verification level.

Remarks

You need to use StrictVarsParser parser to use this transformer.

memberCount reads approximate_member_count, which Discord only sends when you ask for it with with_counts. Channels are a separate endpoint and are not part of a guild payload, so pass counts you want a template to see: new GuildTransformer(guild, { channelCount: channels.length }).

Example

import { Interpreter, StrictVarsParser } from 'tagscript';
import { GuildTransformer } from '@tagscript/plugin-discord';

const ts = new Interpreter(new StrictVarsParser());

await ts.run('server name: {guild.name}', { guild: new GuildTransformer(guild) });
// server name: My Server