command

Documentation

Overview

Package command is an interface for defining bot commands

Index

• Variables
• type Command
  • func NewCommand(name, usage, description string, exec func(args ...string) ([]byte, error)) Command

Variables

var (
	// Commmands keyed by golang/regexp patterns
	// regexp.Match(key, input) is used to match
	Commands = map[string]Command{}
)

Types

type Command

type Command interface {
	// Executes the command with args passed in
	Exec(args ...string) ([]byte, error)
	// Usage of the command
	Usage() string
	// Description of the command
	Description() string
	// Name of the command
	String() string
}

Command is the interface for specific named commands executed via plugins or the bot.

func NewCommand

func NewCommand(name, usage, description string, exec func(args ...string) ([]byte, error)) Command

NewCommand helps quickly create a new command