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

docs

Browse Source
This commit is contained in:
hydrabolt
2015-09-27 19:48:45 +01:00
parent 626f7eab6b
commit d27638b421
3 changed files with 19 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
docs/docs_client.rst
View File

@@ -1,3 +1,5 @@
.. include:: ./vars.rst
Client Documentation
====================
@@ -79,11 +81,11 @@ A `Boolean` that is true if the client is ready. A shortcut to checking if ``bot
servers
~~~~~~~
An `Array` of Server_ objects that the client has access to. Represents the servers the client is in.
An `Array` of Server_ objects that the client has access to.
channels
~~~~~~~~
An `Array` of Channel_ objects that the client has access to. Represents the channels the client can access.
An `Array` of Channel_ objects that the client has access to.
users
~~~~~
@@ -98,10 +100,4 @@ messages
An `Array` of Message_ objects the client has received over its uptime.
Functions
---------
.. _User : #user
.. _ready : #ready
.. _Server : #server
.. _Channel : #channel
.. _Message : #message
---------

9
docs/docs_resolvable.rst Normal file
View File

@@ -0,0 +1,9 @@
Resolvable Documentation
========================
To be robust, discord.js needs to handle a wide amount of ambiguous data that is supplied to it. This means you can use functions much more easily. Anything that is resolvable means it can be normalised without you having to do it explicitly.
Channel Resolvable
------------------
A Channel Resolvable is data that can be resolved to a channel ID. Here is what is currently supported:

5
docs/vars.rst Normal file
View File

@@ -0,0 +1,5 @@
.. _User : #user
.. _ready : #ready
.. _Server : #server
.. _Channel : #channel
.. _Message : #message