waiter

Documentation

Index

• func Wait(check Check, opts ...Option) error
• func WaitWithContext(ctx context.Context, check Check, opts ...Option) error
• type Check
• type Option
  • func WithInterval(interval time.Duration) Option
  • func WithInvertCheck(invertCheck bool) Option
  • func WithTimeout(timeout time.Duration) Option

Functions

func Wait

func Wait(check Check, opts ...Option) error

Wait waits for end up of check execution.

func WaitWithContext

func WaitWithContext(ctx context.Context, check Check, opts ...Option) error

WaitWithContext waits for end up of check execution.

Types

type Check

type Check func(ctx context.Context) bool

Check represents the checker's check method.

type Option

type Option func(s *options)

Option configures an options

func WithInterval

func WithInterval(interval time.Duration) Option

WithInterval configures time duration for each of checking interval

func WithInvertCheck

func WithInvertCheck(invertCheck bool) Option

WithInvertCheck configures invert checking

func WithTimeout

func WithTimeout(timeout time.Duration) Option

WithTimeout configures a time limit for whole of checking