abort

Documentation

Overview

Package abort implements the stackit abort command for canceling in-progress operations.

Index

• func Action(ctx *app.Context, opts Options, handler Handler) error
• type Handler
• type NullHandler
  • func (h *NullHandler) PromptConfirmAbort() (bool, error)
• type Options

Functions

func Action

func Action(ctx *app.Context, opts Options, handler Handler) error

Action cancels an in-progress operation

Types

type Handler

type Handler interface {
	// PromptConfirmAbort prompts user to confirm aborting the current operation
	// Returns true to proceed with abort, false to cancel
	PromptConfirmAbort() (bool, error)

	// Cleanup restores terminal state (may be no-op)
	Cleanup()

	// IsInteractive returns true if the handler supports interactive prompts
	IsInteractive() bool
}

Handler receives events from abort action

type NullHandler

type NullHandler struct {
	handler.NullBase
}

NullHandler is a no-op handler for when nil is passed

func (*NullHandler) PromptConfirmAbort

func (h *NullHandler) PromptConfirmAbort() (bool, error)

PromptConfirmAbort implements Handler. Returns false (cancel) for null handler.

type Options

type Options struct {
	Force bool
}

Options contains options for the abort command