This package has been deprecated

Author message:

This package has been deprecated in favour of the new package at @push.rocks/smartchok

@pushrocks/smartchok
TypeScript icon, indicating that this package has built-in type declarations

1.0.23 • Public • Published

@pushrocks/smartchok

smart wrapper for chokidar

Availabililty and Links

Status for master

build status coverage report npm downloads per month Known Vulnerabilities TypeScript node JavaScript Style Guide

Usage

Use TypeScript for best in class instellisense.

import { Smartchok } from 'smartchok';

const 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

repo-footer

Readme

Keywords

none

Package Sidebar

Install

npm i @pushrocks/smartchok

Weekly Downloads

13

Version

1.0.23

License

MIT

Unpacked Size

14.9 kB

Total Files

12

Last publish

Collaborators

  • lossless