root

Documentation

Overview

Package root contains root application functions

Index

• func Authenticate(authFn func(string) error) error
• func MainLoop[A any](app *A, cmdMap map[string]*CmdConfig[A], onExit func())
• func NewCommandMap[A any](cfgs ...*CmdConfig[A]) map[string]*CmdConfig[A]
• func ParamsMap(params []string, required []string, optional []string) (dict.Strings, error)
• type CmdConfig
  • func NewCommand[A any](command string, minParams int, docs string, handler CmdHandler[A]) *CmdConfig[A]
• type CmdHandler

Functions

func Authenticate

func Authenticate(authFn func(string) error) error

Authenticate performs authentication for the Root account in the command-line app

func MainLoop

func MainLoop[A any](app *A, cmdMap map[string]*CmdConfig[A], onExit func())

MainLoop is the main REPL of the root application

func NewCommandMap

func NewCommandMap[A any](cfgs ...*CmdConfig[A]) map[string]*CmdConfig[A]

NewCommandMap creates a new map of command to CmdConfigs

func ParamsMap

func ParamsMap(params []string, required []string, optional []string) (dict.Strings, error)

ParamsMap gets the key=value map from the parameters list

Types

type CmdConfig

type CmdConfig[A any] struct {
	Command   string
	MinParams int
	Docs      string
	Handler   CmdHandler[A]
}

func NewCommand

func NewCommand[A any](command string, minParams int, docs string, handler CmdHandler[A]) *CmdConfig[A]

NewCommand creates a new CmdConfig

type CmdHandler

type CmdHandler[A any] = func(*A, []string)

CmdHandler takes in a list of string parameters