@skyra/editable-commands
TypeScript icon, indicating that this package has built-in type declarations

3.0.2 • Public • Published

Skyra Logo

@skyra/editable-commands

A framework agnostic library for editable commands

GitHub

npm

Support Server


Features

  • @skyra/editable-commands is a framework agnostic implementation of editable commands for discord.js v13.
  • Supports CommonJS and ES Modules.

Installation

You can use the following command to install this package, or replace npm install with your package manager of choice.

npm install @skyra/editable-commands

Usage

JavaScript

Without a framework

const { send } = require('@skyra/editable-commands');

client.on('messageCreate', (message) => {
	send(message, 'This is my reply!');
});

client.on('messageUpdate', (_oldMessage, newMessage) => {
	send(newMessage, 'This is my new reply!');
});
const { Command } = require('@sapphire/framework');
const { MessageEmbed } = require('discord.js');
const { send } = require('@skyra/editable-commands');

module.exports = class UserCommand extends Command {
	constructor(context, options) {
		super(context, {
			...options,
			description: 'A very cool command',
			requiredClientPermissions: ['EMBED_LINKS']
		});
	}

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

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

TypeScript

Without a framework

import { send } from '@skyra/editable-commands';

client.on('messageCreate', (message) => {
	send(message, 'This is my reply!');
});

client.on('messageUpdate', (_oldMessage, newMessage) => {
	send(newMessage, 'This is my new reply!');
});
import { ApplyOptions } from '@sapphire/decorators';
import { Command, CommandOptions } from '@sapphire/framework';
import { Message, MessageEmbed } from 'discord.js';
import { send } from '@skyra/editable-commands';

@ApplyOptions<CommandOptions>({
	description: 'A very cool command',
	requiredClientPermissions: ['EMBED_LINKS']
})
export class UserCommand extends Command {
	public run(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] });
	}
}

Buy us some doughnuts

Skyra Project is open source and always will be, even if we don't get donations. That said, we know there are amazing people who may still want to donate just to show their appreciation. Thanks you very much in advance!

We accept donations through Patreon, BitCoin, Ethereum, and Litecoin. You can use the buttons below to donate through your method of choice.

Donate With QR Address
Patreon PatreonImage Click Here
PayPal PayPalImage Click Here
BitCoin BitcoinImage 3JNzCHMTFtxYFWBnVtDM9Tt34zFbKvdwco
Ethereum EthereumImage 0xcB5EDB76Bc9E389514F905D9680589004C00190c
Litecoin LitecoinImage MNVT1keYGMfGp7vWmcYjCS8ntU8LNvjnqM

Contributors

Please make sure to read the Contributing Guide before making a pull request.

Thank you to all the people who already contributed to Skyra Project!

Package Sidebar

Install

npm i @skyra/editable-commands

Weekly Downloads

873

Version

3.0.2

License

MIT

Unpacked Size

33.5 kB

Total Files

10

Last publish

Collaborators

  • favna
  • kyranet