@futoin/msgbot-discord

Discord support for FutoIn Message Bot

Usage no npm install needed!

<script type="module">
  import futoinMsgbotDiscord from 'https://cdn.skypack.dev/@futoin/msgbot-discord';
</script>

README

About

WORK IN PROGRESS

This is Discord message system support for reference implementation of FTN22.

Author: Andrey Galkin

Installation for Node.js

Command line:

$ npm install @futoin/msgbot-discord --save

API documentation

Modules

@futoin/ext-js-msgbot-discord

Classes

DiscordFace

Discord FTN22 Server Face implementation

DiscordHelpers

Discord Server-specific helpers

DiscordService

Discord Server Service

@futoin/ext-js-msgbot-discord

exports ⏏

Add Discord system to FutoIn Message Bot

Kind: Exported member

Param Type Description
asi AsyncSteps async steps interface
app ServiceApp message bot
options object additional parameters
options.discord object parameters to be passed to Discord.js
options.discordToken string bot token

DiscordFace

Discord FTN22 Server Face implementation

Kind: global class

new DiscordFace(options)

C-tor

Param Type Description
options object common options
options.discordClient object Discord client instance

discordFace.systemIface() ⇒ object

Get native message system interface implementation

Kind: instance method of DiscordFace
Returns: object - native implementation

DiscordHelpers

Discord Server-specific helpers

Kind: global class

discordHelpers.bold(str) ⇒ string

Get bold text

Kind: instance method of DiscordHelpers
Returns: string - bold output

Param Type Description
str string input

discordHelpers.italic(str) ⇒ string

Get italic text

Kind: instance method of DiscordHelpers
Returns: string - italic output

Param Type Description
str string input

discordHelpers.color(str, hexcolor) ⇒ string

Get colored text

Kind: instance method of DiscordHelpers
Returns: string - colored output

Param Type Description
str string input
hexcolor string color code

discordHelpers.imgUrl(url) ⇒ string

Get image URL embedded into text

Kind: instance method of DiscordHelpers
Returns: string - URL output

Param Type Description
url string input

discordHelpers.emoji(name) ⇒ string

Get emoji embedded into text

Kind: instance method of DiscordHelpers
Returns: string - emoji output

Param Type Description
name string input

discordHelpers.line() ⇒ string

Get new line

Kind: instance method of DiscordHelpers
Returns: string - new line

discordHelpers.menion(ext_id) ⇒ string

Get actor mention into text

Kind: instance method of DiscordHelpers
Returns: string - mention output

Param Type Description
ext_id string input actor ID

DiscordService

Discord Server Service

Kind: global class

new DiscordService(options)

C-tor

Param Type Description
options object common options
options.discordClient object Discord client instance
options.asModel AsyncSteps AsyncSteps model to create threads
options.ccm AdvancedCCM CCM

documented by jsdoc-to-markdown.