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

Spit-polishing ClientOptions docs

Browse Source
This commit is contained in:
Schuyler Cebulskie
2016-09-12 17:50:24 -04:00
parent 6aa9bfd7f9
commit 8bcb670920
2 changed files with 10 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/docs.json
View File

File diff suppressed because one or more lines are too long

19
src/util/Constants.js
View File

@@ -8,17 +8,10 @@
* @property {number} [max_message_cache=200] Number of messages to cache per channel * @property {number} [max_message_cache=200] Number of messages to cache per channel
* @property {boolean} [fetch_all_members=false] Whether to cache all guild members and users upon startup * @property {boolean} [fetch_all_members=false] Whether to cache all guild members and users upon startup
* @property {boolean} [disable_everyone=false] Default value for MessageOptions.disable_everyone * @property {boolean} [disable_everyone=false] Default value for MessageOptions.disable_everyone
* @property {number} [rest_ws_bridge_timeout=5000] Timeout for the REST/WS bridge * @property {number} [rest_ws_bridge_timeout=5000] Maximum time permitted between REST responses and their
* corresponding websocket events
* @property {WebsocketOptions} [ws] Options for the websocket * @property {WebsocketOptions} [ws] Options for the websocket
*/ */
/**
* Websocket options.
* @typedef {Object} WebsocketOptions
* @property {number} [large_threshold=250] Number of members in a guild to be considered large
* @property {boolean} [compress=true] Whether to compress data sent on the connection
*/
exports.DefaultOptions = { exports.DefaultOptions = {
api_request_method: 'sequential', api_request_method: 'sequential',
shard_id: 0, shard_id: 0,
@@ -27,8 +20,14 @@ exports.DefaultOptions = {
fetch_all_members: false, fetch_all_members: false,
disable_everyone: false, disable_everyone: false,
rest_ws_bridge_timeout: 5000, rest_ws_bridge_timeout: 5000,
protocol_version: 6, protocol_version: 6,
/**
* Websocket options.
* @typedef {Object} WebsocketOptions
* @property {number} [large_threshold=250] Number of members in a guild to be considered large
* @property {boolean} [compress=true] Whether to compress data sent on the connection
*/
ws: { ws: {
large_threshold: 250, large_threshold: 250,
compress: true, compress: true,