Section titled FormattersFormatters

discord.js provides the @discordjs/formatters package which contains a variety of utilities you can use when writing your Discord bot.

Section titled Basic MarkdownBasic Markdown

These functions format strings into all the different markdown styles supported by Discord.

import { bold, italic, strikethrough, underscore, spoiler, quote, blockQuote } from 'discord.js';

const string = 'Hello!';
const boldString = bold(string);
const italicString = italic(string);
const strikethroughString = strikethrough(string);
const underscoreString = underscore(string);
const spoilerString = spoiler(string);
const quoteString = quote(string);
const blockquoteString = blockQuote(string);

There are also two functions to format hyperlinks. hyperlink() will format the URL into a masked markdown link, and hideLinkEmbed() will wrap the URL in <>, preventing it from embedding.

import { hyperlink, hideLinkEmbed } from 'discord.js';

const url = 'https://discord.js.org/';
const link = hyperlink('discord.js', url);
const hiddenEmbed = hideLinkEmbed(url);

Section titled Code blocksCode blocks

You can use inlineCode() and codeBlock() to turn a string into an inline code block or a regular code block with or without syntax highlighting.

import { inlineCode, codeBlock } from 'discord.js';

const jsString = 'const value = true;';
const inline = inlineCode(jsString);
const codeblock = codeBlock(jsString);
const highlighted = codeBlock('js', jsString);

Section titled TimestampsTimestamps

With time(), you can format Unix timestamps and dates into a Discord time string.

import { time, TimestampStyles } from 'discord.js';

const date = new Date();
const timeString = time(date);
const relative = time(date, TimestampStyles.RelativeTime);

Section titled MentionsMentions

userMention(), channelMention(), and roleMention() all exist to format Snowflakes into mentions.

import { channelMention, roleMention, userMention } from 'discord.js';

const id = '123456789012345678';
const channel = channelMention(id);
const role = roleMention(id);
const user = userMention(id);