bot

Documentation

Index

• Constants
• func NewBot() error
• type Bot
  • func Get() Bot

Constants

const (
	// Command timeout - the amount of time bot will wait for before declaring
	// a command as failed.
	COMMAND_TIMEOUT = time.Second * 10

	// Emoji that signifies that a command is in progress.
	CMD_WIP_EMOJI = "🛠 "
	// Emoji that signifies that a command was successful.
	CMD_OK_EMOJI = "✅ "
	// Emoji that signifies that a command failed.
	CMD_ERR_EMOJI = "❌ "
)

Functions

func NewBot

func NewBot() error

NewBot creates a new bot instance.

This function must return an error if: * a steve instance has already been initialized * other errors are encountered when initializing steve

Types

type Bot

type Bot interface {
	// Start starts bot.
	//
	// This function must return an error if:
	// * the bot instance has not been initialized yet
	// * any other errors are encountered during the start process
	Start(context.Context, *sync.WaitGroup) error
	// contains filtered or unexported methods
}

Bot is a component that handles the interaction with stevebot via Discord.

func Get

func Get() Bot

Get returns a Bot instance.