MemberTransformer

MemberTransformer reads an APIGuildMember payload, which is a user plus everything specific to one guild: nickname, roles, join date and timeout.

For template authors

Syntax

{{member}}
{{member(key)}}
{{member.key}}

The bare tag renders the mention. A parameter picks one field.

Examples

Welcome {member}, you joined {date(R):{member(joinedTimestamp)}}.
# Welcome <@758880890159235083>, you joined <t:1642605059:R>.

Fields

Key	Gives
`id`	The user ID.
`mention`	A mention.
`name`	Empty, since a member payload has no `name`.
`username`	The username.
`discriminator`	The legacy discriminator.
`tag`	Username and discriminator, or just the username on a migrated account.
`avatar`	The account avatar URL, or empty.
`displayAvatar`	The avatar URL, falling back to the default avatar.
`nickname`	The guild nickname.
`displayName`	Nickname if set, then global name, then username.
`joinedAt`	Join date as an ISO string.
`joinedTimestamp`	Join time in milliseconds.
`createdAt`	Account creation date.
`createdTimestamp`	Account creation time in milliseconds.
`bot`	`true` or `false`.
`roles`	A mention per role.
`roleIds`	The role IDs.
`timeoutUntil`	When a timeout ends.
`timeoutUntilTimestamp`	Timeout end in milliseconds.

A key that does not exist leaves the tag in the output as written, so a typo is visible rather than silent.

For developers

Seeding one

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

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

const response = await ts.run(template, {
	member: new MemberTransformer(interaction.member),
});

A variable parser has to be registered for the tag to resolve.

Adding your own fields

Pass a second argument to expose extra keys. A function receives the payload and runs when the tag renders.

new MemberTransformer(member, {
	custom: 'a fixed value',
	computed: (base) => `${base.user.id} was looked up at render time`,
});

A member payload lists role IDs and carries no guild ID, so role names, the top role, the member colour and the per-guild avatar all need the guild alongside the member. Work them out once and pass them in:

const roles = guild.roles.filter((role) => member.roles.includes(role.id));

new MemberTransformer(member, {
	roleNames: roles.map((role) => role.name).join(', '),
	topRole: roles.reduce((highest, role) => (role.position > highest.position ? role : highest)).name,
});

API reference

MemberTransformer

MemberTransformer

On this page