docs: consistency

This commit is contained in:
Lewdcario
2018-04-29 13:28:12 -05:00
parent 5acf4061e8
commit 745669a7c9
8 changed files with 18 additions and 22 deletions

View File

@@ -146,9 +146,7 @@ class Shard extends EventEmitter {
* @returns {Promise<*>}
* @example
* shard.fetchClientValue('guilds.size')
* .then(count => {
* console.log(`${count} guilds in shard ${shard.id}`);
* })
* .then(count => console.log(`${count} guilds in shard ${shard.id}`))
* .catch(console.error);
*/
fetchClientValue(prop) {

View File

@@ -56,9 +56,7 @@ class ShardClientUtil {
* @returns {Promise<Array<*>>}
* @example
* client.shard.fetchClientValues('guilds.size')
* .then(results => {
* console.log(`${results.reduce((prev, val) => prev + val, 0)} total guilds`);
* })
* .then(results => console.log(`${results.reduce((prev, val) => prev + val, 0)} total guilds`))
* .catch(console.error);
* @see {@link ShardingManager#fetchClientValues}
*/
@@ -82,6 +80,10 @@ class ShardClientUtil {
* Evaluates a script or function on all shards, in the context of the {@link Clients}.
* @param {string|Function} script JavaScript to run on each shard
* @returns {Promise<Array<*>>} Results of the script execution
* @example
* client.shard.broadcastEval('this.guilds.size')
* .then(results => console.log(`${results.reduce((prev, val) => prev + val, 0)} total guilds`))
* .catch(console.error);
* @see {@link ShardingManager#broadcastEval}
*/
broadcastEval(script) {

View File

@@ -166,9 +166,7 @@ class ShardingManager extends EventEmitter {
* @returns {Promise<Array<*>>}
* @example
* manager.fetchClientValues('guilds.size')
* .then(results => {
* console.log(`${results.reduce((prev, val) => prev + val, 0)} total guilds`);
* })
* .then(results => console.log(`${results.reduce((prev, val) => prev + val, 0)} total guilds`))
* .catch(console.error);
*/
fetchClientValues(prop) {