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

Updated getLogs docs to be valid for 4.1.0

Browse Source
This commit is contained in:
hydrabolt
2015-10-29 18:41:04 +00:00
parent c2e181f5bb
commit 2d2e2eba22
2 changed files with 8 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/conf.py
View File

@@ -55,9 +55,9 @@ author = u'hydrabolt'
# built documents. # built documents.
# #
# The short X.Y version. # The short X.Y version.
version = '3.10' version = '4.1'
# The full version, including alpha/beta/rc tags. # The full version, including alpha/beta/rc tags.
release = '3.10.1' release = '4.1.0'
# The language for content autogenerated by Sphinx. Refer to documentation # The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages. # for a list of supported languages.

7
docs/docs_client.rst
View File

@@ -250,13 +250,18 @@ Deletes the specified channel.
- **error** - An error if one occurred, otherwise it is null. - **error** - An error if one occurred, otherwise it is null.
getChannelLogs(channel, `amount`, `callback`) getChannelLogs(channel, `amount`, `options`, `callback`)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Gets previous messages from the specified channel. Gets previous messages from the specified channel.
- **channel** - A `Channel Resolvable`_ to take logs from. - **channel** - A `Channel Resolvable`_ to take logs from.
- **amount** - A `Number` that defaults to **500**. This is the amount of messages to try and get. - **amount** - A `Number` that defaults to **500**. This is the amount of messages to try and get.
- **options** - An `Object` containing the following values:
- **before** - A Message_ (or String ID) which will make the function return messages before this message.
- **after** - A Message_ (or String ID) which will make the function return messages after this message.
- **callback** - A `function` that can take the following parameters: - **callback** - A `function` that can take the following parameters:
- **error** - An error if one occurred, otherwise it is null. - **error** - An error if one occurred, otherwise it is null.