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

chore: update Vanity typedef

Browse Source
This commit is contained in:
Johnson Chen
2020-04-20 04:05:51 +10:00
parent 7d881fde80
commit 59ad48074b
1 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
src/structures/Guild.js
View File

@@ -754,16 +754,16 @@ class Guild extends Base {
}
/**
* An object containing information about a guild's vanity url.
* @typedef {Object} VanityData
* @property {?string} code Vanity URL invite code, not the full url
* @property {?number} uses How many times this invite has been used
* An object containing information about a guild's vanity invite.
* @typedef {Object} Vanity
* @property {?string} code Vanity invite code
* @property {?number} uses How many times this invite has been used, must be fetched at least once
*/
/**
* Fetches the vanity url invite object to this guild.
* Resolves with an object containing the vanity url invite code and the use count
* @returns {Promise<VanityData>}
* @returns {Promise<Vanity>}
* @example
* // Fetch invite data
* guild.fetchVanityData()