Skip to content

Commit 191bc74

Browse files
author
Michael Kessler
committed
Define initial Listener API.
1 parent cd145cf commit 191bc74

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

lib/listener.rb

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,17 @@
11
module Listener
2+
3+
# Listen to file system modifications.
4+
#
5+
# @param [String, Pathname] dir the directory to watch
6+
# @param [Hash] options the listen options
7+
# @option options [String] glob the file filter pattern
8+
# @yield [modified, added, removed] the changed files
9+
# @yieldparam [Array<String>] modified the list of modified files
10+
# @yieldparam [Array<String>] added the list of added files
11+
# @yieldparam [Array<String>] removed the list of removed files
12+
# @return [Watcher] the file watcher
13+
#
14+
def self.listen(dir, options, &block)
15+
end
16+
217
end

0 commit comments

Comments
 (0)