From 6fd578e7d689351be48e1dcb3f1e9eecc1cc6d06 Mon Sep 17 00:00:00 2001 From: hydrabolt Date: Fri, 20 Nov 2015 21:49:48 +0000 Subject: [PATCH] Resolvable documentation --- docs/docs_resolvables.rst | 79 +++++++++++++++++++++++++++++++++++++++ docs/index.rst | 1 + docs/vars.rst | 1 + 3 files changed, 81 insertions(+) create mode 100644 docs/docs_resolvables.rst diff --git a/docs/docs_resolvables.rst b/docs/docs_resolvables.rst new file mode 100644 index 000000000..c2b248f39 --- /dev/null +++ b/docs/docs_resolvables.rst @@ -0,0 +1,79 @@ +.. include:: ./vars.rst + +Resolvables +=========== + +In discord.js, the aim is to allow the end developer to have freedom in what sort of data types they supply. References to any sort of resolvable basically mean what types of data you can provide. The different resolvables are shown before: + +Channel Resolvable +------------------ + +A Channel Resolvable allows: + +- Channel_ +- Server_ +- Message_ +- User_ (in some instances) +- String of Channel ID + +Voice Channel Resolvable +------------------------ + +A Voice Channel Resolvable allows: + +- VoiceChannel_ + +Message Resolvable +------------------ + +A Message Resolvable allows: + +- Message_ +- TextChannel_ +- PMChannel_ + +User Resolvable +--------------- + +A User Resolvable allows: + +- User_ +- Message_ +- TextChannel_ +- PMChannel_ +- Server_ +- String of User ID + +String Resolvable +----------------- + +A String Resolvable allows: + +- Array +- String + +Server Resolvable +----------------- + +A Server Resolvable allows: + +- Server_ +- ServerChannel_ +- Message_ (only for messages from server channels) +- String of Server ID + +Invite ID Resolvable +-------------------- + +An Invite ID Resolvable allows: + +- Invite_ +- String_ containing either a http link to the invite or the invite code on its own. + +Base64 Resolvable +----------------- + +A Base64 Resolvable allows: + +- Buffer +- String \ No newline at end of file diff --git a/docs/index.rst b/docs/index.rst index d9b7dd199..18238fb78 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -54,6 +54,7 @@ Contents: docs_cache docs_equality + docs_resolvables Indices and tables diff --git a/docs/vars.rst b/docs/vars.rst index 568d46b91..0f606e0ec 100644 --- a/docs/vars.rst +++ b/docs/vars.rst @@ -14,5 +14,6 @@ .. _ChannelPermissions : ./docs_channelpermissions.html .. _PermissionOverwrite : ./docs_permissionoverwrite.html .. _Permission Constants : ./docs_permissionconstants.html +.. _Resolvables : ./docs_resolvables.html .. _Promises : https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Promise .. _EventEmitter : https://nodejs.org/api/events.html#events_class_events_eventemitter \ No newline at end of file