aboutsummaryrefslogtreecommitdiff
path: root/lib/utils/AllowedMentions.ts
blob: d2eb030b0fe2e0062710a4c5d8ef17cb8146fd29 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
import { type MessageMentionOptions, type MessageMentionTypes } from 'discord.js';

/**
 * A utility class for creating allowed mentions.
 */
export class AllowedMentions {
	/**
	 * @param everyone Whether everyone and here should be mentioned.
	 * @param roles Whether roles should be mentioned.
	 * @param users Whether users should be mentioned.
	 * @param repliedUser Whether the author of the Message being replied to should be mentioned.
	 */
	public constructor(public everyone = false, public roles = false, public users = true, public repliedUser = true) {}

	/**
	 * Don't mention anyone.
	 * @param repliedUser Whether the author of the Message being replied to should be mentioned.
	 */
	public static none(repliedUser = true): MessageMentionOptions {
		return { parse: [], repliedUser };
	}

	/**
	 * Mention @everyone and @here, roles, and users.
	 * @param repliedUser Whether the author of the Message being replied to should be mentioned.
	 */
	public static all(repliedUser = true): MessageMentionOptions {
		return { parse: ['everyone', 'roles', 'users'], repliedUser };
	}

	/**
	 * Mention users.
	 * @param repliedUser Whether the author of the Message being replied to should be mentioned.
	 */
	public static users(repliedUser = true): MessageMentionOptions {
		return { parse: ['users'], repliedUser };
	}

	/**
	 * Mention everyone and here.
	 * @param repliedUser Whether the author of the Message being replied to should be mentioned.
	 */
	public static everyone(repliedUser = true): MessageMentionOptions {
		return { parse: ['everyone'], repliedUser };
	}

	/**
	 * Mention roles.
	 * @param repliedUser Whether the author of the Message being replied to should be mentioned.
	 */
	public static roles(repliedUser = true): MessageMentionOptions {
		return { parse: ['roles'], repliedUser };
	}

	/**
	 * Converts this into a MessageMentionOptions object.
	 */
	public toObject(): MessageMentionOptions {
		return {
			parse: [
				...(this.users ? ['users'] : []),
				...(this.roles ? ['roles'] : []),
				...(this.everyone ? ['everyone'] : [])
			] as MessageMentionTypes[],
			repliedUser: this.repliedUser
		};
	}
}