mirror of
https://github.com/discordjs/discord.js.git
synced 2026-03-09 16:13:31 +01:00
refactor: deprecate v13 properties and methods (#7782)
* refactor: deprecate splitting * refactor: deprecate `IntegrationApplication#summary` https://github.com/discordjs/discord.js/pull/7729 * docs: amend store channel wording * refactor: deprecate fetching of application assets * docs: deprecate vip field in voice regions
This commit is contained in:
@@ -54,6 +54,7 @@ class IntegrationApplication extends Application {
|
|||||||
/**
|
/**
|
||||||
* The application's summary
|
* The application's summary
|
||||||
* @type {?string}
|
* @type {?string}
|
||||||
|
* @deprecated This property is no longer being sent by the API.
|
||||||
*/
|
*/
|
||||||
this.summary = data.summary;
|
this.summary = data.summary;
|
||||||
} else {
|
} else {
|
||||||
|
|||||||
@@ -4,7 +4,7 @@ const GuildChannel = require('./GuildChannel');
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Represents a guild store channel on Discord.
|
* Represents a guild store channel on Discord.
|
||||||
* <warn>Store channels are deprecated and will be removed from Discord in March 2022. See
|
* <warn>Store channels have been removed from Discord. See
|
||||||
* [Self-serve Game Selling Deprecation](https://support-dev.discord.com/hc/en-us/articles/4414590563479)
|
* [Self-serve Game Selling Deprecation](https://support-dev.discord.com/hc/en-us/articles/4414590563479)
|
||||||
* for more information.</warn>
|
* for more information.</warn>
|
||||||
* @extends {GuildChannel}
|
* @extends {GuildChannel}
|
||||||
|
|||||||
@@ -22,6 +22,7 @@ class VoiceRegion {
|
|||||||
/**
|
/**
|
||||||
* Whether the region is VIP-only
|
* Whether the region is VIP-only
|
||||||
* @type {boolean}
|
* @type {boolean}
|
||||||
|
* @deprecated This property is no longer being sent by the API.
|
||||||
*/
|
*/
|
||||||
this.vip = data.vip;
|
this.vip = data.vip;
|
||||||
|
|
||||||
|
|||||||
@@ -1,11 +1,14 @@
|
|||||||
'use strict';
|
'use strict';
|
||||||
|
|
||||||
|
const process = require('node:process');
|
||||||
const { ClientApplicationAssetTypes, Endpoints } = require('../../util/Constants');
|
const { ClientApplicationAssetTypes, Endpoints } = require('../../util/Constants');
|
||||||
const SnowflakeUtil = require('../../util/SnowflakeUtil');
|
const SnowflakeUtil = require('../../util/SnowflakeUtil');
|
||||||
const Base = require('../Base');
|
const Base = require('../Base');
|
||||||
|
|
||||||
const AssetTypes = Object.keys(ClientApplicationAssetTypes);
|
const AssetTypes = Object.keys(ClientApplicationAssetTypes);
|
||||||
|
|
||||||
|
let deprecationEmittedForFetchAssets = false;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Represents an OAuth2 Application.
|
* Represents an OAuth2 Application.
|
||||||
* @abstract
|
* @abstract
|
||||||
@@ -103,8 +106,18 @@ class Application extends Base {
|
|||||||
/**
|
/**
|
||||||
* Gets the application's rich presence assets.
|
* Gets the application's rich presence assets.
|
||||||
* @returns {Promise<Array<ApplicationAsset>>}
|
* @returns {Promise<Array<ApplicationAsset>>}
|
||||||
|
* @deprecated This will be removed in the next major as it is unsupported functionality.
|
||||||
*/
|
*/
|
||||||
async fetchAssets() {
|
async fetchAssets() {
|
||||||
|
if (!deprecationEmittedForFetchAssets) {
|
||||||
|
process.emitWarning(
|
||||||
|
'Application#fetchAssets is deprecated as it is unsupported and will be removed in the next major version.',
|
||||||
|
'DeprecationWarning',
|
||||||
|
);
|
||||||
|
|
||||||
|
deprecationEmittedForFetchAssets = true;
|
||||||
|
}
|
||||||
|
|
||||||
const assets = await this.client.api.oauth2.applications(this.id).assets.get();
|
const assets = await this.client.api.oauth2.applications(this.id).assets.get();
|
||||||
return assets.map(a => ({
|
return assets.map(a => ({
|
||||||
id: a.id,
|
id: a.id,
|
||||||
|
|||||||
@@ -10,6 +10,7 @@ const { Error: DiscordError, RangeError, TypeError } = require('../errors');
|
|||||||
const has = (o, k) => Object.prototype.hasOwnProperty.call(o, k);
|
const has = (o, k) => Object.prototype.hasOwnProperty.call(o, k);
|
||||||
const isObject = d => typeof d === 'object' && d !== null;
|
const isObject = d => typeof d === 'object' && d !== null;
|
||||||
|
|
||||||
|
let deprecationEmittedForSplitMessage = false;
|
||||||
let deprecationEmittedForRemoveMentions = false;
|
let deprecationEmittedForRemoveMentions = false;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -70,9 +71,19 @@ class Util extends null {
|
|||||||
* Splits a string into multiple chunks at a designated character that do not exceed a specific length.
|
* Splits a string into multiple chunks at a designated character that do not exceed a specific length.
|
||||||
* @param {string} text Content to split
|
* @param {string} text Content to split
|
||||||
* @param {SplitOptions} [options] Options controlling the behavior of the split
|
* @param {SplitOptions} [options] Options controlling the behavior of the split
|
||||||
|
* @deprecated This will be removed in the next major version.
|
||||||
* @returns {string[]}
|
* @returns {string[]}
|
||||||
*/
|
*/
|
||||||
static splitMessage(text, { maxLength = 2_000, char = '\n', prepend = '', append = '' } = {}) {
|
static splitMessage(text, { maxLength = 2_000, char = '\n', prepend = '', append = '' } = {}) {
|
||||||
|
if (!deprecationEmittedForSplitMessage) {
|
||||||
|
process.emitWarning(
|
||||||
|
'The Util.splitMessage method is deprecated and will be removed in the next major version.',
|
||||||
|
'DeprecationWarning',
|
||||||
|
);
|
||||||
|
|
||||||
|
deprecationEmittedForSplitMessage = true;
|
||||||
|
}
|
||||||
|
|
||||||
text = Util.verifyString(text);
|
text = Util.verifyString(text);
|
||||||
if (text.length <= maxLength) return [text];
|
if (text.length <= maxLength) return [text];
|
||||||
let splitText = [text];
|
let splitText = [text];
|
||||||
|
|||||||
4
typings/index.d.ts
vendored
4
typings/index.d.ts
vendored
@@ -212,6 +212,7 @@ export abstract class Application extends Base {
|
|||||||
public id: Snowflake;
|
public id: Snowflake;
|
||||||
public name: string | null;
|
public name: string | null;
|
||||||
public coverURL(options?: StaticImageURLOptions): string | null;
|
public coverURL(options?: StaticImageURLOptions): string | null;
|
||||||
|
/** @deprecated This method is deprecated as it is unsupported and will be removed in the next major version. */
|
||||||
public fetchAssets(): Promise<ApplicationAsset[]>;
|
public fetchAssets(): Promise<ApplicationAsset[]>;
|
||||||
public iconURL(options?: StaticImageURLOptions): string | null;
|
public iconURL(options?: StaticImageURLOptions): string | null;
|
||||||
public toJSON(): unknown;
|
public toJSON(): unknown;
|
||||||
@@ -1330,6 +1331,7 @@ export class IntegrationApplication extends Application {
|
|||||||
public termsOfServiceURL: string | null;
|
public termsOfServiceURL: string | null;
|
||||||
public privacyPolicyURL: string | null;
|
public privacyPolicyURL: string | null;
|
||||||
public rpcOrigins: string[];
|
public rpcOrigins: string[];
|
||||||
|
/** @deprecated This property is no longer being sent by the API. */
|
||||||
public summary: string | null;
|
public summary: string | null;
|
||||||
public hook: boolean | null;
|
public hook: boolean | null;
|
||||||
public cover: string | null;
|
public cover: string | null;
|
||||||
@@ -2627,6 +2629,7 @@ export class Util extends null {
|
|||||||
route: unknown,
|
route: unknown,
|
||||||
reason?: string,
|
reason?: string,
|
||||||
): Promise<{ id: Snowflake; position: number }[]>;
|
): Promise<{ id: Snowflake; position: number }[]>;
|
||||||
|
/** @deprecated This will be removed in the next major version. */
|
||||||
public static splitMessage(text: string, options?: SplitOptions): string[];
|
public static splitMessage(text: string, options?: SplitOptions): string[];
|
||||||
public static resolveAutoArchiveMaxLimit(guild: Guild): number;
|
public static resolveAutoArchiveMaxLimit(guild: Guild): number;
|
||||||
}
|
}
|
||||||
@@ -2671,6 +2674,7 @@ export class VoiceRegion {
|
|||||||
public id: string;
|
public id: string;
|
||||||
public name: string;
|
public name: string;
|
||||||
public optimal: boolean;
|
public optimal: boolean;
|
||||||
|
/** @deprecated This property is no longer being sent by the API. */
|
||||||
public vip: boolean;
|
public vip: boolean;
|
||||||
public toJSON(): unknown;
|
public toJSON(): unknown;
|
||||||
}
|
}
|
||||||
|
|||||||
Reference in New Issue
Block a user