Transformers

What is a transformer?

Basically, a transformer is a function that takes an object and transforms it into another value. In Seyfert, transformers are used to transform data coming from Discord into any values you need.

How are they used?

Let's look at an example of a transformer.

import { Transformers } from 'seyfert';
 
Transformers.User = (client, data) => {
    return {
        username: data.username,
        isAdmin: Math.random() > 0.5,
        raw() {
            return client.users.raw(data.id);
        },
    };
};
 
/*
At this point, you should have a `declare module "seyfert"` in your project, 
if not, add it.
*/
declare module "seyfert" {
// Declaring the type this way will reflect in the typing throughout the entire project.
    interface CustomStructures {
        User: MyUser;
    }
// You can add as many transformers as you like with any type.
}

Let the autocomplete of your editor guide you and discover all the possibilities you have.

import { Transformers } from 'seyfert';
 
Transformers.GuilGuild
GuildBan
GuildEmoji
GuildMember
GuildRole
GuildTemplatedMember

How can I use them?

For example, we defined a transformer for the user earlier, now let's see how we can use it.

import { type CommandContext, Command, Declare } from 'seyfert';
 
@Declare({
    name: 'ping',
    description: 'Ping!',
})
class Ping extends Command {
    async run(ctx: CommandContext) {
        const result = await ctx.author.isAdmin
raw
usernameraw();
        console.log(result.id, result.username);
    }
}

Transformers

What is a transformer?

How are they used?

How can I use them?

On this page