Module: Listen

Defined in:
lib/listen.rb,
lib/listen/adapter.rb,
lib/listen/version.rb,
lib/listen/listener.rb,
lib/listen/turnstile.rb,
lib/listen/adapters/bsd.rb,
lib/listen/adapters/linux.rb,
lib/listen/multi_listener.rb,
lib/listen/adapters/darwin.rb,
lib/listen/adapters/polling.rb,
lib/listen/adapters/windows.rb,
lib/listen/directory_record.rb

Defined Under Namespace

Modules: Adapters Classes: Adapter, DirectoryRecord, Listener, MultiListener, Turnstile

Constant Summary collapse

VERSION = 
'1.0.2'

Class Method Summary collapse

Class Method Details

._init_listener(*args, &block) ⇒ Object 



51
52
53
 
# File 'lib/listen.rb', line 51

def self._init_listener(*args, &block)
  Listener.new(*args, &block)
end

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

Listens to file system modifications on a either single directory or multiple directories. When calling this method, the current thread is not blocked.

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:



27
28
29
30
31
 
# File 'lib/listen.rb', line 27

def self.to(*args, &block)
  listener = _init_listener(*args, &block)

  block ? listener.start : listener
end

.to!(*args) {|modified, added, removed| ... } ⇒ Object

Listens to file system modifications on a either single directory or multiple directories. When calling this method, the current thread is blocked.

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

Since:

  • 1.0.0



45
46
47
 
# File 'lib/listen.rb', line 45

def self.to!(*args, &block)
  _init_listener(*args, &block).start!
end