internal

package
v1.10.5 Latest Latest
Warning

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

Go to latest
Published: May 19, 2026 License: MIT Imports: 5 Imported by: 0

Documentation

Index

Constants

View Source
const (
	// DefaultPollInterval is how often WaitForTask checks task status in production.
	DefaultPollInterval = 2 * time.Second
	// DefaultTimeout is the maximum time WaitForTask will wait before giving up.
	DefaultTimeout = 2 * time.Minute
)

Variables

View Source
var (
	PollInterval = DefaultPollInterval
	Timeout      = DefaultTimeout
)

PollInterval and Timeout are the active timing values used by WaitForTask. Override these in tests to avoid slow polling; restore via t.Cleanup.

Functions

func WaitForTask

func WaitForTask(
	io *iostreams.IOStreams,
	client *algoliaComposition.APIClient,
	compositionID string,
	taskID int64,
	pollInterval time.Duration,
	timeout time.Duration,
) error

WaitForTask polls the Compositions API until the given task reaches PUBLISHED status, then stops the progress indicator. pollInterval and timeout control timing; use DefaultPollInterval and DefaultTimeout in production callers and small values (e.g. 1ms / 50ms) in tests.

Types

This section is empty.

Jump to

Keyboard shortcuts

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