summaryrefslogtreecommitdiffstats
path: root/watcher/batcher.go
diff options
context:
space:
mode:
Diffstat (limited to 'watcher/batcher.go')
-rw-r--r--watcher/batcher.go3
1 files changed, 3 insertions, 0 deletions
diff --git a/watcher/batcher.go b/watcher/batcher.go
index 0b4083e81..6f4b276cf 100644
--- a/watcher/batcher.go
+++ b/watcher/batcher.go
@@ -19,6 +19,7 @@ import (
"github.com/fsnotify/fsnotify"
)
+// Batcher batches file watch events in a given interval.
type Batcher struct {
*fsnotify.Watcher
interval time.Duration
@@ -27,6 +28,7 @@ type Batcher struct {
Events chan []fsnotify.Event // Events are returned on this channel
}
+// New creates and starts a Batcher with the given time interval.
func New(interval time.Duration) (*Batcher, error) {
watcher, err := fsnotify.NewWatcher()
@@ -64,6 +66,7 @@ OuterLoop:
close(b.done)
}
+// Close stops the watching of the files.
func (b *Batcher) Close() {
b.done <- struct{}{}
b.Watcher.Close()