task

Oct 19, 2024

Changes in this version

type Result

+ Run string

+ func (r *Result) DataMap() util.ValueMap

type Results

+ func (r Results) ForRun(run string) Results

+ func (r Results) ForRunFirst(run string) *Result

+ func (r Results) ForTask(act string) Results

+ func (r Results) ForTaskFirst(act string) *Result

type Task

+ func (t *Task) ResultLogFn(logger util.Logger, fns ...exec.OutFn) ResultLogFn

+ func (t *Task) WithFunction(fn TaskFn) *Task

+ func (t *Task) WithoutFunctions() *Task

Oct 12, 2024

Changes in this version

+ type Result struct

+ Args util.ValueMap

+ Data any

+ Elapsed int

+ Error string

+ ID uuid.UUID

+ Logs []string

+ Metadata util.ValueMap

+ Started time.Time

+ Status string

+ Success bool

+ Summary string

+ Task *Task

+ func CompletedResult(key string, task *Task, args util.ValueMap, data any, err error, ...) *Result

+ func NewResult(task *Task, args util.ValueMap, fns ...ResultLogFn) *Result

+ func (r *Result) AddLogs(msgs ...string)

+ func (r *Result) Complete(data any, errs ...error) *Result

+ func (r *Result) CompleteError(err error) *Result

+ func (r *Result) CompleteSimple(data any) *Result

+ func (r *Result) EndTime() time.Time

+ func (r *Result) IsOK() bool

+ func (r *Result) Log(msg string, args ...any)

+ func (r *Result) String() string

+ func (r *Result) Summarize() string

+ type ResultLogFn func(key string, data any)

+ type Results []*Result

+ func (r Results) ForAct(act string) *Result

+ func (r Results) Get(id uuid.UUID) *Result

+ func (r Results) Keys() []string

+ func (r Results) Statuses() ([]string, map[string]Results)

+ func (r Results) String() string

+ type Service struct

+ RegisteredTasks Tasks

+ func NewService(fs filesystem.FileLoader, path string, initialTasks ...*Task) *Service

+ func (s *Service) RegisterTask(t *Task) error

+ func (s *Service) RemoveTask(key string) bool

+ func (s *Service) Run(ctx context.Context, task *Task, args util.ValueMap, logger util.Logger, ...) *Result

+ func (s *Service) RunAll(ctx context.Context, task *Task, argsSet []util.ValueMap, logger util.Logger, ...) (Results, error)

+ type Task struct

+ Category string

+ Dangerous string

+ Description string

+ Fields func() util.FieldDescs

+ Icon string

+ Key string

+ MaxConcurrent int

+ Tags []string

+ Title string

+ WebURL string

+ func NewTask(key string, title string, cat string, icon string, desc string, fns ...TaskFn) *Task

+ func (t *Task) Clone() *Task

+ func (t *Task) IconSafe() string

+ func (t *Task) Run(ctx context.Context, args util.ValueMap, logger util.Logger, fns ...exec.OutFn) *Result

+ func (t *Task) RunWithResult(ctx context.Context, res *Result, logger util.Logger) *Result

+ func (t *Task) TitleSafe() string

+ func (t *Task) WebPath() string

+ func (t *Task) WithTags(tags []string) *Task

+ type TaskFn func(ctx context.Context, res *Result, logger util.Logger) error

+ type Tasks []*Task

+ func (a Tasks) ByCategory(key string) Tasks

+ func (a Tasks) Categories() []string

+ func (a Tasks) Clone() Tasks

+ func (a Tasks) Get(key string) *Task

+ func (a Tasks) Keys() []string

+ func (a Tasks) Sort()