mdparser

Documentation

Index

• func AddSecret(value, name string)
• func GetSecretIndexByValue(value string) int
• func IsSpecial(r rune) bool
• func RemoveSecretByName(name string)
• func RemoveSecretByValue(value string)
• func SecretValueExists(value string) bool
• type WMarkDown
  • func GetBold(text string) WMarkDown
  • func GetEmpty() WMarkDown
  • func GetHyperLink(text string, url string) WMarkDown
  • func GetItalic(text string) WMarkDown
  • func GetMono(text string) WMarkDown
  • func GetNormal(text string) WMarkDown
  • func GetSpoiler(text string) WMarkDown
  • func GetStrike(text string) WMarkDown
  • func GetUnderline(text string) WMarkDown
  • func GetUserMention(text string, userID int64) WMarkDown

Functions

func AddSecret

func AddSecret(value, name string)

AddSecret adds a new secret variable to the mdparser *globally*. from now on, the library itself will automatically censor all of the "value"s with their name. an example of usage would be:

mdparser.AddSecret(bot.Token, "$TOKEN")

func GetSecretIndexByValue

func GetSecretIndexByValue(value string) int

func IsSpecial

func IsSpecial(r rune) bool

func RemoveSecretByName

func RemoveSecretByName(name string)

func RemoveSecretByValue

func RemoveSecretByValue(value string)

func SecretValueExists

func SecretValueExists(value string) bool

Types

type WMarkDown

type WMarkDown interface {
	// Append method appends the w-markdown value to a new copy of the current
	// w-markdown and returns the copy.
	Append(md WMarkDown) WMarkDown
	AppendThis(md WMarkDown) WMarkDown
	ReplaceMd(md1, md2 WMarkDown) WMarkDown
	ReplaceMdN(md1, md2 WMarkDown, n int) WMarkDown
	ReplaceMdThis(md1, md2 WMarkDown) WMarkDown
	ReplaceMdThisN(md1, md2 WMarkDown, n int) WMarkDown
	ToString() string

	AppendNormal(text string) WMarkDown
	AppendNormalThis(text string) WMarkDown
	AppendBold(text string) WMarkDown
	AppendBoldThis(text string) WMarkDown
	AppendItalic(text string) WMarkDown
	AppendItalicThis(text string) WMarkDown
	AppendStrike(text string) WMarkDown
	AppendStrikeThis(text string) WMarkDown
	AppendMono(text string) WMarkDown
	AppendMonoThis(text string) WMarkDown
	AppendUnderline(text string) WMarkDown
	AppendUnderlineThis(text string) WMarkDown
	AppendHyperLink(text, url string) WMarkDown
	AppendHyperLinkThis(text, url string) WMarkDown
	AppendMention(text string, id int64) WMarkDown
	AppendMentionThis(text string, id int64) WMarkDown
	ReplaceToNew(text1, text2 string) WMarkDown
	ReplaceToNewN(text1, text2 string, n int) WMarkDown

	Normal(text string) WMarkDown
	Bold(text string) WMarkDown
	Italic(text string) WMarkDown
	Mono(text string) WMarkDown
	HyperLink(text, url string) WMarkDown
	Link(text, url string) WMarkDown
	Mention(text string, id int64) WMarkDown
	UserMention(text string, id int64) WMarkDown
	Spoiler(text string) WMarkDown
	Strike(text string) WMarkDown
	Underline(text string) WMarkDown

	El() WMarkDown
	ElThis() WMarkDown
	Space() WMarkDown
	SpaceThis() WMarkDown
	Tab() WMarkDown
	TabThis() WMarkDown
	Replace(text1, text2 string) WMarkDown
}

func GetBold

func GetBold(text string) WMarkDown

func GetEmpty

func GetEmpty() WMarkDown

func GetHyperLink

func GetHyperLink(text string, url string) WMarkDown

func GetItalic

func GetItalic(text string) WMarkDown

func GetMono

func GetMono(text string) WMarkDown

func GetNormal

func GetNormal(text string) WMarkDown

func GetSpoiler

func GetSpoiler(text string) WMarkDown

func GetStrike

func GetStrike(text string) WMarkDown

func GetUnderline

func GetUnderline(text string) WMarkDown

func GetUserMention

func GetUserMention(text string, userID int64) WMarkDown

GetUserMention will give you a mentioning style username with the specified text. WARNING: you don't need to repair text before sending it as first arg, this function will check it itself.