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

Update sync option docs

Browse Source
This commit is contained in:
Schuyler Cebulskie
2016-11-01 02:28:23 -04:00
parent b91590d3a8
commit 93e6c69bd1
1 changed files with 2 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
src/util/Constants.js
View File

@@ -10,7 +10,6 @@ exports.Package = require('../../package.json');
* @property {number} [messageCacheMaxSize=200] Maximum number of messages to cache per channel * @property {number} [messageCacheMaxSize=200] Maximum number of messages to cache per channel
* (-1 or Infinity for unlimited - don't do this without message sweeping, otherwise memory usage will climb * (-1 or Infinity for unlimited - don't do this without message sweeping, otherwise memory usage will climb
* indefinitely) * indefinitely)
* @property {boolean} [sync=false] Whether to periodically sync guilds
* @property {number} [messageCacheLifetime=0] How long until a message should be uncached by the message sweeping * @property {number} [messageCacheLifetime=0] How long until a message should be uncached by the message sweeping
* (in seconds, 0 for forever) * (in seconds, 0 for forever)
* @property {number} [messageSweepInterval=0] How frequently to remove messages from the cache that are older than * @property {number} [messageSweepInterval=0] How frequently to remove messages from the cache that are older than
@@ -18,6 +17,7 @@ exports.Package = require('../../package.json');
* @property {boolean} [fetchAllMembers=false] Whether to cache all guild members and users upon startup, as well as * @property {boolean} [fetchAllMembers=false] Whether to cache all guild members and users upon startup, as well as
* upon joining a guild * upon joining a guild
* @property {boolean} [disableEveryone=false] Default value for MessageOptions.disableEveryone * @property {boolean} [disableEveryone=false] Default value for MessageOptions.disableEveryone
* @property {boolean} [sync=false] Whether to periodically sync guilds (for userbots)
* @property {number} [restWsBridgeTimeout=5000] Maximum time permitted between REST responses and their * @property {number} [restWsBridgeTimeout=5000] Maximum time permitted between REST responses and their
* corresponding websocket events * corresponding websocket events
* @property {string[]} [disabledEvents] An array of disabled websocket events. Events in this array will not be * @property {string[]} [disabledEvents] An array of disabled websocket events. Events in this array will not be
@@ -34,9 +34,9 @@ exports.DefaultOptions = {
messageSweepInterval: 0, messageSweepInterval: 0,
fetchAllMembers: false, fetchAllMembers: false,
disableEveryone: false, disableEveryone: false,
sync: false,
restWsBridgeTimeout: 5000, restWsBridgeTimeout: 5000,
disabledEvents: [], disabledEvents: [],
sync: false,
/** /**
* Websocket options. These are left as snake_case to match the API. * Websocket options. These are left as snake_case to match the API.