Add jsdoc comments

This commit is contained in:
Helloyunho 2021-01-18 20:56:51 +09:00
parent 78ae0bbb56
commit 8ad1a2ac6f
3 changed files with 33 additions and 0 deletions

View file

@ -61,6 +61,10 @@ export class GuildManager extends BaseManager<GuildPayload, Guild> {
}) })
} }
/**
* Creates a guild. Returns Guild. Fires guildCreate event.
* @param options Options for creating a guild
*/
async create(options: GuildCreateOptions): Promise<Guild> { async create(options: GuildCreateOptions): Promise<Guild> {
if (options.icon !== undefined && !options.icon.startsWith('data:')) { if (options.icon !== undefined && !options.icon.startsWith('data:')) {
options.icon = await fetchAuto(options.icon) options.icon = await fetchAuto(options.icon)
@ -115,6 +119,10 @@ export class GuildManager extends BaseManager<GuildPayload, Guild> {
return guild return guild
} }
/**
* Gets a preview of a guild. Returns GuildPreview.
* @param guildID Guild id
*/
async preview(guildID: string): Promise<GuildPreview> { async preview(guildID: string): Promise<GuildPreview> {
const resp: GuildPreviewPayload = await this.client.rest.get( const resp: GuildPreviewPayload = await this.client.rest.get(
GUILD_PREVIEW(guildID) GUILD_PREVIEW(guildID)
@ -136,6 +144,12 @@ export class GuildManager extends BaseManager<GuildPayload, Guild> {
return result return result
} }
/**
* Edits a guild.
* @param guild Guild or guild id
* @param options Guild edit options
* @param asRaw true for get raw data, false for get guild(defaults to false)
*/
async edit( async edit(
guild: Guild | string, guild: Guild | string,
options: GuildModifyOptions, options: GuildModifyOptions,
@ -210,6 +224,10 @@ export class GuildManager extends BaseManager<GuildPayload, Guild> {
} }
} }
/**
* Deletes a guild.
* @param guild Guild or guild id
*/
async delete(guild: Guild | string): Promise<Guild | undefined> { async delete(guild: Guild | string): Promise<Guild | undefined> {
if (guild instanceof Guild) { if (guild instanceof Guild) {
guild = guild.id guild = guild.id

View file

@ -332,10 +332,15 @@ export class Guild extends Base {
}) })
} }
/** Gets a preview of the guild. Returns GuildPreview. */
async preview(): Promise<GuildPreview> { async preview(): Promise<GuildPreview> {
return this.client.guilds.preview(this.id) return this.client.guilds.preview(this.id)
} }
/**
* Edits the guild.
* @param options Guild edit options
*/
async edit(options: GuildModifyOptions): Promise<Guild> { async edit(options: GuildModifyOptions): Promise<Guild> {
const result = await this.client.guilds.edit(this.id, options, true) const result = await this.client.guilds.edit(this.id, options, true)
this.readFromData(result) this.readFromData(result)
@ -343,6 +348,7 @@ export class Guild extends Base {
return new Guild(this.client, result) return new Guild(this.client, result)
} }
/** Deletes the guild. */
async delete(): Promise<Guild> { async delete(): Promise<Guild> {
const result = await this.client.guilds.delete(this.id) const result = await this.client.guilds.delete(this.id)

View file

@ -151,10 +151,19 @@ export class Message extends Base {
return this.client.rest.delete(CHANNEL_MESSAGE(this.channelID, this.id)) return this.client.rest.delete(CHANNEL_MESSAGE(this.channelID, this.id))
} }
/**
* Adds a reaction to the message.
* @param emoji Emoji in string or object
*/
async addReaction(emoji: string | Emoji): Promise<void> { async addReaction(emoji: string | Emoji): Promise<void> {
return this.channel.addReaction(this, emoji) return this.channel.addReaction(this, emoji)
} }
/**
* Removes a reaction to the message.
* @param emoji Emoji in string or object
* @param user User or Member or user id
*/
async removeReaction( async removeReaction(
emoji: string | Emoji, emoji: string | Emoji,
user?: User | Member | string user?: User | Member | string