npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

mxtorie-handler

v1.0.8

Published

An advanced handler for fast developpment

Downloads

9

Readme

Mxtorie Handler

This module is useful to make fast commands. Advanced handler using this module : https://github.com/Jeotique/mxtorie-optimised-handler

image

How to use it ?

First you will need to create a custom client class

const {Mxtorie_Client, Command} = require('./index')
const client = new Mxtorie_Client()
client.login("") // <-- your secret token

And now you can create a command :

const myFirstCommand = new Command(client, {
    name: "ping",
    description: "Return the bot latency"
})
myFirstCommand.run = async(data) => {
    const {message} = data
    message.reply(`${client.ws.ping}ms`)
}

So for the moment we have that :

const {Mxtorie_Client, Command} = require('./index')
const client = new Mxtorie_Client()
client.login("") // <-- your secret token
const myFirstCommand = new Command(client, {
    name: "ping",
    description: "Return the bot latency"
})
myFirstCommand.run = async(data) => {
    const {message} = data
    message.reply(`${client.ws.ping}ms`)
}

If you try it you will see everything is working nice. But now we will make an advanced command :

const mySecondCommand = new Command(client, {
    name: "haverole",
    description: "Return if this member have this role or not",
    permission: "MANAGE_ROLES", //<-- the executor will need to have this permission
    noPermissionReply: "You don't have the required permission",
    arguments: [
        {
            name: 'member', //<-- this the futur variable name in the data object
            //type can be : member, role, user, channel, string(or normal)
            type: 'member', //<-- will resolve and return a guildMember class with a mention or id
            required: true, //<-- if required and not given the bot wil answer with the missingResponse
            invalidResponse: 'The member is invalid', //<-- if the mention or the id is invalid for a member
            missingResponse: 'The member is missing' //<-- if the mention or the id is missing for a member
        }, 
        {
            name: 'role',
            type: 'role', //<-- will resolve and return a Role class with a mention or id
            required: true,
            invalidResponse: 'The role is invalid',
            missingResponse: 'The role is missing'
        }
    ]
})
mySecondCommand.run = async(data) => {
    const {message, member, role} = data // <-- so here we get the variables declared above
    if(member.roles.cache.has(role.id)) return message.reply(`Yes \`${member.user.tag}\` have the role \`${role.name}\``)
    else return message.reply(`No \`${member.user.tag}\` doesn't have the role \`${role.name}\``)
}

Now for a kick command :

myThirdCommand = new Command(client, {
    name: 'kick',
    aliases: ['expulse'],
    description: "Will kick a member from the guild",
    permission: "KICK_MEMBERS",
    noPermissionReply: "You don't have the required permission",
    arguments: [
        {
            name: 'member',
            type: 'member',
            required: true,
            invalidResponse: 'The member is invalid',
            missingResponse: 'The member is missing'
        },
        {
            name: 'reason',
            type: 'normal',
            required: false,
            long: true
        }
    ]
})
myThirdCommand.run = async(data) => {
    const {message, member, reason} = data
    member.kick(reason ?? "no reason given").then(() => {
        message.reply(`${member.user.tag} has been kicked`)
    }).catch(e=>{
        message.reply(`I can't kick ${member.user.tag}`)
    })
}

In the variable reason what long property ? +kick <@member> this is the reason

long: false -> reason = 'this'

long: true -> reason = 'this is the reason'

So now you have the base of the module, for any help request you can find me on my discord server

Final result :

const {Mxtorie_Client, Command} = require('./index')
const client = new Mxtorie_Client()
client.login("") // <-- your secret token

const myFirstCommand = new Command(client, {
    name: "ping",
    description: "Return the bot latency"
})
myFirstCommand.run = async(data) => {
    const {message} = data
    message.reply(`${client.ws.ping}ms`)
}

const mySecondCommand = new Command(client, {
    name: "haverole",
    description: "Return if this member have this role or not",
    permission: "MANAGE_ROLES", //<-- the executor will need to have this permission
    noPermissionReply: "You don't have the required permission",
    arguments: [
        {
            name: 'member', //<-- this the futur variable name in the data object
            //type can be : member, role, user, channel, string(or normal)
            type: 'member', //<-- will resolve and return a guildMember class with a mention or id
            required: true, //<-- if required and not given the bot wil answer with the missingResponse
            invalidResponse: 'The member is invalid', //<-- if the mention or the id is invalid for a member
            missingResponse: 'The member is missing' //<-- if the mention or the id is missing for a member
        }, 
        {
            name: 'role',
            type: 'role', //<-- will resolve and return a Role class with a mention or id
            required: true,
            invalidResponse: 'The role is invalid',
            missingResponse: 'The role is missing'
        }
    ]
})
mySecondCommand.run = async(data) => {
    const {message, member, role} = data // <-- so here we get the variables declared above
    if(member.roles.cache.has(role.id)) return message.reply(`Yes \`${member.user.tag}\` have the role \`${role.name}\``)
    else return message.reply(`No \`${member.user.tag}\` doesn't have the role \`${role.name}\``)
}

myThirdCommand = new Command(client, {
    name: 'kick',
    aliases: ['expulse'],
    description: "Will kick a member from the guild",
    permission: "KICK_MEMBERS",
    noPermissionReply: "You don't have the required permission",
    arguments: [
        {
            name: 'member',
            type: 'member',
            required: true,
            invalidResponse: 'The member is invalid',
            missingResponse: 'The member is missing'
        },
        {
            name: 'reason',
            type: 'normal',
            required: false,
            long: true
        }
    ]
})
myThirdCommand.run = async(data) => {
    const {message, member, reason} = data
    member.kick(reason ?? "no reason given").then(() => {
        message.reply(`${member.user.tag} has been kicked`)
    }).catch(e=>{
        message.reply(`I can't kick ${member.user.tag}`)
    })
}