GuildBanManager
Defined in: packages/managers/src/guild-resources.ts:35
Manages a guild’s bans, cached by user ID.
Extends
Section titled “Extends”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new GuildBanManager(
rest,guildId):GuildBanManager
Defined in: packages/managers/src/guild-resources.ts:39
Parameters
Section titled “Parameters”guildId
Section titled “guildId”string
Returns
Section titled “Returns”GuildBanManager
Overrides
Section titled “Overrides”Properties
Section titled “Properties”
readonlycache:Collection<string,APIBan>
Defined in: packages/managers/src/base.ts:27
Authoritative resource state. Entries never expire: see Manager.set.
Inherited from
Section titled “Inherited from”guildId
Section titled “guildId”
readonlyguildId:string
Defined in: packages/managers/src/guild-resources.ts:37
Accessors
Section titled “Accessors”Get Signature
Section titled “Get Signature”get size():
number
Defined in: packages/managers/src/base.ts:105
Gets cache size.
Returns
Section titled “Returns”number
Number of cached values.
Inherited from
Section titled “Inherited from”Methods
Section titled “Methods”[iterator]()
Section titled “[iterator]()”[iterator]():
IterableIterator<[string,APIBan]>
Defined in: packages/managers/src/base.ts:121
Iterates cached entries.
Returns
Section titled “Returns”IterableIterator<[string, APIBan]>
Cache iterator.
Inherited from
Section titled “Inherited from”bulk()
Section titled “bulk()”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.
Parameters
Section titled “Parameters”userIds
Section titled “userIds”readonly string[]
options?
Section titled “options?”Returns
Section titled “Returns”Promise<{ banned: string[]; failed: string[]; }>
clear()
Section titled “clear()”clear():
void
Defined in: packages/managers/src/base.ts:101
Clears the cache.
Returns
Section titled “Returns”void
Nothing.
Inherited from
Section titled “Inherited from”create()
Section titled “create()”create(
userId,options?):Promise<void>
Defined in: packages/managers/src/guild-resources.ts:74
Bans a user.
Parameters
Section titled “Parameters”userId
Section titled “userId”string
options?
Section titled “options?”Returns
Section titled “Returns”Promise<void>
delete()
Section titled “delete()”delete(
id):boolean
Defined in: packages/managers/src/base.ts:96
Deletes a cached value.
Parameters
Section titled “Parameters”string
Cache key.
Returns
Section titled “Returns”boolean
True when deleted.
Inherited from
Section titled “Inherited from”fetch()
Section titled “fetch()”fetch(
userId):Promise<APIBan>
Defined in: packages/managers/src/guild-resources.ts:46
Fetches one ban.
Parameters
Section titled “Parameters”userId
Section titled “userId”string
Returns
Section titled “Returns”Promise<APIBan>
fetchAll()
Section titled “fetchAll()”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).
Parameters
Section titled “Parameters”options?
Section titled “options?”after?
Section titled “after?”string
before?
Section titled “before?”string
limit?
Section titled “limit?”number
Returns
Section titled “Returns”Promise<APIBan[]>
find()
Section titled “find()”find(
predicate):APIBan|undefined
Defined in: packages/managers/src/base.ts:117
Finds a cached value.
Parameters
Section titled “Parameters”predicate
Section titled “predicate”(value, key) => boolean
Predicate.
Returns
Section titled “Returns”APIBan | undefined
Matching value.
Inherited from
Section titled “Inherited from”first()
Section titled “first()”first():
APIBan|undefined
Defined in: packages/managers/src/base.ts:109
Gets the first cached value.
Returns
Section titled “Returns”APIBan | undefined
First value.
Inherited from
Section titled “Inherited from”get(
id):APIBan|undefined
Defined in: packages/managers/src/base.ts:36
Gets a cached value.
Parameters
Section titled “Parameters”string
Cache key.
Returns
Section titled “Returns”APIBan | undefined
Cached value.
Inherited from
Section titled “Inherited from”has(
id):boolean
Defined in: packages/managers/src/base.ts:40
Checks whether a value is cached.
Parameters
Section titled “Parameters”string
Cache key.
Returns
Section titled “Returns”boolean
True when cached.
Inherited from
Section titled “Inherited from”remove()
Section titled “remove()”remove(
userId,reason?):Promise<void>
Defined in: packages/managers/src/guild-resources.ts:113
Lifts a ban.
Parameters
Section titled “Parameters”userId
Section titled “userId”string
reason?
Section titled “reason?”string
Returns
Section titled “Returns”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.
Parameters
Section titled “Parameters”string
Cache key.
Value.
Returns
Section titled “Returns”this
This manager.
Inherited from
Section titled “Inherited from”values()
Section titled “values()”values():
APIBan[]
Defined in: packages/managers/src/base.ts:113
Returns cached values.
Returns
Section titled “Returns”APIBan[]
Array of values.