io.scalajs.nodejs.fs.FSWatcher.scala Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of nodejs_sjs0.6_2.11 Show documentation

NodeJS bindings for Scala.js

There is a newer version: 0.4.2

package io.scalajs.nodejs.fs

import io.scalajs.nodejs.events.IEventEmitter

import scala.scalajs.js

/**
  * fs.FSWatcher - Objects returned from fs.watch() are of this type.
  * @author [email protected]
  */
@js.native
trait FSWatcher extends IEventEmitter {

  /**
    * Stop watching for changes on the given fs.FSWatcher.
    * @example watcher.close()
    * @since 0.5.8
    */
  def close(): Unit = js.native

}

/**
  * File System Watcher Companion
  * @author [email protected]
  */
object FSWatcher {

  /**
    * File System Watcher Extensions
    * @author [email protected]
    */
  implicit class FSWatcherExtensions(val watcher: FSWatcher) extends AnyVal {

    /**
      * Emitted when something changes in a watched directory or file. See more details in fs.watch().
      *
      * The filename argument may not be provided depending on operating system support. If filename is provided,
      * it will be provided as a Buffer if fs.watch() is called with it's encoding option set to 'buffer', otherwise
      * filename will be a string.
      * @param listener the event handler
      *                 
      *                 event: String - The type of fs change
      *                 filename: String> | Buffer - The filename that changed (if relevant/available)
      *                 
      * @since 0.5.8
      */
    @inline def onChange(listener: (String, js.Any) => Any) = watcher.on("change", listener)

    /**
      * Emitted when an error occurs.
      * @param listener the event handler
      * @since 0.5.8
      */
    @inline def onError(listener: js.Error => Any) = watcher.on("error", listener)

  }

}