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

refactor(guild)!: remove deprecated get guild overload (#10052)

Browse Source 
BREAKING CHANGE: Removed `GuildsAPI#get` overload that allowed passing options as 2nd parameter

---------

Co-authored-by: Jiralite <33201955+Jiralite@users.noreply.github.com>
This commit is contained in:
Jaw0r3k
2024-12-05 20:05:15 +01:00
committed by GitHub
parent 6304c0177e
commit dd430c090d
1 changed files with 5 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files

35
packages/core/src/api/guild.ts
View File

@@ -117,16 +117,6 @@ export interface CreateStickerOptions extends Omit<RESTPostAPIGuildStickerFormDa
export class GuildsAPI { export class GuildsAPI {
public constructor(private readonly rest: REST) {} public constructor(private readonly rest: REST) {}
/**
* Fetches a guild
*
* @see {@link https://discord.com/developers/docs/resources/guild#get-guild}
* @param guildId - The id of the guild
* @param options - The options for fetching the guild
* @deprecated Use the overload with a query instead.
*/
public async get(guildId: Snowflake, { signal }?: Pick<RequestData, 'signal'>): Promise<RESTGetAPIGuildResult>;
/** /**
* Fetches a guild * Fetches a guild
* *
@@ -135,26 +125,11 @@ export class GuildsAPI {
* @param query - The query options for fetching the guild * @param query - The query options for fetching the guild
* @param options - The options for fetching the guild * @param options - The options for fetching the guild
*/ */
public async get( public async get(guildId: Snowflake, query: RESTGetAPIGuildQuery = {}, { signal }: Pick<RequestData, 'signal'> = {}) {
guildId: Snowflake, return this.rest.get(Routes.guild(guildId), {
query?: RESTGetAPIGuildQuery, query: makeURLSearchParams(query),
options?: Pick<RequestData, 'signal'>, signal,
): Promise<RESTGetAPIGuildResult>; }) as Promise<RESTGetAPIGuildResult>;
public async get(
guildId: Snowflake,
queryOrOptions: Pick<RequestData, 'signal'> | RESTGetAPIGuildQuery = {},
options: Pick<RequestData, 'signal'> = {},
) {
const requestData: RequestData = {
signal: ('signal' in queryOrOptions ? queryOrOptions : options).signal,
};
if ('with_counts' in queryOrOptions) {
requestData.query = makeURLSearchParams(queryOrOptions);
}
return this.rest.get(Routes.guild(guildId), requestData) as Promise<RESTGetAPIGuildResult>;
} }
/** /**