A smart wrapper for chokidar to facilitate file watching with enhanced features.
Go to file
2016-11-19 00:41:08 +01:00
dist add README 2016-11-19 00:36:48 +01:00
test add README 2016-11-19 00:36:48 +01:00
ts add README 2016-11-19 00:36:48 +01:00
.gitignore initial 2016-09-22 16:33:44 +02:00
.gitlab-ci.yml Update .gitlab-ci.yml 2016-09-28 18:21:45 +00:00
npmextra.json initial 2016-09-22 16:33:44 +02:00
package.json 1.0.4 2016-11-19 00:41:08 +01:00
README.md improve README 2016-11-19 00:41:05 +01:00
tslint.json initial 2016-09-22 16:33:44 +02:00

smartchok

smart wrapper for chokidar

Availabililty

npm git git docs

Status for master

build status coverage report Dependency Status bitHound Dependencies bitHound Code TypeScript node JavaScript Style Guide

Usage

We recommend the use of TypeScript for best in class Intellisense

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()

npm