Skip to content

Commit

Permalink
Define initial Listener API.
Browse files Browse the repository at this point in the history
  • Loading branch information
netzpirat committed Jan 11, 2012
1 parent cd145cf commit 191bc74
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions lib/listener.rb
Original file line number Diff line number Diff line change
@@ -1,2 +1,17 @@
module Listener

# Listen to file system modifications.
#
# @param [String, Pathname] dir the directory to watch
# @param [Hash] options the listen options
# @option options [String] glob the file filter pattern
# @yield [modified, added, removed] the changed files
# @yieldparam [Array<String>] modified the list of modified files
# @yieldparam [Array<String>] added the list of added files
# @yieldparam [Array<String>] removed the list of removed files
# @return [Watcher] the file watcher
#
def self.listen(dir, options, &block)
end

end

0 comments on commit 191bc74

Please sign in to comment.