Interface RequestGuildMembersOptions

interface RequestGuildMembersOptions {
    limit?: number;
    presences?: boolean;
    query?: string;
    timeout?: number;
    userIDs?: string[];
}

Properties

limit? presences? query? timeout? userIDs?

Properties

Optional limit

limit?: number

The maximum number of members to request.

Optional presences

presences?: boolean

If presences should be requested. Requires the GUILD_PRESENCES intent.

Default Value

false

Optional query

query?: string

If provided, only members with a username that starts with this string will be returned. If empty or not provided, requires the GUILD_MEMBERS intent.

Optional timeout

timeout?: number

The maximum amount of time in milliseconds to wait.

Default Value

client.rest.options.requestTimeout

Optional userIDs

userIDs?: string[]

The IDs of up to 100 users to specifically request.

Settings

Member Visibility

Theme

On This Page

limitpresencesquerytimeoutuserIDs