smartchok/README.md

@pushrocks/smartchok

smart wrapper for chokidar

Availabililty and Links

• npmjs.org (npm package)
• gitlab.com (source)
• github.com (source mirror)
• docs (typedoc)

Status for master

Usage

Use TypeScript for best in class instellisense.

import { Smartchok } from 'smartchok';

let mySmartChok = new Smartchok(['some/path/**/*.any', '/absolute/*.js'], chokidarOptions);

mySmartChok.add(['/some/**/*.any']); // add files

mySmartChok.remove('some/**/*.js');

mySmartChok.start(); // starts the watch process

mySmartChok.getObservableFor('change').then(observableArg => {
  observableArg.subscribe(x => {
    // do something here when a change is detected
    // possible events are 'add' | 'addDir' | 'change' | 'error' | 'unlink' | 'unlinkDir' | 'ready' | 'raw'
    // note that the observable is only created once you call .start() on the Smartchok instance
    // hence the promise construction
  });
});

mySmartChok.stop();

For further information read the linked docs at the top of this readme.

MIT licensed | © Lossless GmbH | By using this npm module you agree to our privacy policy