TypeDoc API
Plugins
Plugin Discord
classes
Membertransformer

Class: MemberTransformer

Transformer for GuildMember (opens in a new tab).

Properties:

id: Gives member id.
mention: Mentions the member.
username: Gives username of the member.
discriminator: Gives discriminator of the member
tag: Gives username#discriminator
avatar: Gives member's custom avatar if they have one. Else it'll be an empty string.
displayAvatar: Gives member's avatar URL if they have one else gives member's default avatar.
nickname: Gives member's nickname.
displayName: Gives member's display name. (nickname if they have one else username)
joinedAt: Gives member's join date.
joinedTimestamp: Gives member's join date in ms
createdAt: Gives member's account create date.
createdTimestamp: Gives member's account created date in ms
bot: Gives true if the member is a bot else false.
color: Gives member's highest role color.
position: Gives member's highest role position.
roles: Gives member's roles.
roleIds: Gives member's roles ids.
roleNames: Gives member's roles names.
topRole: Gives member's highest role name.
timeoutUntil: Gives member's timeout until date.
timeoutUntilTimestamp: Gives member's timeout until date in ms.

Remarks

You need to use StrictVarsParser parser to use this transformer.

Example

import { Interpreter, StrictVarsParser } from 'tagscript';
import { MemberTransformer } from 'tagscript-plugin-discord';
 
const ts = new Interpreter(new StrictVarsParser());
 
await ts.run('Hi {member}', { member: new MemberTransformer(GuildMember) });
// Hi <@758880890159235083>

Hierarchy

Constructors

constructor

new MemberTransformer(base, safeValues?)

Parameters

NameType
baseGuildMember (opens in a new tab)
safeValuesSafeValues<GuildMember (opens in a new tab)>

Inherited from

BaseTransformer.constructor

Properties

base

Protected base: GuildMember (opens in a new tab)

Inherited from

BaseTransformer.base


safeValues

Protected safeValues: SafeValues<GuildMember (opens in a new tab)> = {}

Inherited from

BaseTransformer.safeValues

Methods

transform

transform(tag): null | string

Transforms the given tag.

Parameters

NameTypeDescription
tagLexerThe tag that triggered the transformer.

Returns

null | string

Inherited from

BaseTransformer.transform


updateSafeValues

Protected updateSafeValues(): void

Returns

void

Overrides

BaseTransformer.updateSafeValues