observey

2.0.0 • Public • Published

Observey

A file/folder system observer/watcher

Overview

Watches and observes files and folders.

Example

const Observey = require('observey');
 
const observer = new Observey({
    path: '/path/to/file/or/folder'
});
 
observer.on('change', function (path) {
    console.log(`change: ${path}`);
});
 
await observer.open();

API

Observey

Creates and returns a Observey class.

  • options: Object

    • path: String Path to file or folder
  • on: Function Emitter

    • error: String Event emitted on error
    • add: String Event emitted on file/folder addtion
    • change: String Event emitted on file/folder change
    • remove: String Event emitted on file/folder removal
    • modify: String Event emitted on file/folder modification (add, change, remove)

Authors

AlexanderElias

License

Why You Should Choose MPL-2.0 This project is licensed under the MPL-2.0 License

Dependencies (0)

    Dev Dependencies (0)

      Package Sidebar

      Install

      npm i observey

      Weekly Downloads

      7

      Version

      2.0.0

      License

      MPL-2.0

      Unpacked Size

      23.4 kB

      Total Files

      8

      Last publish

      Collaborators

      • xeaone