docs(Util): Deprecate .removeMentions() (#6866)

This commit is contained in:
Jiralite
2021-10-24 23:35:13 +01:00
committed by GitHub
parent 7621e9da4c
commit b6c9fd691f
2 changed files with 4 additions and 0 deletions

View File

@@ -575,6 +575,7 @@ class Util extends null {
* Breaks user, role and everyone/here mentions by adding a zero width space after every @ character
* @param {string} str The string to sanitize
* @returns {string}
* @deprecated Use {@link BaseMessageOptions#allowedMentions} instead.
*/
static removeMentions(str) {
return str.replaceAll('@', '@\u200b');
@@ -582,6 +583,8 @@ class Util extends null {
/**
* The content to have all mentions replaced by the equivalent text.
* <warn>When {@link Util.removeMentions} is removed, this method will no longer sanitize mentions.
* Use {@link BaseMessageOptions#allowedMentions} instead to prevent mentions when sending a message.</warn>
* @param {string} str The string to be converted
* @param {TextBasedChannels} channel The channel the string was sent in
* @returns {string}

1
typings/index.d.ts vendored
View File

@@ -2121,6 +2121,7 @@ export class Util extends null {
public static basename(path: string, ext?: string): string;
public static binaryToId(num: string): Snowflake;
public static cleanContent(str: string, channel: TextBasedChannels): string;
/** @deprecated Use {@link MessageOptions.allowedMentions} to control mentions in a message instead. */
public static removeMentions(str: string): string;
public static cloneObject(obj: unknown): unknown;
public static delayFor(ms: number): Promise<void>;