feat: add TS devOnlyServer plugin (#42)

* feat: add TS devOnlyServer plugin

This plugin will send an error message when the command is ran outside of the specified guild id(s).
If there is no `perFail` message provided, the code will provide an error.

* feat: edit devServerOnly plugin

EDIT: Checks if the fail message exists.

* refactor: changed name of plugin

Changed name of plugin devOnlyServer.ts to serverOnly.ts

* refactor: changed name of plugin on sample command

Forgot to change name of plugin on the sample command during previous refactor.

* refactor: update default failMessage parameter.

Correct default fail message.
This commit is contained in:
George Needham
2022-09-24 12:53:16 -05:00
committed by GitHub
parent 88970e147b
commit e3526750d2

43
TypeScript/serverOnly.ts Normal file
View File

@@ -0,0 +1,43 @@
// @ts-nocheck
/**
* Checks if a command is available in a specific server.
*
* @author @D3ord3NidAm [<@1017182455926624316>]
* @version 1.0.0
* @example
* ```ts
* import { commandModule, CommandType } from "@sern/handler";
* import { serverOnly } from "../plugins/serverOnly";
* export default commandModule({
* type: CommandType.Both,
* plugins: [serverOnly(["guildId"], failMessage)], // fail message is the message you will see when the command is ran in the wrong server.
* description: "command description",
* execute: async (ctx, args) => {
* // your code here
* },
* });
* ```
*/
import { CommandType, EventPlugin, PluginType } from "@sern/handler";
export function serverOnly(
guildId: string[],
failMessage = "I am unable to comply with your command."
): EventPlugin<CommandType.Both> {
return {
type: PluginType.Event,
description: "Checks if a command is available in a specific server.",
async execute([ctx, args], controller) {
if (!guildId.includes(ctx.guildId)) {
await ctx.reply(failMessage).then(async (m) => {
setTimeout(async () => {
await m.delete();
}, 3000);
});
return controller.stop();
}
return controller.next();
},
};
}