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

refactor(User): set accentColor and banner to undefined when not yet received (#6721)

Browse Source 
Co-authored-by: Sugden <28943913+NotSugden@users.noreply.github.com>
This commit is contained in:
Rodry
2021-10-04 23:16:59 +01:00
committed by GitHub
parent d0025beb7b
commit ba93e85d0d
3 changed files with 14 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
src/errors/Messages.js
View File

@@ -60,6 +60,7 @@ const Messages = {
FILE_NOT_FOUND: file => `File could not be found: ${file}`, FILE_NOT_FOUND: file => `File could not be found: ${file}`,
USER_BANNER_NOT_FETCHED: "You must fetch this user's banner before trying to generate its URL!",
USER_NO_DMCHANNEL: 'No DM Channel exists!', USER_NO_DMCHANNEL: 'No DM Channel exists!',
VOICE_NOT_STAGE_CHANNEL: 'You are only allowed to do this in stage channels.', VOICE_NOT_STAGE_CHANNEL: 'You are only allowed to do this in stage channels.',

18
src/structures/User.js
View File

@@ -74,23 +74,23 @@ class User extends Base {
if ('banner' in data) { if ('banner' in data) {
/** /**
* The user banner's hash * The user banner's hash
* <info>The user must be force fetched for this property to be present</info> * <info>The user must be force fetched for this property to be present or be updated</info>
* @type {?string} * @type {?string}
*/ */
this.banner = data.banner; this.banner = data.banner;
} else { } else if (this.banner !== null) {
this.banner ??= null; this.banner ??= undefined;
} }
if ('accent_color' in data) { if ('accent_color' in data) {
/** /**
* The base 10 accent color of the user's banner * The base 10 accent color of the user's banner
* <info>The user must be force fetched for this property to be present</info> * <info>The user must be force fetched for this property to be present or be updated</info>
* @type {?number} * @type {?number}
*/ */
this.accentColor = data.accent_color; this.accentColor = data.accent_color;
} else { } else if (this.accentColor !== null) {
this.accentColor ??= null; this.accentColor ??= undefined;
} }
if ('system' in data) { if ('system' in data) {
@@ -175,17 +175,19 @@ class User extends Base {
* @readonly * @readonly
*/ */
get hexAccentColor() { get hexAccentColor() {
if (!this.accentColor) return null; if (typeof this.accentColor !== 'number') return this.accentColor;
return `#${this.accentColor.toString(16).padStart(6, '0')}`; return `#${this.accentColor.toString(16).padStart(6, '0')}`;
} }
/** /**
* A link to the user's banner. * A link to the user's banner.
* <info>The user must be force fetched for this property to be present</info> * <info>This method will throw an error if called before the user is force fetched.
* See {@link User#banner} for more info</info>
* @param {ImageURLOptions} [options={}] Options for the Image URL * @param {ImageURLOptions} [options={}] Options for the Image URL
* @returns {?string} * @returns {?string}
*/ */
bannerURL({ format, size, dynamic } = {}) { bannerURL({ format, size, dynamic } = {}) {
if (typeof this.banner === 'undefined') throw new Error('USER_BANNER_NOT_FETCHED');
if (!this.banner) return null; if (!this.banner) return null;
return this.client.rest.cdn.Banner(this.id, this.banner, format, size, dynamic); return this.client.rest.cdn.Banner(this.id, this.banner, format, size, dynamic);
} }

6
typings/index.d.ts vendored
View File

@@ -2039,9 +2039,9 @@ export class User extends PartialTextBasedChannel(Base) {
protected constructor(client: Client, data: RawUserData); protected constructor(client: Client, data: RawUserData);
private _equals(user: APIUser): boolean; private _equals(user: APIUser): boolean;
public accentColor: number | null; public accentColor: number | null | undefined;
public avatar: string | null; public avatar: string | null;
public banner: string | null; public banner: string | null | undefined;
public bot: boolean; public bot: boolean;
public readonly createdAt: Date; public readonly createdAt: Date;
public readonly createdTimestamp: number; public readonly createdTimestamp: number;
@@ -2049,7 +2049,7 @@ export class User extends PartialTextBasedChannel(Base) {
public readonly defaultAvatarURL: string; public readonly defaultAvatarURL: string;
public readonly dmChannel: DMChannel | null; public readonly dmChannel: DMChannel | null;
public flags: Readonly<UserFlags> | null; public flags: Readonly<UserFlags> | null;
public readonly hexAccentColor: HexColorString | null; public readonly hexAccentColor: HexColorString | null | undefined;
public id: Snowflake; public id: Snowflake;
public readonly partial: false; public readonly partial: false;
public system: boolean; public system: boolean;