watcher

package

v0.0.0-...-47ed896 Latest Latest Go to latest Published: Feb 25, 2024 License: MIT Imports: 6 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/swdunlop/rig-go

Links

Open Source Insights

Documentation ¶

Index ¶

type Interface
- func Start(options ...Option) (Interface, error)
type Option

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Interface ¶

type Interface interface {
	Alert() <-chan struct{}
	Shutdown()
}

Interface describes the watcher interface

func Start ¶

func Start(options ...Option) (Interface, error)

Start a watcher with the provided options.

type Option ¶

type Option func(*watcher) error

An Option is a function that can manipulate a watcher during construction

func Directory ¶

func Directory(paths ...string) Option

Directory specifies one or more directories to watch recursively. If no directories are specified, the current working directory is watched.

func Exclude ¶

func Exclude(patterns ...string) Option

Exclude specifies one or more file patterns to exclude from the watch. If no patterns are specified, only files starting with a dot are excluded. If a file matches both an include and an exclude pattern, it is excluded.

func Include ¶

func Include(patterns ...string) Option

Include specifies one or more file patterns to include in the watch. If no patterns are specified, all files not starting with a dot are included.

Source Files ¶

View all Source files

watcher.go

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