Calamity.Utils.Message

Things for formatting things

Documentation

codeblock

Arguments

:: Text

language

-> Text

content

-> Text

Formats a lang and content into a codeblock

>>> codeblock "hs" "x = y"
"```hs\nx = y\n```"

Any codeblocks in the content are escaped

codeblock'

Arguments

:: Maybe Text

language

-> Text

content

-> Text

Formats an optional lang and content into a codeblock

Any codeblocks in the content are escaped

codeline :: Text -> Text

Formats some content into a code line

This always uses `` code lines as they can be escaped

Any code lines in the content are escaped

escapeCodeblocks :: Text -> Text

Replaces all occurences of ``` with `<zws>`<zws>`

escapeCodelines :: Text -> Text

Replaces all occurences of `` with `<zws>`

escapeBold :: Text -> Text

Replaces all occurences of ** with *<zws>*

escapeStrike :: Text -> Text

Replaces all occurences of ~~ with ~<zws>~

escapeUnderline :: Text -> Text

Replaces all occurences of __ with _<zws>_

escapeSpoilers :: Text -> Text

Replaces all occurences of || with |<zws>|

escapeFormatting :: Text -> Text

Escape all discord formatting

bold :: Text -> Text

Formats some text into it's bolded form

Any existing bolded text is escaped

strike :: Text -> Text

Formats some text into it's striked form

Any existing striked text is escaped

underline :: Text -> Text

Formats some text into it's underlined form

Any existing underlined text is escaped

quote :: Text -> Text

Quotes a section of text

quoteAll :: Text -> Text

Quotes all remaining text

spoiler :: Text -> Text

Formats some text into it's spoilered form

Any existing spoilers are escaped

zws :: IsString s => s

fmtEmoji :: Emoji -> Text

displayUser :: (HasField' "username" a Text, HasField' "discriminator" a Text) => a -> Text

Format a User or Member into the format of username#discriminator

class Mentionable a where

Things that can be mentioned

Methods

mention :: a -> Text

Instances

Mentionable Channel

Defined in Calamity.Utils.Message

Methods

mention :: Channel -> Text

Mentionable Category

Defined in Calamity.Utils.Message

Methods

mention :: Category -> Text

Mentionable Member

Defined in Calamity.Utils.Message

Methods

mention :: Member -> Text

Mentionable User

Defined in Calamity.Utils.Message

Methods

mention :: User -> Text

Mentionable Role

Defined in Calamity.Utils.Message

Methods

mention :: Role -> Text

Mentionable DMChannel

Defined in Calamity.Utils.Message

Methods

mention :: DMChannel -> Text

Mentionable VoiceChannel

Defined in Calamity.Utils.Message

Methods

mention :: VoiceChannel -> Text

Mentionable TextChannel

Defined in Calamity.Utils.Message

Methods

mention :: TextChannel -> Text

Mentionable GuildChannel

Defined in Calamity.Utils.Message

Methods

mention :: GuildChannel -> Text

Mentionable (Snowflake Channel)

Defined in Calamity.Utils.Message

Methods

mention :: Snowflake Channel -> Text

Mentionable (Snowflake Category)

Defined in Calamity.Utils.Message

Methods

mention :: Snowflake Category -> Text

Mentionable (Snowflake Member)

Defined in Calamity.Utils.Message

Methods

mention :: Snowflake Member -> Text

Mentionable (Snowflake User)

Defined in Calamity.Utils.Message

Methods

mention :: Snowflake User -> Text

Mentionable (Snowflake Role)

Defined in Calamity.Utils.Message

Methods

mention :: Snowflake Role -> Text

Mentionable (Snowflake DMChannel)

Defined in Calamity.Utils.Message

Methods

mention :: Snowflake DMChannel -> Text

Mentionable (Snowflake VoiceChannel)

Defined in Calamity.Utils.Message

Methods

mention :: Snowflake VoiceChannel -> Text

Mentionable (Snowflake TextChannel)

Defined in Calamity.Utils.Message

Methods

mention :: Snowflake TextChannel -> Text

Mentionable (Snowflake GuildChannel)

Defined in Calamity.Utils.Message

Methods

mention :: Snowflake GuildChannel -> Text