===========
Module file
===========

.. lua:module:: file

File events

This module allows you to create event sources for monitoring file changes.

See :lua:meth:`dbus <dbus>`, :lua:meth:`evdev <evdev>`, :lua:meth:`event <event>`, :lua:meth:`file <file>`, :lua:meth:`hwinfo <hwinfo>`, :lua:meth:`log <log>`, :lua:meth:`lua <lua>`, :lua:meth:`misc <misc>`, :lua:meth:`os <os>`, :lua:meth:`spawn <spawn>`, :lua:meth:`udev <udev>`, :lua:meth:`xorg <xorg>` for more information about this type

Methods
==========

.. list-table::
   :header-rows: 0

   * - :lua:meth:`watch(paths) <watch>`
     - Create a new file watch

.. lua:method:: watch(paths) -> Watch

   :rtype: :lua:mod:`Watch <deai.plugin.file.Watch>`
   :param paths: an array of paths to watch
   :type paths: [string]

   Create a new file watch 

   The returned watch is set to monitor a given set of file from the start. But this set
   can be changed later.