Nomchy/discord.js
1
0
Fork 0
mirror of https://github.com/discordjs/discord.js.git synced 2026-03-16 03:23:29 +01:00
Code Issues Packages Projects Releases Wiki Activity

types!: remove GuildMemberResolvable (#10713)

Browse Source 
BREAKING CHANGE: The `GuildMemberResolvable` union has been removed. Use `UserResolvable` instead.
This commit is contained in:
Almeida
2025-01-24 12:39:37 +00:00
committed by GitHub
parent 670667d65b
commit 2cbf418008
7 changed files with 21 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
packages/discord.js/src/managers/GuildMemberManager.js
View File

@@ -40,15 +40,8 @@ class GuildMemberManager extends CachedManager {
} }
/** /**
* Data that resolves to give a GuildMember object. This can be: * Resolves a {@link UserResolvable} to a {@link GuildMember} object.
* * A GuildMember object * @param {UserResolvable} member The user that is part of the guild
* * A User resolvable
* @typedef {GuildMember|UserResolvable} GuildMemberResolvable
*/
/**
* Resolves a {@link GuildMemberResolvable} to a {@link GuildMember} object.
* @param {GuildMemberResolvable} member The user that is part of the guild
* @returns {?GuildMember} * @returns {?GuildMember}
*/ */
resolve(member) { resolve(member) {
@@ -60,8 +53,8 @@ class GuildMemberManager extends CachedManager {
} }
/** /**
* Resolves a {@link GuildMemberResolvable} to a member id. * Resolves a {@link UserResolvable} to a member id.
* @param {GuildMemberResolvable} member The user that is part of the guild * @param {UserResolvable} member The user that is part of the guild
* @returns {?Snowflake} * @returns {?Snowflake}
*/ */
resolveId(member) { resolveId(member) {
@@ -512,7 +505,7 @@ class GuildMemberManager extends CachedManager {
/** /**
* Options used for adding or removing a role from a member. * Options used for adding or removing a role from a member.
* @typedef {Object} AddOrRemoveGuildMemberRoleOptions * @typedef {Object} AddOrRemoveGuildMemberRoleOptions
* @property {GuildMemberResolvable} user The user to add/remove the role from * @property {UserResolvable} user The user to add/remove the role from
* @property {RoleResolvable} role The role to add/remove * @property {RoleResolvable} role The role to add/remove
* @property {string} [reason] Reason for adding/removing the role * @property {string} [reason] Reason for adding/removing the role
*/ */

2
packages/discord.js/src/managers/VoiceStateManager.js
View File

@@ -36,7 +36,7 @@ class VoiceStateManager extends CachedManager {
/** /**
* Obtains a user's voice state from discord or from the cache if it's already available. * Obtains a user's voice state from discord or from the cache if it's already available.
* @param {GuildMemberResolvable|'@me'} member The member whose voice state is to be fetched * @param {UserResolvable|'@me'} member The member whose voice state is to be fetched
* @param {BaseFetchOptions} [options] Additional options for this fetch * @param {BaseFetchOptions} [options] Additional options for this fetch
* @returns {Promise<VoiceState>} * @returns {Promise<VoiceState>}
* @example * @example

4
packages/discord.js/src/structures/Guild.js
View File

@@ -785,7 +785,7 @@ class Guild extends AnonymousGuild {
* @property {?VoiceChannelResolvable} [afkChannel] The AFK channel of the guild * @property {?VoiceChannelResolvable} [afkChannel] The AFK channel of the guild
* @property {number} [afkTimeout] The AFK timeout of the guild * @property {number} [afkTimeout] The AFK timeout of the guild
* @property {?(BufferResolvable|Base64Resolvable)} [icon] The icon of the guild * @property {?(BufferResolvable|Base64Resolvable)} [icon] The icon of the guild
* @property {GuildMemberResolvable} [owner] The owner of the guild * @property {UserResolvable} [owner] The owner of the guild
* @property {?(BufferResolvable|Base64Resolvable)} [splash] The invite splash image of the guild * @property {?(BufferResolvable|Base64Resolvable)} [splash] The invite splash image of the guild
* @property {?(BufferResolvable|Base64Resolvable)} [discoverySplash] The discovery splash image of the guild * @property {?(BufferResolvable|Base64Resolvable)} [discoverySplash] The discovery splash image of the guild
* @property {?(BufferResolvable|Base64Resolvable)} [banner] The banner of the guild * @property {?(BufferResolvable|Base64Resolvable)} [banner] The banner of the guild
@@ -1148,7 +1148,7 @@ class Guild extends AnonymousGuild {
/** /**
* Sets a new owner of the guild. * Sets a new owner of the guild.
* @param {GuildMemberResolvable} owner The new owner of the guild * @param {UserResolvable} owner The new owner of the guild
* @param {string} [reason] Reason for setting the new owner * @param {string} [reason] Reason for setting the new owner
* @returns {Promise<Guild>} * @returns {Promise<Guild>}
* @example * @example

2
packages/discord.js/src/structures/GuildChannel.js
View File

@@ -167,7 +167,7 @@ class GuildChannel extends BaseChannel {
/** /**
* Gets the overall set of permissions for a member or role in this channel, taking into account channel overwrites. * Gets the overall set of permissions for a member or role in this channel, taking into account channel overwrites.
* @param {GuildMemberResolvable|RoleResolvable} memberOrRole The member or role to obtain the overall permissions for * @param {UserResolvable|RoleResolvable} memberOrRole The member or role to obtain the overall permissions for
* @param {boolean} [checkAdmin=true] Whether having the {@link PermissionFlagsBits.Administrator} permission * @param {boolean} [checkAdmin=true] Whether having the {@link PermissionFlagsBits.Administrator} permission
* will return all permissions * will return all permissions
* @returns {?Readonly<PermissionsBitField>} * @returns {?Readonly<PermissionsBitField>}

4
packages/discord.js/src/structures/PermissionOverwrites.js
View File

@@ -157,7 +157,7 @@ class PermissionOverwrites extends Base {
/** /**
* Data that can be used for a permission overwrite * Data that can be used for a permission overwrite
* @typedef {Object} OverwriteData * @typedef {Object} OverwriteData
* @property {GuildMemberResolvable|RoleResolvable} id Member or role this overwrite is for * @property {UserResolvable|RoleResolvable} id Member or role this overwrite is for
* @property {PermissionResolvable} [allow] The permissions to allow * @property {PermissionResolvable} [allow] The permissions to allow
* @property {PermissionResolvable} [deny] The permissions to deny * @property {PermissionResolvable} [deny] The permissions to deny
* @property {OverwriteType} [type] The type of this OverwriteData (mandatory if `id` is a Snowflake) * @property {OverwriteType} [type] The type of this OverwriteData (mandatory if `id` is a Snowflake)
@@ -174,7 +174,7 @@ class PermissionOverwrites extends Base {
const id = guild.roles.resolveId(overwrite.id) ?? guild.client.users.resolveId(overwrite.id); const id = guild.roles.resolveId(overwrite.id) ?? guild.client.users.resolveId(overwrite.id);
if (!id) { if (!id) {
throw new DiscordjsTypeError(ErrorCodes.InvalidType, 'overwrite.id', 'GuildMemberResolvable or RoleResolvable'); throw new DiscordjsTypeError(ErrorCodes.InvalidType, 'overwrite.id', 'UserResolvable or RoleResolvable');
} }
if (overwrite.type !== undefined && (typeof overwrite.type !== 'number' || !(overwrite.type in OverwriteType))) { if (overwrite.type !== undefined && (typeof overwrite.type !== 'number' || !(overwrite.type in OverwriteType))) {

2
packages/discord.js/src/structures/ThreadChannel.js
View File

@@ -274,7 +274,7 @@ class ThreadChannel extends BaseChannel {
/** /**
* Gets the overall set of permissions for a member or role in this thread's parent channel, taking overwrites into * Gets the overall set of permissions for a member or role in this thread's parent channel, taking overwrites into
* account. * account.
* @param {GuildMemberResolvable|RoleResolvable} memberOrRole The member or role to obtain the overall permissions for * @param {UserResolvable|RoleResolvable} memberOrRole The member or role to obtain the overall permissions for
* @param {boolean} [checkAdmin=true] Whether having the {@link PermissionFlagsBits.Administrator} permission * @param {boolean} [checkAdmin=true] Whether having the {@link PermissionFlagsBits.Administrator} permission
* will return all permissions * will return all permissions
* @returns {?Readonly<PermissionsBitField>} * @returns {?Readonly<PermissionsBitField>}

20
packages/discord.js/typings/index.d.ts vendored
View File

@@ -1463,7 +1463,7 @@ export class Guild extends AnonymousGuild {
): Promise<Guild>; ): Promise<Guild>;
public setIcon(icon: BufferResolvable | Base64Resolvable | null, reason?: string): Promise<Guild>; public setIcon(icon: BufferResolvable | Base64Resolvable | null, reason?: string): Promise<Guild>;
public setName(name: string, reason?: string): Promise<Guild>; public setName(name: string, reason?: string): Promise<Guild>;
public setOwner(owner: GuildMemberResolvable, reason?: string): Promise<Guild>; public setOwner(owner: UserResolvable, reason?: string): Promise<Guild>;
public setPreferredLocale(preferredLocale: Locale | null, reason?: string): Promise<Guild>; public setPreferredLocale(preferredLocale: Locale | null, reason?: string): Promise<Guild>;
public setPublicUpdatesChannel(publicUpdatesChannel: TextChannelResolvable | null, reason?: string): Promise<Guild>; public setPublicUpdatesChannel(publicUpdatesChannel: TextChannelResolvable | null, reason?: string): Promise<Guild>;
public setRulesChannel(rulesChannel: TextChannelResolvable | null, reason?: string): Promise<Guild>; public setRulesChannel(rulesChannel: TextChannelResolvable | null, reason?: string): Promise<Guild>;
@@ -1564,7 +1564,7 @@ export abstract class GuildChannel extends BaseChannel {
public lockPermissions(): Promise<this>; public lockPermissions(): Promise<this>;
public permissionsFor(memberOrRole: GuildMember | Role, checkAdmin?: boolean): Readonly<PermissionsBitField>; public permissionsFor(memberOrRole: GuildMember | Role, checkAdmin?: boolean): Readonly<PermissionsBitField>;
public permissionsFor( public permissionsFor(
memberOrRole: GuildMemberResolvable | RoleResolvable, memberOrRole: UserResolvable | RoleResolvable,
checkAdmin?: boolean, checkAdmin?: boolean,
): Readonly<PermissionsBitField> | null; ): Readonly<PermissionsBitField> | null;
public setName(name: string, reason?: string): Promise<this>; public setName(name: string, reason?: string): Promise<this>;
@@ -3321,7 +3321,7 @@ export class ThreadChannel<ThreadOnly extends boolean = boolean> extends BaseCha
public leave(): Promise<this>; public leave(): Promise<this>;
public permissionsFor(memberOrRole: GuildMember | Role, checkAdmin?: boolean): Readonly<PermissionsBitField>; public permissionsFor(memberOrRole: GuildMember | Role, checkAdmin?: boolean): Readonly<PermissionsBitField>;
public permissionsFor( public permissionsFor(
memberOrRole: GuildMemberResolvable | RoleResolvable, memberOrRole: UserResolvable | RoleResolvable,
checkAdmin?: boolean, checkAdmin?: boolean,
): Readonly<PermissionsBitField> | null; ): Readonly<PermissionsBitField> | null;
public fetchOwner(options?: FetchThreadOwnerOptions): Promise<ThreadMember>; public fetchOwner(options?: FetchThreadOwnerOptions): Promise<ThreadMember>;
@@ -4177,12 +4177,12 @@ export class GuildManager extends CachedManager<Snowflake, Guild, GuildResolvabl
} }
export interface AddOrRemoveGuildMemberRoleOptions { export interface AddOrRemoveGuildMemberRoleOptions {
user: GuildMemberResolvable; user: UserResolvable;
role: RoleResolvable; role: RoleResolvable;
reason?: string; reason?: string;
} }
export class GuildMemberManager extends CachedManager<Snowflake, GuildMember, GuildMemberResolvable> { export class GuildMemberManager extends CachedManager<Snowflake, GuildMember, UserResolvable> {
private constructor(guild: Guild, iterable?: Iterable<RawGuildMemberData>); private constructor(guild: Guild, iterable?: Iterable<RawGuildMemberData>);
public guild: Guild; public guild: Guild;
public get me(): GuildMember | null; public get me(): GuildMember | null;
@@ -4474,7 +4474,7 @@ export class UserManager extends CachedManager<Snowflake, User, UserResolvable>
export class VoiceStateManager extends CachedManager<Snowflake, VoiceState, typeof VoiceState> { export class VoiceStateManager extends CachedManager<Snowflake, VoiceState, typeof VoiceState> {
private constructor(guild: Guild, iterable?: Iterable<RawVoiceStateData>); private constructor(guild: Guild, iterable?: Iterable<RawVoiceStateData>);
public guild: Guild; public guild: Guild;
public fetch(member: GuildMemberResolvable | '@me', options?: BaseFetchOptions): Promise<VoiceState>; public fetch(member: UserResolvable | '@me', options?: BaseFetchOptions): Promise<VoiceState>;
} }
//#endregion //#endregion
@@ -5856,7 +5856,7 @@ export interface GuildEditOptions {
afkTimeout?: number; afkTimeout?: number;
afkChannel?: VoiceChannelResolvable | null; afkChannel?: VoiceChannelResolvable | null;
icon?: BufferResolvable | Base64Resolvable | null; icon?: BufferResolvable | Base64Resolvable | null;
owner?: GuildMemberResolvable; owner?: UserResolvable;
splash?: BufferResolvable | Base64Resolvable | null; splash?: BufferResolvable | Base64Resolvable | null;
discoverySplash?: BufferResolvable | Base64Resolvable | null; discoverySplash?: BufferResolvable | Base64Resolvable | null;
banner?: BufferResolvable | Base64Resolvable | null; banner?: BufferResolvable | Base64Resolvable | null;
@@ -5911,8 +5911,6 @@ export interface GuildMemberEditOptions {
reason?: string; reason?: string;
} }
export type GuildMemberResolvable = GuildMember | UserResolvable;
export type GuildResolvable = Guild | NonThreadGuildBasedChannel | GuildMember | GuildEmoji | Invite | Role | Snowflake; export type GuildResolvable = Guild | NonThreadGuildBasedChannel | GuildMember | GuildEmoji | Invite | Role | Snowflake;
export interface GuildPruneMembersOptions { export interface GuildPruneMembersOptions {
@@ -6434,7 +6432,7 @@ export interface MultipleShardSpawnOptions {
export interface BaseOverwriteData { export interface BaseOverwriteData {
allow?: PermissionResolvable; allow?: PermissionResolvable;
deny?: PermissionResolvable; deny?: PermissionResolvable;
id: GuildMemberResolvable | RoleResolvable; id: UserResolvable | RoleResolvable;
type?: OverwriteType; type?: OverwriteType;
} }
@@ -6443,7 +6441,7 @@ export interface OverwriteDataWithMandatoryType extends BaseOverwriteData {
} }
export interface OverwriteDataWithOptionalType extends BaseOverwriteData { export interface OverwriteDataWithOptionalType extends BaseOverwriteData {
id: Exclude<GuildMemberResolvable | RoleResolvable, Snowflake>; id: Exclude<UserResolvable | RoleResolvable, Snowflake>;
} }
export type OverwriteData = OverwriteDataWithMandatoryType | OverwriteDataWithOptionalType; export type OverwriteData = OverwriteDataWithMandatoryType | OverwriteDataWithOptionalType;