From 144b4b9eaf486f5179f8462408d0b7b83b993abb Mon Sep 17 00:00:00 2001 From: lts20050703 <87189679+lts20050703@users.noreply.github.com> Date: Sun, 2 Jan 2022 13:40:59 +0700 Subject: [PATCH 1/4] #1877 Document max value for GET event users limit param #1877 Document max value for GET event users limit param --- .../guilds/scheduledEvents/getScheduledEventUsers.ts | 8 ++++++-- src/types/guilds/scheduledEvents.ts | 2 +- 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/src/helpers/guilds/scheduledEvents/getScheduledEventUsers.ts b/src/helpers/guilds/scheduledEvents/getScheduledEventUsers.ts index cd273afb9..0ae2af43f 100644 --- a/src/helpers/guilds/scheduledEvents/getScheduledEventUsers.ts +++ b/src/helpers/guilds/scheduledEvents/getScheduledEventUsers.ts @@ -4,6 +4,7 @@ import { GetScheduledEventUsers } from "../../../types/guilds/scheduledEvents.ts import { GuildMember } from "../../../types/members/guildMember.ts"; import { User } from "../../../types/users/user.ts"; import { Collection } from "../../../util/collection.ts"; +import { validateLength } from "../../../util/mod.ts"; export async function getScheduledEventUsers( bot: Bot, @@ -25,10 +26,13 @@ export async function getScheduledEventUsers( ): Promise< Collection | Collection > { - // TODO: validate limit + if (options?.limit && options.limit > 100) { + throw new Error("Limit must be less than or equals to 100"); + } + // TODO: is the guild member omit user - const result = await bot.rest.runMethod<({ user: User, member?: GuildMember })[]>( + const result = await bot.rest.runMethod<{ user: User; member?: GuildMember }[]>( bot.rest, "get", bot.constants.endpoints.GUILD_SCHEDULED_EVENT_USERS(guildId, eventId), diff --git a/src/types/guilds/scheduledEvents.ts b/src/types/guilds/scheduledEvents.ts index 872daf98f..9056450f0 100644 --- a/src/types/guilds/scheduledEvents.ts +++ b/src/types/guilds/scheduledEvents.ts @@ -124,7 +124,7 @@ export interface GetScheduledEvents { } export interface GetScheduledEventUsers { - /** how many users to receive from the event. Defaults to 100. */ + /** number of users to return (up to maximum 100). Defaults to 100 */ limit?: number; /** Whether to also have member objects provided. Defaults to false. */ withMember?: boolean; From 0af7867b0c9a2285aeba3d2b2e4dbb2c1d3adeba Mon Sep 17 00:00:00 2001 From: lts20050703 <87189679+lts20050703@users.noreply.github.com> Date: Sun, 2 Jan 2022 13:45:34 +0700 Subject: [PATCH 2/4] Update scheduledEvents.ts --- src/types/guilds/scheduledEvents.ts | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/types/guilds/scheduledEvents.ts b/src/types/guilds/scheduledEvents.ts index 9056450f0..fd2bfb0f4 100644 --- a/src/types/guilds/scheduledEvents.ts +++ b/src/types/guilds/scheduledEvents.ts @@ -124,9 +124,9 @@ export interface GetScheduledEvents { } export interface GetScheduledEventUsers { - /** number of users to return (up to maximum 100). Defaults to 100 */ + /** number of users to return (up to maximum 100), defaults to 100. */ limit?: number; - /** Whether to also have member objects provided. Defaults to false. */ + /** whether to also have member objects provided, defaults to false. */ withMember?: boolean; /** consider only users before given user id */ before?: bigint; From 849afd4837a641663569462724a1f7054b3264ae Mon Sep 17 00:00:00 2001 From: lts20050703 <87189679+lts20050703@users.noreply.github.com> Date: Mon, 3 Jan 2022 06:35:05 +0700 Subject: [PATCH 3/4] minor changes --- src/helpers/guilds/scheduledEvents/getScheduledEventUsers.ts | 1 - src/types/guilds/scheduledEvents.ts | 4 ++-- 2 files changed, 2 insertions(+), 3 deletions(-) diff --git a/src/helpers/guilds/scheduledEvents/getScheduledEventUsers.ts b/src/helpers/guilds/scheduledEvents/getScheduledEventUsers.ts index 0ae2af43f..dab281c48 100644 --- a/src/helpers/guilds/scheduledEvents/getScheduledEventUsers.ts +++ b/src/helpers/guilds/scheduledEvents/getScheduledEventUsers.ts @@ -4,7 +4,6 @@ import { GetScheduledEventUsers } from "../../../types/guilds/scheduledEvents.ts import { GuildMember } from "../../../types/members/guildMember.ts"; import { User } from "../../../types/users/user.ts"; import { Collection } from "../../../util/collection.ts"; -import { validateLength } from "../../../util/mod.ts"; export async function getScheduledEventUsers( bot: Bot, diff --git a/src/types/guilds/scheduledEvents.ts b/src/types/guilds/scheduledEvents.ts index fd2bfb0f4..9e4c841ef 100644 --- a/src/types/guilds/scheduledEvents.ts +++ b/src/types/guilds/scheduledEvents.ts @@ -124,9 +124,9 @@ export interface GetScheduledEvents { } export interface GetScheduledEventUsers { - /** number of users to return (up to maximum 100), defaults to 100. */ + /** number of users to return (up to maximum 100), defaults to 100 */ limit?: number; - /** whether to also have member objects provided, defaults to false. */ + /** whether to also have member objects provided, defaults to false */ withMember?: boolean; /** consider only users before given user id */ before?: bigint; From 0a436da6546944a4e9863d9bd50a7286a62f30de Mon Sep 17 00:00:00 2001 From: lts20050703 <87189679+lts20050703@users.noreply.github.com> Date: Wed, 5 Jan 2022 07:07:37 +0700 Subject: [PATCH 4/4] move to plugin --- src/helpers/guilds/scheduledEvents/getScheduledEventUsers.ts | 4 ---- 1 file changed, 4 deletions(-) diff --git a/src/helpers/guilds/scheduledEvents/getScheduledEventUsers.ts b/src/helpers/guilds/scheduledEvents/getScheduledEventUsers.ts index dab281c48..bd63b3eea 100644 --- a/src/helpers/guilds/scheduledEvents/getScheduledEventUsers.ts +++ b/src/helpers/guilds/scheduledEvents/getScheduledEventUsers.ts @@ -25,10 +25,6 @@ export async function getScheduledEventUsers( ): Promise< Collection | Collection > { - if (options?.limit && options.limit > 100) { - throw new Error("Limit must be less than or equals to 100"); - } - // TODO: is the guild member omit user const result = await bot.rest.runMethod<{ user: User; member?: GuildMember }[]>(