watch

Documentation

Index

• type Events
  • func (e Events) HasChanged() bool
  • func (e *Events) String() string
• type Factory
• type FileMap
  • func Stat(deps func() ([]string, error)) (FileMap, error)
• type Trigger
  • func NewTrigger(opts *config.SkaffoldOptions) (Trigger, error)
• type Watcher
  • func NewWatcher(trigger Trigger) Watcher

Types

type Events

type Events struct {
	Added    []string
	Modified []string
	Deleted  []string
}

func (Events) HasChanged

func (e Events) HasChanged() bool

func (*Events) String

func (e *Events) String() string

type Factory

type Factory func() Watcher

Factory creates Watcher instances.

type FileMap

type FileMap map[string]time.Time

FileMap is a map of filename to modification times.

func Stat

func Stat(deps func() ([]string, error)) (FileMap, error)

Stat returns the modification times for a list of files.

type Trigger

type Trigger interface {
	Start(context.Context) (<-chan bool, error)
	WatchForChanges(io.Writer)
	Debounce() bool
}

Trigger describes a mechanism that triggers the watch.

func NewTrigger

func NewTrigger(opts *config.SkaffoldOptions) (Trigger, error)

NewTrigger creates a new trigger.

type Watcher

type Watcher interface {
	Register(deps func() ([]string, error), onChange func(Events)) error
	Run(ctx context.Context, out io.Writer, onChange func() error) error
}

Watcher monitors files changes for multiples components.

func NewWatcher

func NewWatcher(trigger Trigger) Watcher

NewWatcher creates a new Watcher.