wait

package

v0.6.0 Latest Latest Go to latest Published: Feb 3, 2026 License: MIT Imports: 8 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/grovetools/tend

Links

Open Source Insights

Documentation ¶

Index ¶

func For(condition Condition, opts Options) error
func ForCommand(name string, args []string, timeout time.Duration) error
func ForContainer(containerName string, timeout time.Duration) error
func ForContainerStatus(containerName string, expectedStatus string, timeout time.Duration) error
func ForContext(ctx context.Context, condition Condition, opts Options) error
func ForContextWithMessage(ctx context.Context, condition ConditionWithMessage, opts Options) error
func ForFile(path string, timeout time.Duration) error
func ForFileContent(path string, content string, timeout time.Duration) error
func ForHTTP(url string, expectedStatus int, timeout time.Duration) error
func ForOutput(name string, args []string, expected string, timeout time.Duration) error
func ForPort(host string, port int, timeout time.Duration) error
func ForWithMessage(condition ConditionWithMessage, opts Options) error
func Until(condition Condition, opts Options) error
type Condition
type ConditionWithMessage
type Options
- func DefaultOptions() Options

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func For ¶

func For(condition Condition, opts Options) error

For waits for a condition to become true

func ForCommand ¶

func ForCommand(name string, args []string, timeout time.Duration) error

ForCommand waits for a command to succeed

func ForContainer ¶

func ForContainer(containerName string, timeout time.Duration) error

ForContainer waits for a container to exist

func ForContainerStatus ¶

func ForContainerStatus(containerName string, expectedStatus string, timeout time.Duration) error

ForContainerStatus waits for a container to reach a specific status

func ForContext ¶

func ForContext(ctx context.Context, condition Condition, opts Options) error

ForContext waits for a condition with context

func ForContextWithMessage ¶

func ForContextWithMessage(ctx context.Context, condition ConditionWithMessage, opts Options) error

ForContextWithMessage waits with context and message updates

func ForFile ¶

func ForFile(path string, timeout time.Duration) error

ForFile waits for a file to exist

func ForFileContent ¶

func ForFileContent(path string, content string, timeout time.Duration) error

ForFileContent waits for a file to contain specific content

func ForHTTP ¶

func ForHTTP(url string, expectedStatus int, timeout time.Duration) error

ForHTTP waits for an HTTP endpoint to be available

func ForOutput ¶

func ForOutput(name string, args []string, expected string, timeout time.Duration) error

ForOutput waits for a command to produce specific output

func ForPort ¶

func ForPort(host string, port int, timeout time.Duration) error

ForPort waits for a port to be open

func ForWithMessage ¶

func ForWithMessage(condition ConditionWithMessage, opts Options) error

ForWithMessage waits for a condition and provides status messages

func Until ¶

func Until(condition Condition, opts Options) error

Until waits until a condition becomes false

Types ¶

type Condition ¶

type Condition func() (bool, error)

Condition represents a testable condition

type ConditionWithMessage ¶

type ConditionWithMessage func() (bool, string, error)

ConditionWithMessage represents a condition with descriptive message

type Options ¶

type Options struct {
	Timeout      time.Duration
	PollInterval time.Duration
	Immediate    bool // Check condition immediately before first sleep
}

Options configures wait behavior

func DefaultOptions ¶

func DefaultOptions() Options

DefaultOptions returns default wait options

Source Files ¶

View all Source files

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