Git Product home page Git Product logo

nukor's Introduction

Nukor

Creates and focuses a high-frequency field of microwaves, literally cooking the target from within.

Nukor is a simple file watcher built on the top of @atom/watcher with a filtering module which removes duplicated events.

Table of Contents

Installation

npm install nukor --save

Usage

Create a watcher, start and listen changes by calling watchPath()

const { watchPath } = require('nukor');

// Create a new watcher, start and listen changes
const watcher = await watchPath('/path/to/watch', {}, events => {
  // ...
});

// Stop the watcher
watcher.stop();

Create a watcher by calling createWatcher()

const { Watcher } = require('nukor');

// Create a new watcher
const watcher = createWatcher('/path/to/watch');

// Listen to change events
watcher.on('change', events => {
  // ...
});

// Start the watcher
await watcher.start();

// Stop the watcher
watcher.stop();

Create a watcher by instantiating a Watcher class

const { Watcher } = require('nukor');

// Create a new watcher
const watcher = new Watcher('/path/to/watch');

// Listen to change events
watcher.on('change', events => {
  // ...
});

// Start the watcher
await watcher.start();

// Stop the watcher
watcher.stop();

Author

Alexandre Breteau - @0xSeldszar

License

MIT © Alexandre Breteau

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.