watcher

Documentation

Overview

Package watcher provides functionality for the Tako framework.

Index

• type Config
• type Watcher
  • func New(rootDir string, cfg Config) (*Watcher, error)
  • func (w *Watcher) ChangeChan() <-chan struct{}
  • func (w *Watcher) Start()
  • func (w *Watcher) Stop()

Types

type Config

type Config struct {
	IncludeExts []string
	ExcludeExts []string
}

Config holds configuration for the Watcher.

type Watcher

type Watcher struct {
	// contains filtered or unexported fields
}

Watcher implements an OS-level file watcher using fsnotify.

func New

func New(rootDir string, cfg Config) (*Watcher, error)

New creates a new Fsnotify Watcher.

func (*Watcher) ChangeChan

func (w *Watcher) ChangeChan() <-chan struct{}

ChangeChan returns a channel that emits when a relevant file changes.

func (*Watcher) Start

func (w *Watcher) Start()

Start begins listening to OS file events.

func (*Watcher) Stop

func (w *Watcher) Stop()

Stop halts the watcher and closes OS resources.