Skip to content

RoleManager

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

Manages Discord guild roles.

new RoleManager(guildId, rest): RoleManager

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

string

REST

RoleManager

ResourceManager.constructor

readonly cache: Collection<string, Role>

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/role.ts:38

get size(): number

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

Gets cache size.

number

Number of cached values.

ResourceManager.size

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

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

Iterates cached entries.

IterableIterator<[string, Role]>

Cache iterator.

ResourceManager.[iterator]


clear(): void

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

Clears the cache.

void

Nothing.

ResourceManager.clear


create(options): Promise<Role>

Defined in: packages/managers/src/role.ts:61

Creates a new role in the guild.

RoleCreateOptions

Promise<Role>


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(roleId, options): Promise<Role>

Defined in: packages/managers/src/role.ts:72

Edits an existing role.

string

RoleEditOptions

Promise<Role>


fetch(id): Promise<Role>

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<Role>

ResourceManager.fetch


fetchAll(): Promise<Role[]>

Defined in: packages/managers/src/role.ts:53

Fetches all roles in the guild.

Promise<Role[]>


fetchMany(ids): Promise<Role[]>

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

Iterable<string>

Promise<Role[]>

ResourceManager.fetchMany


find(predicate): Role | undefined

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

Finds a cached value.

(value, key) => boolean

Predicate.

Role | undefined

Matching value.

ResourceManager.find


first(): Role | undefined

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

Gets the first cached value.

Role | undefined

First value.

ResourceManager.first


get(id): Role | undefined

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

Gets a cached value.

string

Cache key.

Role | 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


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

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

Deletes a role.

string

string

Audit-log reason.

Promise<void>


resolve(id): Promise<Role>

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

string

Promise<Role>

ResourceManager.resolve


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.

Role

Value.

this

This manager.

ResourceManager.set


setPositions(positions, reason?): Promise<Role[]>

Defined in: packages/managers/src/role.ts:100

Moves roles in the hierarchy. Discord shifts the other roles around them.

readonly object[]

Each role’s ID and its new position.

string

Audit-log reason.

Promise<Role[]>

Every role in the guild, in their new order.


update(resource): Role

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

Role

Role

ResourceManager.update


upsert(resource): Role

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.

Role

Role

The canonical instance.

ResourceManager.upsert


values(): Role[]

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

Returns cached values.

Role[]

Array of values.

ResourceManager.values