A smart wrapper for chokidar to facilitate file watching with enhanced features.
Go to file
2017-06-30 18:05:57 +02:00
dist update to wirj like expected 2017-06-30 18:05:55 +02:00
test update to wirj like expected 2017-06-30 18:05:55 +02:00
ts update to wirj like expected 2017-06-30 18:05:55 +02:00
.gitignore initial 2016-09-22 16:33:44 +02:00
.gitlab-ci.yml update ci 2017-04-09 16:59:10 +02:00
npmextra.json update npmextra.json 2017-04-09 16:57:49 +02:00
package.json 1.0.9 2017-06-30 18:05:57 +02:00
README.md update to new gitzone standard 2017-04-09 16:51:33 +02:00
tslint.json initial 2016-09-22 16:33:44 +02:00
yarn.lock update to wirj like expected 2017-06-30 18:05:55 +02:00

smartchok

smart wrapper for chokidar

Availabililty

npm git git docs

Status for master

build status coverage report npm downloads per month Dependency Status bitHound Dependencies bitHound Code TypeScript node JavaScript Style Guide

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

repo-footer