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

feat: add VanityData typedef and populate vanityURLUses

Browse Source
This commit is contained in:
Johnson Chen
2020-04-20 03:30:27 +10:00
parent 5c8c56206f
commit 02b5678a01
1 changed files with 19 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
src/structures/Guild.js
View File

@@ -311,6 +311,12 @@ class Guild extends Base {
*/
this.vanityURLCode = data.vanity_url_code;
/**
* The use count of the vanity URL code of the guild, if any
* @type {?number}
*/
this.vanityURLUses = null;
/**
* The description of the guild, if any
* @type {?string}
@@ -748,10 +754,17 @@ class Guild extends Base {
}, 'fetchVanityCode() is deprecated. Use fetchVanityData() instead.');
}
/**
* An object containing information about a guild member's ban.
* @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
*/
/**
* Fetches the vanity url invite object to this guild.
* Resolves with an object containing the vanity url invite code, not the full url and the use count.
* @returns {Promise<{ code: ?string, uses: ?number }>}
* Resolves with an object containing the vanity url invite code and the use count
* @returns {Promise<VanityData>}
* @example
* // Fetch invite data
* guild.fetchVanityData()
@@ -764,7 +777,10 @@ class Guild extends Base {
if (!this.features.includes('VANITY_URL')) {
return Promise.reject(new Error('VANITY_URL'));
}
return this.client.api.guilds(this.id, 'vanity-url').get();
const data = this.client.api.guilds(this.id, 'vanity-url').get();
this.vanityURLUses = data.uses;
return data;
}
/**