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

Change burst mode warning

Browse Source
This commit is contained in:
Schuyler Cebulskie
2017-03-01 04:51:46 -05:00
parent 7473fd513e
commit a5740e83f4
1 changed files with 2 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
src/util/Constants.js
View File

@@ -5,9 +5,8 @@ exports.Package = require('../../package.json');
* @typedef {Object} ClientOptions * @typedef {Object} ClientOptions
* @property {string} [apiRequestMethod='sequential'] One of `sequential` or `burst`. The sequential handler executes * @property {string} [apiRequestMethod='sequential'] One of `sequential` or `burst`. The sequential handler executes
* all requests in the order they are triggered, whereas the burst handler runs multiple in parallel, and doesn't * all requests in the order they are triggered, whereas the burst handler runs multiple in parallel, and doesn't
* provide the guarantee of any particular order. * provide the guarantee of any particular order. Burst mode is more likely to hit a 429 ratelimit error by its nature,
* <warn>Burst mode is more likely to hit a 429 ratelimit by its nature, * and is therefore slightly riskier to use.
* be advised if you are very unlucky you could be IP banned</warn>
* @property {number} [shardId=0] ID of the shard to run * @property {number} [shardId=0] ID of the shard to run
* @property {number} [shardCount=0] Total number of shards * @property {number} [shardCount=0] Total number of shards
* @property {number} [messageCacheMaxSize=200] Maximum number of messages to cache per channel * @property {number} [messageCacheMaxSize=200] Maximum number of messages to cache per channel