Module: Listen

Defined in:
lib/listen.rb,
lib/listen/file.rb,
lib/listen/change.rb,
lib/listen/record.rb,
lib/listen/adapter.rb,
lib/listen/version.rb,
lib/listen/listener.rb,
lib/listen/silencer.rb,
lib/listen/directory.rb,
lib/listen/adapter/bsd.rb,
lib/listen/adapter/base.rb,
lib/listen/adapter/linux.rb,
lib/listen/adapter/darwin.rb,
lib/listen/adapter/polling.rb,
lib/listen/adapter/windows.rb

Defined Under Namespace

Modules: Adapter Classes: Change, Directory, File, Listener, Record, Silencer

Constant Summary collapse

VERSION = 
'2.4.1'

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.stopping ⇒ Object

Returns the value of attribute stopping.



6
7
8
 
# File 'lib/listen.rb', line 6

def stopping
  @stopping
end

Class Method Details

.stop ⇒ Object

Stop all listeners



26
27
28
 
# File 'lib/listen.rb', line 26

def stop
  @stopping = true
end

.to(*args) {|modified, added, removed| ... } ⇒ Listen::Listener

Listens to file system modifications on a either single directory or multiple directories.

Yields:

  • (modified, added, removed) —

    the changed files

Yield Parameters:

  • modified (Array<String>) —

    the list of modified files

  • added (Array<String>) —

    the list of added files

  • removed (Array<String>) —

    the list of removed files

Returns:



19
20
21
22
 
# File 'lib/listen.rb', line 19

def to(*args, &block)
  @stopping = false
  Listener.new(*args, &block)
end