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

More ClientOptions docs cleanup

Browse Source
This commit is contained in:
Schuyler Cebulskie
2016-09-12 17:17:16 -04:00
parent 168ecdf8a9
commit 6aa9bfd7f9
2 changed files with 13 additions and 13 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

24
src/util/Constants.js
View File

@@ -1,33 +1,33 @@
/** /**
* Options for a Client. * Options for a Client.
* @typedef {Object} ClientOptions * @typedef {Object} ClientOptions
* @property {number} [max_message_cache=200] Number of messages to cache per channel
* @property {string} [api_request_method='sequential'] 'sequential' or 'burst'. Sequential executes all requests in * @property {string} [api_request_method='sequential'] 'sequential' or 'burst'. Sequential executes all requests in
* the order they are triggered, whereas burst runs multiple at a time, and doesn't guarantee a particular order. * the order they are triggered, whereas burst runs multiple at a time, and doesn't guarantee a particular order.
* @property {number} [shard_id=0] The ID of this shard * @property {number} [shard_id=0] The ID of this shard
* @property {number} [shard_count=0] The number of shards * @property {number} [shard_count=0] The number of shards
* @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] Timeout for the REST/WS bridge
* @property {number} [protocol_version=6] The gateway protocol version to use * @property {WebsocketOptions} [ws] Options for the websocket
* @property {Object} [ws] Websocket options
* @property {number} [ws.large_threshold=250] Number of members in a guild to be considered large
* @property {boolean} [ws.compress=true] Whether to compress data sent on the connection
* @property {Object} [ws.properties] Properties for the websocket
* @property {string} [ws.properties.$os=Platform default, or 'discord.js'] Operating system name
* @property {string} [ws.properties.$browser='discord.js'] Browser name
* @property {string} [ws.properties.$device='discord.js'] Device name
* @property {string} [ws.properties.$referrer=''] Referring URL
* @property {string} [ws.properties.$referring_domain=''] Referring domain
*/ */
/**
* 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 = {
max_message_cache: 200,
api_request_method: 'sequential', api_request_method: 'sequential',
shard_id: 0, shard_id: 0,
shard_count: 0, shard_count: 0,
max_message_cache: 200,
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,
ws: { ws: {
large_threshold: 250, large_threshold: 250,