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

fixed small typo's in the Docs and added an example to <Guild>.setSystemChannel() (#1934)

Browse Source
This commit is contained in:
Raphael
2017-09-11 19:33:04 +02:00
committed by Crawl
parent cc0b65d70b
commit 18389c7659
3 changed files with 10 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
src/structures/ClientApplication.js
View File

@@ -123,7 +123,7 @@ class ClientApplication extends Base {
* A link to the application's icon. * A link to the application's icon.
* @param {Object} [options={}] Options for the icon url * @param {Object} [options={}] Options for the icon url
* @param {string} [options.format='webp'] One of `webp`, `png`, `jpg` * @param {string} [options.format='webp'] One of `webp`, `png`, `jpg`
* @param {number} [options.size=128] One of `128`, '256', `512`, `1024`, `2048` * @param {number} [options.size=128] One of `128`, `256`, `512`, `1024`, `2048`
* @returns {?string} URL to the icon * @returns {?string} URL to the icon
*/ */
iconURL({ format, size } = {}) { iconURL({ format, size } = {}) {
@@ -135,7 +135,7 @@ class ClientApplication extends Base {
* A link to this application's cover image. * A link to this application's cover image.
* @param {Object} [options={}] Options for the cover image url * @param {Object} [options={}] Options for the cover image url
* @param {string} [options.format='webp'] One of `webp`, `png`, `jpg` * @param {string} [options.format='webp'] One of `webp`, `png`, `jpg`
* @param {number} [options.size=128] One of `128`, '256', `512`, `1024`, `2048` * @param {number} [options.size=128] One of `128`, `256`, `512`, `1024`, `2048`
* @returns {?string} URL to the cover image * @returns {?string} URL to the cover image
*/ */
coverImage({ format, size } = {}) { coverImage({ format, size } = {}) {

2
src/structures/GroupDMChannel.js
View File

@@ -110,7 +110,7 @@ class GroupDMChannel extends Channel {
* Gets the URL to this Group DM's icon. * Gets the URL to this Group DM's icon.
* @param {Object} [options={}] Options for the icon url * @param {Object} [options={}] Options for the icon url
* @param {string} [options.format='webp'] One of `webp`, `png`, `jpg` * @param {string} [options.format='webp'] One of `webp`, `png`, `jpg`
* @param {number} [options.size=128] One of `128`, '256', `512`, `1024`, `2048` * @param {number} [options.size=128] One of `128`, `256`, `512`, `1024`, `2048`
* @returns {?string} * @returns {?string}
*/ */
iconURL({ format, size } = {}) { iconURL({ format, size } = {}) {

9
src/structures/Guild.js
View File

@@ -253,7 +253,7 @@ class Guild extends Base {
* The URL to this guild's icon. * The URL to this guild's icon.
* @param {Object} [options={}] Options for the icon url * @param {Object} [options={}] Options for the icon url
* @param {string} [options.format='webp'] One of `webp`, `png`, `jpg` * @param {string} [options.format='webp'] One of `webp`, `png`, `jpg`
* @param {number} [options.size=128] One of `128`, '256', `512`, `1024`, `2048` * @param {number} [options.size=128] One of `128`, `256`, `512`, `1024`, `2048`
* @returns {?string} * @returns {?string}
*/ */
iconURL({ format, size } = {}) { iconURL({ format, size } = {}) {
@@ -274,7 +274,7 @@ class Guild extends Base {
* The URL to this guild's splash. * The URL to this guild's splash.
* @param {Object} [options={}] Options for the splash url * @param {Object} [options={}] Options for the splash url
* @param {string} [options.format='webp'] One of `webp`, `png`, `jpg` * @param {string} [options.format='webp'] One of `webp`, `png`, `jpg`
* @param {number} [options.size=128] One of `128`, '256', `512`, `1024`, `2048` * @param {number} [options.size=128] One of `128`, `256`, `512`, `1024`, `2048`
* @returns {?string} * @returns {?string}
*/ */
splashURL({ format, size } = {}) { splashURL({ format, size } = {}) {
@@ -680,6 +680,11 @@ class Guild extends Base {
* @param {ChannelResolvable} systemChannel The new system channel * @param {ChannelResolvable} systemChannel The new system channel
* @param {string} [reason] Reason for changing the guild's system channel * @param {string} [reason] Reason for changing the guild's system channel
* @returns {Promise<Guild>} * @returns {Promise<Guild>}
* @example
* // Edit the guild system channel
* guild.setSystemChannel(channel)
* .then(updated => console.log(`Updated guild system channel to ${guild.systemChannel}`))
* .catch(console.error);
*/ */
setSystemChannel(systemChannel, reason) { setSystemChannel(systemChannel, reason) {
return this.edit({ systemChannel }, reason); return this.edit({ systemChannel }, reason);