Class: MemberManager
Extends
BaseManager<string,Member,RawMember>
Constructors
Constructor
new MemberManager(
client,server,limit?):MemberManager
Parameters
| Parameter | Type | Default value |
|---|---|---|
client | Client | undefined |
server | Server | undefined |
limit | number | Infinity |
Returns
MemberManager
Overrides
BaseManager<string, Member, RawMember>.constructor
Properties
cache
cache:
Collection<string,Member>
Inherited from
BaseManager.cache
client
client:
Client
Inherited from
BaseManager.client
server
server:
Server
Methods
[custom]()
[custom]():
Collection<string,Member>
Returns
Collection<string, Member>
ban()
ban(
member,options?):Promise<void>
Bans a member from the server.
Parameters
| Parameter | Type | Description |
|---|---|---|
member | MemberResolvable | The MemberResolvable to ban. |
options? | MemberBanOptions | The ban options |
Returns
Promise<void>
Example
// Ban a member by ID
await server.members.ban("1234567890", { reason: "Spamming", deleteMessageSeconds: 3600 });
edit()
edit(
member,options):Promise<Member>
Edits a member in the server.
Parameters
| Parameter | Type | Description |
|---|---|---|
member | MemberResolvable | The MemberResolvable to edit. |
options | MemberEditOptions | The fields to update (nickname, roles, timeout, etc.). |
Returns
Promise<Member>
A promise that resolves to the updated Member.
Throws
If the API request fails or the member is not found.
Example
// Change a member's nickname and add a role
const updatedMember = await server.members.edit("1234567890", {
nickname: "New Nickname",
roles: ["roleId1", "roleId2"],
});
fetch()
fetch(
member,force?):Promise<Member>
Fetches a member from the server, or returns the cached version if available and not forced.
Parameters
| Parameter | Type | Default value | Description |
|---|---|---|---|
member | MemberResolvable | undefined | The MemberResolvable to fetch |
force | boolean | false | Whether to bypass the cache and fetch fresh data from the API |
Returns
Promise<Member>
A promise that resolves to the fetched Member
Throws
If the API request fails or the member is not found
Example
// Fetch a member by ID, using cache if available
const member = await server.members.fetch("1234567890");
// Fetch a member by mention, bypassing cache
const member = await server.members.fetch("<@1234567890>", true);
fetchMany()
fetchMany(
options?):Promise<Collection<string,Member>>
Fetches multiple members from the server.
Parameters
| Parameter | Type | Description |
|---|---|---|
options | FetchMembersOptions | Filter options for the fetch request. |
Returns
Promise<Collection<string, Member>>
A promise that resolves to a Collection of fetched Members.
Throws
If the API request fails.
Example
// Fetch all members in the server
const allMembers = await server.members.fetchMany();
// Fetch only online members to save bandwidth
const onlineMembers = await server.members.fetchMany({ exclude_offline: true });
kick()
kick(
member):Promise<void>
Kicks a member from the server.
Parameters
| Parameter | Type | Description |
|---|---|---|
member | MemberResolvable | The MemberResolvable to kick. |
Returns
Promise<void>
Example
// Kick a member by ID
await server.members.kick("1234567890");
resolve()
resolve(
member):Member|undefined
Resolve a string or mention to Member
Parameters
| Parameter | Type | Description |
|---|---|---|
member | MemberResolvable | The MemberResolvable to resolve |
Returns
Member | undefined
The resolved Member or undefined if not found
resolveId()
resolveId(
member):string
Resolve a Member to their ID string.
Parameters
| Parameter | Type | Description |
|---|---|---|
member | MemberResolvable | The MemberResolvable to resolve |
Returns
string
The resolved ID string
Throws
If the provided resolvable is invalid
unban()
unban(
member):Promise<void>
Unbans a user from the server
Parameters
| Parameter | Type | Description |
|---|---|---|
member | MemberResolvable | The MemberResolvable to unban |
Returns
Promise<void>
Example
// Unban a member by ID
await server.members.unban("1234567890");