Skip to main content
Module

x/discordeno/mod.ts>searchMembers

Discord API library for Deno
Latest
function searchMembers
import { searchMembers } from "https://deno.land/x/discordeno@18.0.1/mod.ts";

Gets the list of members whose usernames or nicknames start with a provided string.

Parameters

bot: Bot
  • The bot instance to use to make the request.
guildId: BigString
  • The ID of the guild to search in.
query: string
  • The string to match usernames or nicknames against.
optional
options: Omit<SearchMembers, "query">
  • The parameters for searching through the members.

Returns

Promise<Collection<bigint, Member>>

A collection of Member objects assorted by user ID.