chore: make jsdoc uniform

This commit is contained in:
EvolutionX
2022-08-06 12:42:23 +05:30
parent 4cee3590c7
commit d813d7f221
6 changed files with 34 additions and 25 deletions

View File

@@ -7,10 +7,12 @@
* @example
* ```ts
* import { cooldown } from "../plugins/cooldown";
* import { sernModule, CommandType } from "@sern/handler";
* import { commandModule } from "@sern/handler";
* export default commandModule({
* plugins: [cooldown.add( [ ['channel', '1/4'] ] )], // limit to 1 action every 4 seconds per channel
* execute: (ctx) => {}
* plugins: [cooldown.add( [ ['channel', '1/4'] ] )], // limit to 1 action every 4 seconds per channel
* execute: (ctx) => {
* //your code here
* }
* })
* ```
*/

View File

@@ -4,14 +4,15 @@
*
* @author @EvolutionX-10 [<@697795666373640213>]
* @version 1.0.0
* @requires `partials: [Partials.Channel], intents: [GatewayIntentBits.DirectMessages, GatewayIntentBits.MessageContent]
* @example
* ```ts
* import { dmOnly } from "../path/to/your/plugin/folder";
* import { dmOnly } from "../plugins/dmOnly";
* import { commandModule } from "@sern/handler";
* export default commandModule({
* plugins: [dmOnly()],
* execute: // your code
* plugins: [dmOnly()],
* execute: (ctx) => {
* //your code here
* }
* })
* ```
*/

View File

@@ -6,13 +6,13 @@
* @version 1.0.0
* @example
* ```ts
* import { nsfwOnly } from "../plugins/nsfwOnly"; //(change if need be)
* import { nsfwOnly } from "../plugins/nsfwOnly";
* import { sernModule, CommandType } from "@sern/handler";
* export default commandModule({
* plugins: [ nsfwOnly('response', true/false) ],
* execute: (ctx) => {
* //your code here
* }
* plugins: [ nsfwOnly('response', true/false) ],
* execute: (ctx) => {
* //your code here
* }
* })
* ```
*/

View File

@@ -6,10 +6,13 @@
* @version 1.0.0
* @example
* ```ts
* import { ownerOnly } from "../path/to/your/plugin/folder";
* import { sernModule, CommandType } from "@sern/handler";
* export default sernModule<CommandType.Slash>([OwnerOnly()], {
* // your code
* import { ownerOnly } from "../plugins/ownerOnly";
* import { commandModule } from "@sern/handler";
* export default commandModule({
* plugins: [ ownerOnly() ],
* execute: (ctx) => {
* //your code here
* }
* })
* ```
*/

View File

@@ -6,13 +6,13 @@
* @version 1.0.1
* @example
* ```ts
* import { permCheck } from "../plugins/permCheck"; //(change if need be)
* import { permCheck } from "../plugins/permCheck";
* import { sernModule, CommandType } from "@sern/handler";
* export default commandModule({
* plugins: [ permCheck('permission', 'No permission response') ],
* execute: (ctx) => {
* //your code here
* }
* plugins: [ permCheck('permission', 'No permission response') ],
* execute: (ctx) => {
* //your code here
* }
* })
* ```
*/

View File

@@ -6,10 +6,13 @@
* @version 1.1.0
* @example
* ```ts
* import { publish } from "../path/to/your/plugin/folder";
* import { sernModule, CommandType } from "@sern/handler";
* export default sernModule<CommandType.Slash>([publish()], { // put guild id in array for guild commands
* // your code
* import { publish } from "../plugins/publish";
* import { commandModule } from "@sern/handler";
* export default commandModule({
* plugins: [ publish() ], // put an array of guild ids for guild commands
* execute: (ctx) => {
* //your code here
* }
* })
* ```
*/