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

fix: deprecate underscore in favor of underline (#10054)

Browse Source 
* fix: deprecate `underscore` in favor of `underline`

* refactor: use `underline` in `underscore`

Co-authored-by: Almeida <github@almeidx.dev>

---------

Co-authored-by: Almeida <github@almeidx.dev>
This commit is contained in:
Danial Raza
2023-12-17 21:44:54 +01:00
committed by GitHub
parent 1acc9abae2
commit 461948c07d
2 changed files with 14 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
packages/formatters/__tests__/formatters.test.ts
View File

@@ -24,7 +24,7 @@ import {
strikethrough, strikethrough,
time, time,
TimestampStyles, TimestampStyles,
underscore, underline,
unorderedList, unorderedList,
userMention, userMention,
} from '../src/index.js'; } from '../src/index.js';
@@ -58,9 +58,9 @@ describe('Message formatters', () => {
}); });
}); });
describe('underscore', () => { describe('underline', () => {
test('GIVEN "discord.js" THEN returns "__discord.js__"', () => { test('GIVEN "discord.js" THEN returns "__discord.js__"', () => {
expect<'__discord.js__'>(underscore('discord.js')).toEqual('__discord.js__'); expect<'__discord.js__'>(underline('discord.js')).toEqual('__discord.js__');
}); });
}); });

11
packages/formatters/src/formatters.ts
View File

@@ -61,8 +61,19 @@ export function bold<Content extends string>(content: Content): `**${Content}**`
* *
* @typeParam Content - This is inferred by the supplied content * @typeParam Content - This is inferred by the supplied content
* @param content - The content to wrap * @param content - The content to wrap
* @deprecated Use {@link underline} instead.
*/ */
export function underscore<Content extends string>(content: Content): `__${Content}__` { export function underscore<Content extends string>(content: Content): `__${Content}__` {
return underline(content);
}
/**
* Formats the content into underlined text.
*
* @typeParam Content - This is inferred by the supplied content
* @param content - The content to wrap
*/
export function underline<Content extends string>(content: Content): `__${Content}__` {
return `__${content}__`; return `__${content}__`;
} }