Help us shape the future of Go! Take the 2026 Go Developer Survey

command

package
v0.5.3 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 3, 2026 License: MIT Imports: 14 Imported by: 0

Documentation

Overview

Package command supplies application-owned outbox operations. Parse before boot; Run borrows the application's configured publisher and never starts it.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Declaration

func Declaration(construct func(foundation.Resolver) (*publisher.Publisher, error)) (cli.Declaration, error)

Declaration registers the outbox command in the ordinary CLI registry. The constructor resolves the configured publisher after boot; parsing does no I/O.

Types

type Command

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

Command is a validated immutable operation. Requeue and prune repeat bounded batches until nothing remains, so each transaction holds its locks briefly.

func Parse

func Parse(args []string, help io.Writer) (Command, error)

Parse parses outbox inspection and maintenance commands; help writes usage and returns flag.ErrHelp.

func (Command) Run

func (c Command) Run(ctx context.Context, p *publisher.Publisher, output io.Writer) error

Run emits only operational metadata: never payloads, origins or error text. A failed batch leaves earlier committed batches in place; the reported count covers only confirmed batches.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL