dan/discord.js
1
0
Fork 0
mirror of https://github.com/danbulant/discord.js synced 2026-06-10 02:02:40 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update to docs

Browse source
This commit is contained in:
hydrabolt 2015-09-26 13:47:42 +01:00
parent fc9c46d1a2
commit 3e9af4454d
1 changed files with 6 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
docs/docs_client.rst
View file

@ -4,8 +4,8 @@ Client Documentation
Attributes Attributes
---------- ----------
``options`` options
~~~~~~~~~~~ ~~~~~~~
An `Object` containing a configuration for the Client. Currently can only be configured like so: An `Object` containing a configuration for the Client. Currently can only be configured like so:
.. code-block:: js .. code-block:: js
@ -15,12 +15,12 @@ An `Object` containing a configuration for the Client. Currently can only be con
// just send straight away. // just send straight away.
} }
``token`` token
~~~~~~~~~ ~~~~~
A `String` that is the token received after logging in. It is used to authorise the Client when joining WebSockets or making HTTP requests. A `String` that is the token received after logging in. It is used to authorise the Client when joining WebSockets or making HTTP requests.
``state`` state
~~~~~~~~~ ~~~~~
An `Integer` representing what state of connection the Client is in. An `Integer` representing what state of connection the Client is in.
- **0** is idle, meaning the Client has been created but no login attempts have been made. - **0** is idle, meaning the Client has been created but no login attempts have been made.