mirror of
https://github.com/discordjs/discord.js.git
synced 2026-03-13 10:03:31 +01:00
MORE DOCUMENTATION KANYE BELIEVE IT
This commit is contained in:
@@ -1,3 +1,5 @@
|
|||||||
|
.. include:: ./vars.rst
|
||||||
|
|
||||||
Resolvable Documentation
|
Resolvable Documentation
|
||||||
========================
|
========================
|
||||||
|
|
||||||
@@ -6,4 +8,12 @@ To be robust, discord.js needs to handle a wide amount of ambiguous data that is
|
|||||||
Channel Resolvable
|
Channel Resolvable
|
||||||
------------------
|
------------------
|
||||||
|
|
||||||
A Channel Resolvable is data that can be resolved to a channel ID. Here is what is currently supported:
|
A Channel Resolvable is data that can be resolved to a channel ID. Here is what is currently supported:
|
||||||
|
|
||||||
|
- A Channel_ object
|
||||||
|
- A Server_ object (the #general channel of the server will be used)
|
||||||
|
- A String_ representing the channel ID
|
||||||
|
- A Message_ (the channel the message was sent in will be used)
|
||||||
|
- A User_ (will get the PM channel with the specified user)
|
||||||
|
|
||||||
|
.. note:: A User cannot always be specified in certain cases. For example, if using `bot.setTopic`, a User or PM Channel can't be specified as these do not support channel topics.
|
||||||
@@ -16,6 +16,7 @@ Contents:
|
|||||||
.. _general-docs:
|
.. _general-docs:
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
|
:maxdepth: 2
|
||||||
:caption: General
|
:caption: General
|
||||||
|
|
||||||
get_started
|
get_started
|
||||||
@@ -25,9 +26,11 @@ Contents:
|
|||||||
.. _docs:
|
.. _docs:
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
|
:maxdepth: 2
|
||||||
:caption: Documentation
|
:caption: Documentation
|
||||||
|
|
||||||
docs_client
|
docs_client
|
||||||
|
docs_resolvable
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -2,4 +2,5 @@
|
|||||||
.. _ready : #ready
|
.. _ready : #ready
|
||||||
.. _Server : #server
|
.. _Server : #server
|
||||||
.. _Channel : #channel
|
.. _Channel : #channel
|
||||||
.. _Message : #message
|
.. _Message : #message
|
||||||
|
.. _PMChannel : #PMChannel
|
||||||
Reference in New Issue
Block a user