Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix(RoleManager): fix ID return value, change return type to collection #4935

Merged
merged 4 commits into from Nov 22, 2020
Merged

fix(RoleManager): fix ID return value, change return type to collection #4935

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5a4219a
fix(RoleManager): fix ID return value, change return type to collection
vaporoxx Oct 24, 2020
85cb114
docs: update return type
vaporoxx Oct 24, 2020
17f0685
Update src/managers/RoleManager.js
vaporoxx Nov 8, 2020
6772603
docs: you cannot pass multiple ids
vaporoxx Nov 20, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
14 changes: 8 additions & 6 deletions src/managers/RoleManager.js
View file
Open in desktop
Expand Up @@ -2,6 +2,7 @@

const BaseManager = require('./BaseManager');
const Role = require('../structures/Role');
const Collection = require('../util/Collection');
const Permissions = require('../util/Permissions');
const { resolveColor } = require('../util/Util');

Expand Down Expand Up @@ -31,10 +32,10 @@ class RoleManager extends BaseManager {

/**
* Obtains one or more roles from Discord, or the role cache if they're already available.
* @param {Snowflake} [id] ID or IDs of the role(s)
* @param {boolean} [cache=true] Whether to cache the new roles objects if it weren't already
* @param {Snowflake} [id] ID of the role to fetch
* @param {boolean} [cache=true] Whether to cache the new role object(s) if they weren't already
* @param {boolean} [force=false] Whether to skip the cache check and request the API
* @returns {Promise<Role|RoleManager>}
* @returns {Promise<?Role|Collection<Snowflake, Role>>}
* @example
* // Fetch all roles from the guild
* message.guild.roles.fetch()
Expand All @@ -53,9 +54,10 @@ class RoleManager extends BaseManager {
}

// We cannot fetch a single role, as of this commit's date, Discord API throws with 405
const roles = await this.client.api.guilds(this.guild.id).roles.get();
for (const role of roles) this.add(role, cache);
return id ? this.cache.get(id) || null : this;
const data = await this.client.api.guilds(this.guild.id).roles.get();
const roles = new Collection();
for (const role of data) roles.set(role.id, this.add(role, cache));
return id ? roles.get(id) || null : roles;
}

/**
Expand Down
2 changes: 1 addition & 1 deletion typings/index.d.ts
View file
Open in desktop
Expand Up @@ -2027,7 +2027,7 @@ declare module 'discord.js' {

public create(options?: { data?: RoleData; reason?: string }): Promise<Role>;
public fetch(id: Snowflake, cache?: boolean, force?: boolean): Promise<Role | null>;
public fetch(id?: Snowflake, cache?: boolean, force?: boolean): Promise<this>;
public fetch(id?: Snowflake, cache?: boolean, force?: boolean): Promise<Collection<Snowflake, Role>>;
}

export class UserManager extends BaseManager<Snowflake, User, UserResolvable> {
Expand Down