Nomchy/discord.js
1
0
Fork 0
mirror of https://github.com/discordjs/discord.js.git synced 2026-03-09 16:13:31 +01:00
Code Issues Packages Projects Releases Wiki Activity

Clean up sentence structure, add more details, etc (#606)

Browse Source 
* Clean up sentence structure, add more details, etc

* Build docs
This commit is contained in:
Schuyler Cebulskie
2016-09-04 16:33:44 -04:00
committed by Amish Shah
parent 5bd258a557
commit 28169c0f55
2 changed files with 13 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
docs/custom/documents/updating.md
View File

@@ -1,19 +1,20 @@
# About Version 9.0
The 9.0 rewrite takes a much more OOP approach than previous versions, which allows code to be much more manageable.
It's been rebuilt from the ground up and should be much more stable, fixing caching issues that affected
older versions and it also has support for new Discord Features, such as emojis.
older versions. It also has support for newer Discord Features, such as emojis.
## Guides
* [https://eslachance.gitbooks.io/discord-js-bot-guide/content/](https://eslachance.gitbooks.io/discord-js-bot-guide/content/)
* [https://yorkaargh.wordpress.com/2016/09/03/updating-discord-js-bots/](https://yorkaargh.wordpress.com/2016/09/03/updating-discord-js-bots/)
* [York's v9 upgrade guide](https://yorkaargh.wordpress.com/2016/09/03/updating-discord-js-bots/)
* [LuckyEvie's general bot guide (being updated)](https://eslachance.gitbooks.io/discord-js-bot-guide/content/)
## Upgrading your code
Version 9, while containing a number of breaking changes, does not require a lot of changes in the code logic.
It does, however, require changes in some of the method changes. This is because most of the methods have been
moved away from the <Client> class into other classes where they belong.
Here are a few examples of methods that has changed:
Version 9, while containing a sizable number of breaking changes, does not require much change in your code's logic -
most of the concepts are still the same, but loads of functions have been moved around.
The vast majority of methods you're used to using have been moved out of the Client class,
into other more relevant classes where they belong.
Because of this, you will need to convert most of your calls over to the new methods.
Here are a few examples of methods that have changed:
* `Client.sendMessage(channel, message)` ==> `TextChannel.sendMessage(message)`
* `Client.sendMessage(user, message)` ==> `User.sendMessage(message)`
* `Client.updateMessage(message, "New content")` ==> `Message.edit("New Content")`
@@ -21,16 +22,13 @@ Here are a few examples of methods that has changed:
* `Server.detailsOfUser(User)` ==> `Server.members.get(User).properties` (retrieving a member gives a GuildMember object)
* `Client.joinVoiceChannel(voicechannel)` => `VoiceChannel.join()`
A couple more important details:
A couple more important details:
* `Client.loginWithToken("token")` ==> `client.login("token")`
* `Client.servers.length` ==> `client.guilds.size` (all instances of `server` are now `guild`)
## Callbacks
Version 9.0 eschews callbacks in favour of Promises. This means all code relying on callbacks must be changed.
For example, the following code:
Version 9.0 eschews callbacks in favour of Promises. This means all code relying on callbacks must be changed.
For example, the following code:
```js
bot.getChannelLogs(channel, 100, function(messages) {

2
docs/docs.json
View File

File diff suppressed because one or more lines are too long