watcher

Documentation

Index

• func Module() fx.Option
• func NewWatcher(directory, fileExt string) (*watcher, error)
• type Constructor
  • func (constructor Constructor) Annotate() fx.Option

Functions

func Module

func Module() fx.Option

Module is a fx module that provides filesystem watcher.

func NewWatcher

func NewWatcher(directory, fileExt string) (*watcher, error)

NewWatcher creates a new watcher instance that starts watching a directory via fsnotify.

Types

type Constructor

type Constructor struct {
	// Name of watcher instance where "" means main watcher.
	Name string
	// Config key from which to read directory path from.
	// If the pathkey is empty or is not set then fallback to Path.
	ConfigKey string
	// Directory path to fall back to.
	Path string
	// File types to watch. The extension needs to include leading dot.
	FileExt string
}

Constructor holds fields to create an annotated instance of Watcher.

func (Constructor) Annotate

func (constructor Constructor) Annotate() fx.Option

Annotate creates an annotated instance of filesystem Watcher.