Skip to main content

Plugin Editable Commands

Introduction

@sapphire/plugin-editable-commands is a tiny wrapper on top of @skyra/editable-commands that re-exports everything and registers a listener to make commands also run on message edit.

Installation

npm install @sapphire/plugin-editable-commands @sapphire/framework

Usage

In your main or setup file, register the plugin:

require('@sapphire/plugin-editable-commands/register');

Then use send or reply from the package, as shown below:

import { Command } from '@sapphire/framework';
import { Message, MessageEmbed } from 'discord.js';
import { send } from '@sapphire/plugin-editable-commands';

export class UserCommand extends Command {
public constructor(context: Command.Context, options: Command.Options) {
super(context, {
...options,
description: 'A very cool command',
requiredClientPermissions: ['EMBED_LINKS']
});
}

messageRun(message: Message) {
const embed = new MessageEmbed()
.setURL('https://github.com/skyra-project/editable-commands')
.setColor('#7586D8')
.setDescription('Example description')
.setTimestamp();

return send(message, { embeds: [embed] });
}
}