Skip to content

GuildBanManager

Defined in: packages/managers/src/guild-resources.ts:35

Manages a guild’s bans, cached by user ID.

new GuildBanManager(rest, guildId): GuildBanManager

Defined in: packages/managers/src/guild-resources.ts:39

REST

string

GuildBanManager

Manager.constructor

readonly cache: Collection<string, APIBan>

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

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

Manager.cache


readonly guildId: string

Defined in: packages/managers/src/guild-resources.ts:37

get size(): number

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

Gets cache size.

number

Number of cached values.

Manager.size

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

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

Iterates cached entries.

IterableIterator<[string, APIBan]>

Cache iterator.

Manager.[iterator]


bulk(userIds, options?): Promise<{ banned: string[]; failed: string[]; }>

Defined in: packages/managers/src/guild-resources.ts:89

Bans up to 200 users at once. Users that cannot be banned (already banned, higher role, owner) come back in failed, not as an error.

readonly string[]

GuildBanCreateOptions = {}

Promise<{ banned: string[]; failed: string[]; }>


clear(): void

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

Clears the cache.

void

Nothing.

Manager.clear


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

Defined in: packages/managers/src/guild-resources.ts:74

Bans a user.

string

GuildBanCreateOptions = {}

Promise<void>


delete(id): boolean

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

Deletes a cached value.

string

Cache key.

boolean

True when deleted.

Manager.delete


fetch(userId): Promise<APIBan>

Defined in: packages/managers/src/guild-resources.ts:46

Fetches one ban.

string

Promise<APIBan>


fetchAll(options?): Promise<APIBan[]>

Defined in: packages/managers/src/guild-resources.ts:55

Fetches a page of bans (limit 1-1000, before/after user-ID cursors).

string

string

number

Promise<APIBan[]>


find(predicate): APIBan | undefined

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

Finds a cached value.

(value, key) => boolean

Predicate.

APIBan | undefined

Matching value.

Manager.find


first(): APIBan | undefined

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

Gets the first cached value.

APIBan | undefined

First value.

Manager.first


get(id): APIBan | undefined

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

Gets a cached value.

string

Cache key.

APIBan | undefined

Cached value.

Manager.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.

Manager.has


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

Defined in: packages/managers/src/guild-resources.ts:113

Lifts a ban.

string

string

Promise<void>


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.

APIBan

Value.

this

This manager.

Manager.set


values(): APIBan[]

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

Returns cached values.

APIBan[]

Array of values.

Manager.values