cmdbatch

package

v1.20.1 Latest Latest Go to latest Published: Feb 1, 2026 License: Apache-2.0 Imports: 1 Imported by: 0

Details

Package cmdbatch provides a fluent builder for batching tea.Cmd values.

This reduces boilerplate when building command slices in Update functions, following the Elm Architecture pattern of accumulating commands.

Usage:

return m, cmdbatch.New().
    Add(p.sidebar.Update(msg)).
    AddIf(p.working, p.spinner.Init()).
    Add(p.messages.Update(msg)).
    Batch()

This section is empty.

This section is empty.

This section is empty.

type Builder struct {
	// contains filtered or unexported fields
}

Builder accumulates commands for batching.

func New() *Builder

New creates a new command builder.

func (b *Builder) Add(cmd tea.Cmd) *Builder

Add appends a command to the batch (nil commands are ignored).

func (b *Builder) AddAll(cmds ...tea.Cmd) *Builder

AddAll appends multiple commands to the batch.

func (b *Builder) AddIf(condition bool, cmd tea.Cmd) *Builder

AddIf conditionally appends a command to the batch.

func (b *Builder) Batch() tea.Cmd

Batch returns a batched command, or nil if no commands were added.

func (b *Builder) Len() int

Len returns the number of commands in the batch.