feat(Formatters): Add a spoiler function (discordjs#16)

spacebarchat · Jul 28, 2021 · c213a6a · c213a6a
1 parent f83fe99
commit c213a6a
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 0 deletions.
diff --git a/src/messages/formatters.ts b/src/messages/formatters.ts
@@ -146,6 +146,15 @@ export function hyperlink(content: string, url: string | URL, title?: string) {
 	return title ? `[${content}](${url} "${title}")` : `[${content}](${url})`;
 }
 
+/**
+ * Wraps the content inside spoiler (hidden text).
+ * @param content The content to wrap.
+ * @returns The formatted content.
+ */
+export function spoiler<C extends string>(content: C): `||${C}||` {
+	return `||${content}||`;
+}
+
 /**
  * Formats the user ID into a user mention.
  * @param userId The user ID to format.

diff --git a/tests/messages.test.ts b/tests/messages.test.ts
@@ -6,6 +6,7 @@ import {
 	Faces,
 	hideLinkEmbed,
 	hyperlink,
+	spoiler,
 	inlineCode,
 	italic,
 	memberNicknameMention,
@@ -106,6 +107,12 @@ describe('Messages', () => {
 			).toBe('[discord.js](https://discord.js.org/ "Official Documentation")');
 		});
 	});
+
+	describe('spoiler', () => {
+		test('GIVEN "discord.js" THEN returns "||discord.js||"', () => {
+			expect<'||discord.js||'>(spoiler('discord.js')).toBe('||discord.js||');
+		});
+	});
 
 	describe('Mentions', () => {
 		describe('userMention', () => {