52 lines
2.3 KiB
Markdown
52 lines
2.3 KiB
Markdown
# @pushrocks/smartchok
|
|
smart wrapper for chokidar
|
|
|
|
## Availabililty and Links
|
|
* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartchokidar)
|
|
* [gitlab.com (source)](https://gitlab.com/pushrocks/smartchok)
|
|
* [github.com (source mirror)](https://github.com/pushrocks/smartchok)
|
|
* [docs (typedoc)](https://pushrocks.gitlab.io/smartchok/)
|
|
|
|
## Status for master
|
|
[](https://gitlab.com/pushrocks/smartchok/commits/master)
|
|
[](https://gitlab.com/pushrocks/smartchok/commits/master)
|
|
[](https://www.npmjs.com/package/@pushrocks/smartchokidar)
|
|
[](https://snyk.io/test/npm/@pushrocks/smartchokidar)
|
|
[](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
|
[](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
|
[](https://prettier.io/)
|
|
|
|
## Usage
|
|
|
|
Use TypeScript for best in class instellisense.
|
|
|
|
```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 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](https://lossless.gmbh)
|
|
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
|
|
|
|
[](https://maintainedby.lossless.com)
|