Skip to content

GuildMemberManager

Defined in: packages/managers/src/member.ts:25

Manages Discord guild members.

new GuildMemberManager(guildId, rest, context?, maxSize?): GuildMemberManager

Defined in: packages/managers/src/member.ts:31

string

REST

() => ResourceContext | undefined

Gives fetched members their actions (member.kick()…).

number

GuildMemberManager

ResourceManager.constructor

readonly cache: Collection<string, GuildMember>

Defined in: packages/managers/src/base.ts:27

Authoritative resource state. Entries never expire: see Manager.set.

ResourceManager.cache


readonly guildId: string

Defined in: packages/managers/src/member.ts:28

get size(): number

Defined in: packages/managers/src/base.ts:105

Gets cache size.

number

Number of cached values.

ResourceManager.size

[iterator](): IterableIterator<[string, GuildMember]>

Defined in: packages/managers/src/base.ts:121

Iterates cached entries.

IterableIterator<[string, GuildMember]>

Cache iterator.

ResourceManager.[iterator]


addRole(userId, roleId, reason?): Promise<void>

Defined in: packages/managers/src/member.ts:141

Adds a role to a member.

string

string

string

Audit-log reason.

Promise<void>


ban(userId, options?): Promise<void>

Defined in: packages/managers/src/member.ts:105

Bans a user from the guild.

string

BanOptions = {}

Promise<void>


clear(): void

Defined in: packages/managers/src/base.ts:101

Clears the cache.

void

Nothing.

ResourceManager.clear


delete(id): boolean

Defined in: packages/managers/src/base.ts:96

Deletes a cached value.

string

Cache key.

boolean

True when deleted.

ResourceManager.delete


edit(userId, options): Promise<GuildMember>

Defined in: packages/managers/src/member.ts:122

Edits a guild member (nickname, roles, timeout, mute, deaf). Put the audit-log reason in options.reason.

string

MemberEditOptions

Promise<GuildMember>


editMe(options): Promise<GuildMember>

Defined in: packages/managers/src/member.ts:78

Changes the bot’s own nickname in this guild (null clears it).

string | null

string

Promise<GuildMember>


fetch(id): Promise<GuildMember>

Defined in: packages/managers/src/base.ts:150

Fetches from Discord; a cached instance is updated in place, so references to it stay current.

string

Promise<GuildMember>

ResourceManager.fetch


fetchMany(ids): Promise<GuildMember[]>

Defined in: packages/managers/src/base.ts:158

Iterable<string>

Promise<GuildMember[]>

ResourceManager.fetchMany


find(predicate): GuildMember | undefined

Defined in: packages/managers/src/base.ts:117

Finds a cached value.

(value, key) => boolean

Predicate.

GuildMember | undefined

Matching value.

ResourceManager.find


first(): GuildMember | undefined

Defined in: packages/managers/src/base.ts:109

Gets the first cached value.

GuildMember | undefined

First value.

ResourceManager.first


get(id): GuildMember | undefined

Defined in: packages/managers/src/base.ts:36

Gets a cached value.

string

Cache key.

GuildMember | undefined

Cached value.

ResourceManager.get


has(id): boolean

Defined in: packages/managers/src/base.ts:40

Checks whether a value is cached.

string

Cache key.

boolean

True when cached.

ResourceManager.has


kick(userId, reason?): Promise<void>

Defined in: packages/managers/src/member.ts:97

Kicks a member from the guild.

string

string

Audit-log reason.

Promise<void>


removeRole(userId, roleId, reason?): Promise<void>

Defined in: packages/managers/src/member.ts:154

Removes a role from a member.

string

string

string

Audit-log reason.

Promise<void>


resolve(id): Promise<GuildMember>

Defined in: packages/managers/src/base.ts:145

string

Promise<GuildMember>

ResourceManager.resolve


search(query, limit?): Promise<GuildMember[]>

Defined in: packages/managers/src/member.ts:57

Finds members whose username or nickname starts with query (up to limit, 1-1000, default 1).

string

number = 1

Promise<GuildMember[]>


set(id, value): this

Defined in: packages/managers/src/base.ts:88

Stores a resource with setWithoutTTL(), so it leaves only on an explicit delete (e.g. a Gateway *_DELETE), never through TTL.

string

Cache key.

GuildMember

Value.

this

This manager.

ResourceManager.set


timeout(userId, milliseconds, reason?): Promise<GuildMember>

Defined in: packages/managers/src/member.ts:166

Times out a member for a given duration in milliseconds (or clears timeout if null).

string

number | null

string

Audit-log reason.

Promise<GuildMember>


unban(userId, reason?): Promise<void>

Defined in: packages/managers/src/member.ts:115

Unbans a user from the guild.

string

string

Audit-log reason.

Promise<void>


update(resource): GuildMember

Defined in: packages/managers/src/base.ts:180

GuildMember

GuildMember

ResourceManager.update


upsert(resource): GuildMember

Defined in: packages/managers/src/base.ts:163

Stores a resource, merging into the cached instance when there is one so existing references stay current.

GuildMember

GuildMember

The canonical instance.

ResourceManager.upsert


values(): GuildMember[]

Defined in: packages/managers/src/base.ts:113

Returns cached values.

GuildMember[]

Array of values.

ResourceManager.values