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

fix(GuildEditData): some fields can be null (#7632)

Browse Source 
* fix(GuildEditData): some fields can be null

* fix: make even more things nullable
This commit is contained in:
Almeida
2022-03-24 19:59:38 +00:00
committed by GitHub
parent cd79bef254
commit 4d2b55955d
2 changed files with 34 additions and 31 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -739,24 +739,24 @@ class Guild extends AnonymousGuild {
* The data for editing a guild. * The data for editing a guild.
* @typedef {Object} GuildEditData * @typedef {Object} GuildEditData
* @property {string} [name] The name of the guild * @property {string} [name] The name of the guild
* @property {VerificationLevel|number} [verificationLevel] The verification level of the guild * @property {?(VerificationLevel|number)} [verificationLevel] The verification level of the guild
* @property {ExplicitContentFilterLevel|number} [explicitContentFilter] The level of the explicit content filter * @property {?(ExplicitContentFilterLevel|number)} [explicitContentFilter] The level of the explicit content filter
* @property {VoiceChannelResolvable} [afkChannel] The AFK channel of the guild * @property {?VoiceChannelResolvable} [afkChannel] The AFK channel of the guild
* @property {TextChannelResolvable} [systemChannel] The system channel of the guild * @property {?TextChannelResolvable} [systemChannel] The system 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 {GuildMemberResolvable} [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
* @property {DefaultMessageNotificationLevel|number} [defaultMessageNotifications] The default message notification * @property {?(DefaultMessageNotificationLevel|number)} [defaultMessageNotifications] The default message
* level of the guild * notification level of the guild
* @property {SystemChannelFlagsResolvable} [systemChannelFlags] The system channel flags of the guild * @property {SystemChannelFlagsResolvable} [systemChannelFlags] The system channel flags of the guild
* @property {TextChannelResolvable} [rulesChannel] The rules channel of the guild * @property {?TextChannelResolvable} [rulesChannel] The rules channel of the guild
* @property {TextChannelResolvable} [publicUpdatesChannel] The community updates channel of the guild * @property {?TextChannelResolvable} [publicUpdatesChannel] The community updates channel of the guild
* @property {string} [preferredLocale] The preferred locale of the guild * @property {?string} [preferredLocale] The preferred locale of the guild
* @property {boolean} [premiumProgressBarEnabled] Whether the guild's premium progress bar is enabled * @property {boolean} [premiumProgressBarEnabled] Whether the guild's premium progress bar is enabled
* @property {string} [description] The discovery description of the guild * @property {?string} [description] The discovery description of the guild
* @property {GuildFeature[]} [features] The features of the guild * @property {GuildFeature[]} [features] The features of the guild
*/ */
@@ -828,7 +828,7 @@ class Guild extends AnonymousGuild {
if (typeof data.description !== 'undefined') { if (typeof data.description !== 'undefined') {
_data.description = data.description; _data.description = data.description;
} }
if (data.preferredLocale) _data.preferred_locale = data.preferredLocale; if (typeof data.preferredLocale !== 'undefined') _data.preferred_locale = data.preferredLocale;
if ('premiumProgressBarEnabled' in data) _data.premium_progress_bar_enabled = data.premiumProgressBarEnabled; if ('premiumProgressBarEnabled' in data) _data.premium_progress_bar_enabled = data.premiumProgressBarEnabled;
const newData = await this.client.rest.patch(Routes.guild(this.id), { body: _data, reason }); const newData = await this.client.rest.patch(Routes.guild(this.id), { body: _data, reason });
return this.client.actions.GuildUpdate.handle(newData).updated; return this.client.actions.GuildUpdate.handle(newData).updated;
@@ -906,7 +906,7 @@ class Guild extends AnonymousGuild {
/** /**
* Edits the level of the explicit content filter. * Edits the level of the explicit content filter.
* @param {ExplicitContentFilterLevel|number} explicitContentFilter The new level of the explicit content filter * @param {?(ExplicitContentFilterLevel|number)} explicitContentFilter The new level of the explicit content filter
* @param {string} [reason] Reason for changing the level of the guild's explicit content filter * @param {string} [reason] Reason for changing the level of the guild's explicit content filter
* @returns {Promise<Guild>} * @returns {Promise<Guild>}
*/ */
@@ -917,7 +917,7 @@ class Guild extends AnonymousGuild {
/* eslint-disable max-len */ /* eslint-disable max-len */
/** /**
* Edits the setting of the default message notifications of the guild. * Edits the setting of the default message notifications of the guild.
* @param {DefaultMessageNotificationLevel|number} defaultMessageNotifications The new default message notification level of the guild * @param {?(DefaultMessageNotificationLevel|number)} defaultMessageNotifications The new default message notification level of the guild
* @param {string} [reason] Reason for changing the setting of the default message notifications * @param {string} [reason] Reason for changing the setting of the default message notifications
* @returns {Promise<Guild>} * @returns {Promise<Guild>}
*/ */
@@ -953,7 +953,7 @@ class Guild extends AnonymousGuild {
/** /**
* Edits the verification level of the guild. * Edits the verification level of the guild.
* @param {VerificationLevel} verificationLevel The new verification level of the guild * @param {?VerificationLevel} verificationLevel The new verification level of the guild
* @param {string} [reason] Reason for changing the guild's verification level * @param {string} [reason] Reason for changing the guild's verification level
* @returns {Promise<Guild>} * @returns {Promise<Guild>}
* @example * @example
@@ -968,7 +968,7 @@ class Guild extends AnonymousGuild {
/** /**
* Edits the AFK channel of the guild. * Edits the AFK channel of the guild.
* @param {VoiceChannelResolvable} afkChannel The new AFK channel * @param {?VoiceChannelResolvable} afkChannel The new AFK channel
* @param {string} [reason] Reason for changing the guild's AFK channel * @param {string} [reason] Reason for changing the guild's AFK channel
* @returns {Promise<Guild>} * @returns {Promise<Guild>}
* @example * @example
@@ -983,7 +983,7 @@ class Guild extends AnonymousGuild {
/** /**
* Edits the system channel of the guild. * Edits the system channel of the guild.
* @param {TextChannelResolvable} systemChannel The new system channel * @param {?TextChannelResolvable} systemChannel The new system channel
* @param {string} [reason] Reason for changing the guild's system channel * @param {string} [reason] Reason for changing the guild's system channel
* @returns {Promise<Guild>} * @returns {Promise<Guild>}
* @example * @example
@@ -1088,7 +1088,7 @@ class Guild extends AnonymousGuild {
/** /**
* Edits the rules channel of the guild. * Edits the rules channel of the guild.
* @param {TextChannelResolvable} rulesChannel The new rules channel * @param {?TextChannelResolvable} rulesChannel The new rules channel
* @param {string} [reason] Reason for changing the guild's rules channel * @param {string} [reason] Reason for changing the guild's rules channel
* @returns {Promise<Guild>} * @returns {Promise<Guild>}
* @example * @example
@@ -1103,7 +1103,7 @@ class Guild extends AnonymousGuild {
/** /**
* Edits the community updates channel of the guild. * Edits the community updates channel of the guild.
* @param {TextChannelResolvable} publicUpdatesChannel The new community updates channel * @param {?TextChannelResolvable} publicUpdatesChannel The new community updates channel
* @param {string} [reason] Reason for changing the guild's community updates channel * @param {string} [reason] Reason for changing the guild's community updates channel
* @returns {Promise<Guild>} * @returns {Promise<Guild>}
* @example * @example
@@ -1118,7 +1118,7 @@ class Guild extends AnonymousGuild {
/** /**
* Edits the preferred locale of the guild. * Edits the preferred locale of the guild.
* @param {string} preferredLocale The new preferred locale of the guild * @param {?Locale} preferredLocale The new preferred locale of the guild
* @param {string} [reason] Reason for changing the guild's preferred locale * @param {string} [reason] Reason for changing the guild's preferred locale
* @returns {Promise<Guild>} * @returns {Promise<Guild>}
* @example * @example

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

@@ -1099,24 +1099,27 @@ export class Guild extends AnonymousGuild {
public setAFKTimeout(afkTimeout: number, reason?: string): Promise<Guild>; public setAFKTimeout(afkTimeout: number, reason?: string): Promise<Guild>;
public setBanner(banner: BufferResolvable | Base64Resolvable | null, reason?: string): Promise<Guild>; public setBanner(banner: BufferResolvable | Base64Resolvable | null, reason?: string): Promise<Guild>;
public setDefaultMessageNotifications( public setDefaultMessageNotifications(
defaultMessageNotifications: GuildDefaultMessageNotifications, defaultMessageNotifications: GuildDefaultMessageNotifications | null,
reason?: string, reason?: string,
): Promise<Guild>; ): Promise<Guild>;
public setDiscoverySplash( public setDiscoverySplash(
discoverySplash: BufferResolvable | Base64Resolvable | null, discoverySplash: BufferResolvable | Base64Resolvable | null,
reason?: string, reason?: string,
): Promise<Guild>; ): Promise<Guild>;
public setExplicitContentFilter(explicitContentFilter: GuildExplicitContentFilter, reason?: string): Promise<Guild>; public setExplicitContentFilter(
explicitContentFilter: GuildExplicitContentFilter | null,
reason?: string,
): 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: GuildMemberResolvable, reason?: string): Promise<Guild>;
public setPreferredLocale(preferredLocale: Locale, 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>;
public setSplash(splash: BufferResolvable | Base64Resolvable | null, reason?: string): Promise<Guild>; public setSplash(splash: BufferResolvable | Base64Resolvable | null, reason?: string): Promise<Guild>;
public setSystemChannel(systemChannel: TextChannelResolvable | null, reason?: string): Promise<Guild>; public setSystemChannel(systemChannel: TextChannelResolvable | null, reason?: string): Promise<Guild>;
public setSystemChannelFlags(systemChannelFlags: SystemChannelFlagsResolvable, reason?: string): Promise<Guild>; public setSystemChannelFlags(systemChannelFlags: SystemChannelFlagsResolvable, reason?: string): Promise<Guild>;
public setVerificationLevel(verificationLevel: GuildVerificationLevel, reason?: string): Promise<Guild>; public setVerificationLevel(verificationLevel: GuildVerificationLevel | null, reason?: string): Promise<Guild>;
public setPremiumProgressBarEnabled(enabled?: boolean, reason?: string): Promise<Guild>; public setPremiumProgressBarEnabled(enabled?: boolean, reason?: string): Promise<Guild>;
public setWidgetSettings(settings: GuildWidgetSettingsData, reason?: string): Promise<Guild>; public setWidgetSettings(settings: GuildWidgetSettingsData, reason?: string): Promise<Guild>;
public toJSON(): unknown; public toJSON(): unknown;
@@ -4442,11 +4445,11 @@ export interface GuildWidgetSettings {
export interface GuildEditData { export interface GuildEditData {
name?: string; name?: string;
verificationLevel?: GuildVerificationLevel; verificationLevel?: GuildVerificationLevel | null;
explicitContentFilter?: GuildExplicitContentFilter; explicitContentFilter?: GuildExplicitContentFilter | null;
defaultMessageNotifications?: GuildDefaultMessageNotifications; defaultMessageNotifications?: GuildDefaultMessageNotifications | null;
afkChannel?: VoiceChannelResolvable; afkChannel?: VoiceChannelResolvable | null;
systemChannel?: TextChannelResolvable; systemChannel?: TextChannelResolvable | null;
systemChannelFlags?: SystemChannelFlagsResolvable; systemChannelFlags?: SystemChannelFlagsResolvable;
afkTimeout?: number; afkTimeout?: number;
icon?: BufferResolvable | Base64Resolvable | null; icon?: BufferResolvable | Base64Resolvable | null;
@@ -4454,9 +4457,9 @@ export interface GuildEditData {
splash?: BufferResolvable | Base64Resolvable | null; splash?: BufferResolvable | Base64Resolvable | null;
discoverySplash?: BufferResolvable | Base64Resolvable | null; discoverySplash?: BufferResolvable | Base64Resolvable | null;
banner?: BufferResolvable | Base64Resolvable | null; banner?: BufferResolvable | Base64Resolvable | null;
rulesChannel?: TextChannelResolvable; rulesChannel?: TextChannelResolvable | null;
publicUpdatesChannel?: TextChannelResolvable; publicUpdatesChannel?: TextChannelResolvable | null;
preferredLocale?: Locale; preferredLocale?: Locale | null;
premiumProgressBarEnabled?: boolean; premiumProgressBarEnabled?: boolean;
description?: string | null; description?: string | null;
features?: GuildFeature[]; features?: GuildFeature[];