From e48f2ffae305dc35f80060b6098c40ed6314bffe Mon Sep 17 00:00:00 2001 From: abalabahaha Date: Sat, 30 Apr 2016 11:58:12 -0700 Subject: [PATCH] Add setNickname docs --- docs/docs_client.rst | 11 +++++++++++ docs/docs_server.rst | 7 +++++++ lib/Client/Client.js | 5 +++++ src/Client/Client.js | 5 +++++ 4 files changed, 28 insertions(+) diff --git a/docs/docs_client.rst b/docs/docs_client.rst index c35d8c289..1be8a47e6 100644 --- a/docs/docs_client.rst +++ b/docs/docs_client.rst @@ -702,6 +702,17 @@ Server-undeafens a member. - **callback** - `function` taking the following: - **error** - error if any occurred. +setNickname(server, nickname, `user`, `callback`) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Set the nickname of a user on a server. + +- **server** - A `Server Resolvable`_ to set the nickname of the user in +- **nickname** - `string` of the nickname +- **user** - The `User Resolvable`_ to perform the nickname change on. If no user is specified, this will change the bot user's nickname +- **callback** - `function` taking the following: + - **error** - error if any occurred. + Events ------ diff --git a/docs/docs_server.rst b/docs/docs_server.rst index bb3ea1fc5..3f06ba6bb 100644 --- a/docs/docs_server.rst +++ b/docs/docs_server.rst @@ -166,6 +166,12 @@ kickMember(user, `callback`) | **Aliases** `kickUser, kick` | **See** client.kickMember_ +setNickname(nickname, user, `callback`) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +| **Shortcut of** ``client.setNickname(server, nickname, user, callback)`` +| **See** client.setNickname_ + .. _client.leaveServer : ./docs_client.html#leaveserver-server-callback .. _client.createInvite : ./docs_client.html#createinvite-channel-options-callback .. _client.createRole : ./docs_client.html#createrole-server-data-callback @@ -173,4 +179,5 @@ kickMember(user, `callback`) .. _client.banMember : ./docs_client.html#banmember-user-server-length-callback .. _client.unbanMember : ./docs_client.html#unbanmember-user-server-callback .. _client.kickMember : ./docs_client.html#kickmember-user-server-callback +.. _client.setNickname : ./docs_client.html#setNickname-server-nickname-user-callback .. _client.getBans : ./docs_client.html#getbans-server-callback diff --git a/lib/Client/Client.js b/lib/Client/Client.js index 4abbb7b36..cb9688405 100644 --- a/lib/Client/Client.js +++ b/lib/Client/Client.js @@ -755,6 +755,11 @@ var Client = (function (_EventEmitter) { Client.prototype.setNickname = function setNickname(server, nick, user) { var callback = arguments.length <= 3 || arguments[3] === undefined ? function () /*err, {}*/{} : arguments[3]; + if (typeof user === "function") { + // user is the callback + callback = user; + user = null; + } if (!user) { user = this.user; } diff --git a/src/Client/Client.js b/src/Client/Client.js index 4381ecd13..a0cf66b73 100644 --- a/src/Client/Client.js +++ b/src/Client/Client.js @@ -812,6 +812,11 @@ export default class Client extends EventEmitter { // def setNickname setNickname(server, nick, user, callback = (/*err, {}*/) => { }) { + if (typeof user === "function") { + // user is the callback + callback = user; + user = null; + } if(!user) { user = this.user; }