• Retrieves a list of guild members from a Discord server.

    Parameters

    • token: string

      The authorization token for the Discord API.

    • guildId: string

      The ID of the Discord guild (server).

    • limit: number = 1000

      The maximum number of members to retrieve (default is 1000).

    • Optional after: string

      The ID of the last member received in the previous request, used for pagination.

    Returns Promise<GuildMember[]>

    An array of GuildMember objects representing the members of the guild.

    Throws

    Will throw an error if the REST call fails.

    Example

    import dotenv from 'dotenv'
    import { getGuildMembers } from './path-to-this-file'
    dotenv.config()

    const token = process.env.DISCORD_TOKEN as string
    const guildId = process.env.DISCORD_GUILD_ID as string

    const run = async () => {
    try {
    const members = await getGuildMembers(token, guildId)
    console.log(`Retrieved ${members.length} members`)
    } catch (error) {
    console.error(error)
    }
    }

    void run()

Generated using TypeDoc