46 lines
2.2 KiB
Markdown
46 lines
2.2 KiB
Markdown
|
# smartchok
|
||
|
|
smart wrapper for chokidar
|
||
|
|
|
||
|
|
## Availabililty
|
||
|
|
[](https://www.npmjs.com/package/npmts)
|
||
|
|
[](https://gitlab.com/pushrocks/npmts)
|
||
|
|
[](https://github.com/pushrocks/npmts)
|
||
|
|
[](https://pushrocks.gitlab.io/npmts/)
|
||
|
|
|
||
|
|
## Status for master
|
||
|
|
[](https://gitlab.com/pushrocks/npmts/commits/master)
|
||
|
|
[](https://gitlab.com/pushrocks/npmts/commits/master)
|
||
|
|
[](https://david-dm.org/pushrocks/npmts)
|
||
|
|
[](https://www.bithound.io/github/pushrocks/npmts/master/dependencies/npm)
|
||
|
|
[](https://www.bithound.io/github/pushrocks/npmts)
|
||
|
|
[](https://nodejs.org/dist/latest-v6.x/docs/api/)
|
||
|
|
[](https://nodejs.org/dist/latest-v6.x/docs/api/)
|
||
|
|
[](http://standardjs.com/)
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
We recommend the use of TypeScript for best in class Intellisense
|
||
|
|
|
||
|
|
```javascript
|
||
|
|
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 detected
|
||
|
|
// note that the observable is only created once you call .start() on the Smartchok instance
|
||
|
|
// hence the promise construction
|
||
|
|
})
|
||
|
|
})
|
||
|
|
|
||
|
|
mySmartChok.stop()
|
||
|
|
```
|
||
|
|
|
||
|
|
[](https://push.rocks)
|