Tagscript

UserTransformer

TagScript


Class: UserTransformer

Defined in: tagscript-plugin-discord/src/lib/Transformer/User.ts:39

Transformer for a Discord APIUser payload.

Properties:

id: Gives user id.
mention: Mentions the user.
globalName: Gives user's global name.
username: Gives username of the user.
discriminator: Gives discriminator of the user
tag: Gives username#discriminator for legacy accounts, username otherwise.
avatar: Gives user's custom avatar if they have one. Else it'll be an empty string.
displayAvatar: Gives user's avatar URL if they have one else gives user's default avatar.
createdAt: Gives user's account create date.
createdTimestamp: Gives user's account created date in ms
bot: Gives true if the user is a bot else false.

Remarks

You need to use StrictVarsParser parser to use this transformer.

Example

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

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

await ts.run('Hi {user}', { user: new UserTransformer(user) });
// Hi <@758880890159235083>

Extends

Constructors

Constructor

new UserTransformer(base, safeValues?): UserTransformer

Defined in: tagscript-plugin-discord/src/lib/Transformer/Base.ts:28

Parameters

base

APIUser

safeValues?

SafeValues<APIUser> = {}

Returns

UserTransformer

Inherited from

BaseTransformer.constructor

Properties

base

protected base: APIUser

Defined in: tagscript-plugin-discord/src/lib/Transformer/Base.ts:24

Inherited from

BaseTransformer.base


safeValues

protected safeValues: SafeValues<APIUser> = {}

Defined in: tagscript-plugin-discord/src/lib/Transformer/Base.ts:26

Inherited from

BaseTransformer.safeValues

Methods

resolveId()

protected resolveId(): string

Defined in: tagscript-plugin-discord/src/lib/Transformer/User.ts:40

The snowflake this payload is identified by. Read as {thing.id}.

Returns

string

Overrides

BaseTransformer.resolveId


resolveMention()

protected resolveMention(): string

Defined in: tagscript-plugin-discord/src/lib/Transformer/User.ts:44

What a bare {thing} renders to.

Returns

string

Overrides

BaseTransformer.resolveMention


toJSON()

toJSON(): SafeValues<APIUser>

Defined in: tagscript-plugin-discord/src/lib/Transformer/Base.ts:45

Returns

SafeValues<APIUser>

Inherited from

BaseTransformer.toJSON


transform()

transform(tag): string | null

Defined in: tagscript-plugin-discord/src/lib/Transformer/Base.ts:37

Transforms the given tag.

Parameters

tag

Lexer

The tag that triggered the transformer.

Returns

string | null

Inherited from

BaseTransformer.transform


updateSafeValues()

protected updateSafeValues(): void

Defined in: tagscript-plugin-discord/src/lib/Transformer/User.ts:48

Returns

void

Overrides

BaseTransformer.updateSafeValues

On this page