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

chore(ThreadMemberManager): make #fetch only take one object parameter (#6997)

Browse Source
This commit is contained in:
Suneet Tipirneni
2022-01-08 06:42:30 -05:00
committed by GitHub
parent cee7fd181c
commit 1db6c2d37e
3 changed files with 15 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
packages/discord.js/src/managers/ThreadMemberManager.js
View File

@@ -107,15 +107,18 @@ class ThreadMemberManager extends CachedManager {
return raw.reduce((col, member) => col.set(member.user_id, this._add(member, cache)), new Collection()); return raw.reduce((col, member) => col.set(member.user_id, this._add(member, cache)), new Collection());
} }
/**
* @typedef {BaseFetchOptions} ThreadMemberFetchOptions
* @property {UserResolvable} [member] The specific user to fetch from the thread
*/
/** /**
* Fetches member(s) for the thread from Discord, requires access to the `GUILD_MEMBERS` gateway intent. * Fetches member(s) for the thread from Discord, requires access to the `GUILD_MEMBERS` gateway intent.
* @param {UserResolvable|boolean} [member] The member to fetch. If `undefined`, all members * @param {ThreadMemberFetchOptions|boolean} [options] Additional options for this fetch, when a `boolean` is provided
* in the thread are fetched, and will be cached based on `options.cache`. If boolean, this serves * all members are fetched with `options.cache` set to the boolean value
* the purpose of `options.cache`.
* @param {BaseFetchOptions} [options] Additional options for this fetch
* @returns {Promise<ThreadMember|Collection<Snowflake, ThreadMember>>} * @returns {Promise<ThreadMember|Collection<Snowflake, ThreadMember>>}
*/ */
fetch(member, { cache = true, force = false } = {}) { fetch({ member, cache = true, force = false } = {}) {
const id = this.resolveId(member); const id = this.resolveId(member);
return id ? this._fetchOne(id, cache, force) : this._fetchMany(member ?? cache); return id ? this._fetchOne(id, cache, force) : this._fetchMany(member ?? cache);
} }

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

@@ -3213,8 +3213,7 @@ export class ThreadMemberManager extends CachedManager<Snowflake, ThreadMember,
private constructor(thread: ThreadChannel, iterable?: Iterable<RawThreadMemberData>); private constructor(thread: ThreadChannel, iterable?: Iterable<RawThreadMemberData>);
public thread: ThreadChannel; public thread: ThreadChannel;
public add(member: UserResolvable | '@me', reason?: string): Promise<Snowflake>; public add(member: UserResolvable | '@me', reason?: string): Promise<Snowflake>;
public fetch(member?: UserResolvable, options?: BaseFetchOptions): Promise<ThreadMember>; public fetch(options?: ThreadMemberFetchOptions): Promise<ThreadMember>;
/** @deprecated Use `fetch(member, options)` instead. */
public fetch(cache?: boolean): Promise<Collection<Snowflake, ThreadMember>>; public fetch(cache?: boolean): Promise<Collection<Snowflake, ThreadMember>>;
public remove(id: Snowflake | '@me', reason?: string): Promise<Snowflake>; public remove(id: Snowflake | '@me', reason?: string): Promise<Snowflake>;
} }
@@ -3732,6 +3731,10 @@ export interface BaseFetchOptions {
force?: boolean; force?: boolean;
} }
export interface ThreadMemberFetchOptions extends BaseFetchOptions {
member?: UserResolvable;
}
export interface BaseMessageComponentOptions { export interface BaseMessageComponentOptions {
type?: MessageComponentType | MessageComponentTypes; type?: MessageComponentType | MessageComponentTypes;
} }

4
packages/discord.js/typings/index.test-d.ts
View File

@@ -461,8 +461,8 @@ client.on('guildCreate', async g => {
if (!channel) return; if (!channel) return;
if (channel.isThread()) { if (channel.isThread()) {
const fetchedMember = await channel.members.fetch('12345678'); const fetchedMember = await channel.members.fetch({ member: '12345678' });
expectType<ThreadMember>(fetchedMember); assertType<ThreadMember>(fetchedMember);
const fetchedMemberCol = await channel.members.fetch(true); const fetchedMemberCol = await channel.members.fetch(true);
expectDeprecated(await channel.members.fetch(true)); expectDeprecated(await channel.members.fetch(true));
expectType<Collection<Snowflake, ThreadMember>>(fetchedMemberCol); expectType<Collection<Snowflake, ThreadMember>>(fetchedMemberCol);