diff options
| author | Neel Kamath <neelkamath@protonmail.com> | 2018-05-13 12:33:22 +0200 |
|---|---|---|
| committer | Neel Kamath <neelkamath@protonmail.com> | 2018-05-13 12:33:22 +0200 |
| commit | 343157350f627b9495184246a90033a1c41f1a2c (patch) | |
| tree | e8688471fbee2bdcd5834abcb559ea1694eecadf /server/src/commands/mod | |
| parent | Use the 'use strict' directive when needed (diff) | |
| download | hackchat-343157350f627b9495184246a90033a1c41f1a2c.tar.gz hackchat-343157350f627b9495184246a90033a1c41f1a2c.zip | |
Re-add module documentation
Diffstat (limited to 'server/src/commands/mod')
| -rw-r--r-- | server/src/commands/mod/ban.js | 6 | ||||
| -rw-r--r-- | server/src/commands/mod/kick.js | 6 | ||||
| -rw-r--r-- | server/src/commands/mod/unban.js | 6 |
3 files changed, 15 insertions, 3 deletions
diff --git a/server/src/commands/mod/ban.js b/server/src/commands/mod/ban.js index b2749ae..e19efc2 100644 --- a/server/src/commands/mod/ban.js +++ b/server/src/commands/mod/ban.js @@ -57,4 +57,8 @@ exports.run = async (core, server, socket, data) => { exports.requiredData = ['nick']; -exports.info = { name: 'ban' }; +exports.info = { + name: 'ban', + usage: 'ban {nick}', + description: 'Disconnects the target nickname in the same channel as calling socket & adds to ratelimiter' +}; diff --git a/server/src/commands/mod/kick.js b/server/src/commands/mod/kick.js index 5c72160..157592d 100644 --- a/server/src/commands/mod/kick.js +++ b/server/src/commands/mod/kick.js @@ -71,4 +71,8 @@ exports.run = async (core, server, socket, data) => { exports.requiredData = ['nick']; -exports.info = { name: 'kick' }; +exports.info = { + name: 'kick', + usage: 'kick {nick}', + description: 'Silently forces target client(s) into another channel. `nick` may be string or array of strings' +};
\ No newline at end of file diff --git a/server/src/commands/mod/unban.js b/server/src/commands/mod/unban.js index 5450858..e82f0b9 100644 --- a/server/src/commands/mod/unban.js +++ b/server/src/commands/mod/unban.js @@ -48,4 +48,8 @@ exports.run = async (core, server, socket, data) => { core.managers.stats.decrement('users-banned'); }; -exports.info = { name: 'unban' }; +exports.info = { + name: 'unban', + usage: 'unban {[ip || hash]}', + description: 'Removes target ip from the ratelimiter' +};
\ No newline at end of file |