A smart wrapper for chokidar to facilitate file watching with enhanced features.
Go to file
2024-01-28 01:18:39 +01:00
.gitea/workflows fix(core): update 2024-01-28 01:18:39 +01:00
.vscode fix(core): update 2021-11-29 20:26:59 +01:00
test fix(core): update 2024-01-28 01:18:39 +01:00
ts fix(core): update 2024-01-28 01:18:39 +01:00
.gitignore fix(core): update 2021-11-29 20:26:59 +01:00
npmextra.json fix(core): update 2024-01-28 01:18:39 +01:00
package.json 1.0.28 2024-01-28 01:18:39 +01:00
pnpm-lock.yaml fix(core): update 2024-01-28 01:18:39 +01:00
readme.md fix(core): update 2024-01-28 01:18:39 +01:00
tsconfig.json fix(core): update 2024-01-28 01:18:39 +01:00

@push.rocks/smartchok

smart wrapper for chokidar

Status for master

Status Category Status Badge
GitLab Pipelines pipeline status
GitLab Pipline Test Coverage coverage report
npm npm downloads per month
Snyk Known Vulnerabilities
TypeScript Support TypeScript
node Support node
Code Style Code Style
PackagePhobia (total standalone install weight) PackagePhobia
PackagePhobia (package size on registry) PackagePhobia
BundlePhobia (total size when bundled) BundlePhobia
Platform support Supports Windows 10 Supports Mac OS X

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

Contribution

We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can contribute one time or contribute monthly. :)

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