Merge pull request #1878 from lts20050703/#1877-Document-max-value-for-GET-event-users-limit-param

Document max value for GET event users limit param
This commit is contained in:
ITOH
2022-01-05 15:10:59 +01:00
committed by GitHub
2 changed files with 3 additions and 4 deletions

View File

@@ -25,10 +25,9 @@ export async function getScheduledEventUsers(
): Promise<
Collection<bigint, DiscordenoUser> | Collection<bigint, { user: DiscordenoUser; member: DiscordenoMember }>
> {
// TODO: validate limit
// 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),

View File

@@ -124,9 +124,9 @@ 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. */
/** whether to also have member objects provided, defaults to false */
withMember?: boolean;
/** consider only users before given user id */
before?: bigint;