1.0.27

package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "@pushrocks/smartchok",
-  "version": "1.0.24",
+  "version": "1.0.27",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "@pushrocks/smartchok",
-      "version": "1.0.24",
+      "version": "1.0.27",
       "license": "MIT",
       "dependencies": {
         "@pushrocks/lik": "^5.0.0",

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pushrocks/smartchok",
-  "version": "1.0.24",
+  "version": "1.0.27",
   "private": false,
   "description": "smart wrapper for chokidar",
   "main": "dist_ts/index.js",
@@ -24,7 +24,6 @@
     "@pushrocks/lik": "^5.0.0",
     "@pushrocks/smartpromise": "^3.1.6",
     "@pushrocks/smartrx": "^2.0.19",
-    "@types/chokidar": "^2.1.3",
     "chokidar": "^3.5.2"
   },
   "devDependencies": {

readme.md

@@ -0,0 +1,63 @@
+# @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
+
+Status Category | Status Badge
+-- | --
+GitLab Pipelines | [![pipeline status](https://gitlab.com/pushrocks/smartchok/badges/master/pipeline.svg)](https://lossless.cloud)
+GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/pushrocks/smartchok/badges/master/coverage.svg)](https://lossless.cloud)
+npm | [![npm downloads per month](https://badgen.net/npm/dy/@pushrocks/smartchokidar)](https://lossless.cloud)
+Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/pushrocks/smartchok)](https://lossless.cloud)
+TypeScript Support | [![TypeScript](https://badgen.net/badge/TypeScript/>=%203.x/blue?icon=typescript)](https://lossless.cloud)
+node Support | [![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
+Code Style | [![Code Style](https://badgen.net/badge/style/prettier/purple)](https://lossless.cloud)
+PackagePhobia (total standalone install weight) | [![PackagePhobia](https://badgen.net/packagephobia/install/@pushrocks/smartchokidar)](https://lossless.cloud)
+PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@pushrocks/smartchokidar)](https://lossless.cloud)
+BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@pushrocks/smartchokidar)](https://lossless.cloud)
+Platform support | [![Supports Windows 10](https://badgen.net/badge/supports%20Windows%2010/yes/green?icon=windows)](https://lossless.cloud) [![Supports Mac OS X](https://badgen.net/badge/supports%20Mac%20OS%20X/yes/green?icon=apple)](https://lossless.cloud)
+
+## Usage
+
+Use TypeScript for best in class instellisense.
+
+```javascript
+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](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)
+
+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)
+
+[![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com)

test/test.ts

@@ -4,13 +4,15 @@ import * as smartfile from '@pushrocks/smartfile';
 import * as smartpromise from '@pushrocks/smartpromise';
 import * as smartrx from '@pushrocks/smartrx';
 
+import * as fs from 'fs';
+
 // the module to test
 if (process.env.CI) {
   process.exit(0);
 }
 
 let testSmartchok: smartchok.Smartchok;
-let testAddObservable: smartrx.rxjs.Observable<any>;
+let testAddObservable: smartrx.rxjs.Observable<[string, fs.Stats]>;
 let testSubscription: smartrx.rxjs.Subscription;
 tap.test('should create a new instance', async () => {
   testSmartchok = new smartchok.Smartchok([]);
@@ -31,7 +33,9 @@ tap.test('should get an observable for a certain event', async () => {
 
 tap.test('should register an add operation', async () => {
   let testDeferred = smartpromise.defer();
-  testSubscription = testAddObservable.subscribe((x) => {
+  testSubscription = testAddObservable.subscribe(pathArg => {
+    const pathResult = pathArg[0];
+    console.log(pathResult);
     testDeferred.resolve();
   });
   smartfile.memory.toFs('HI', './test/assets/hi.txt');

ts/smartchok.classes.smartchok.ts

@@ -49,7 +49,7 @@ export class Smartchok {
   /**
    * gets an observable for a certain event
    */
-  public getObservableFor(fsEvent: TFsEvent): Promise<plugins.smartrx.rxjs.Observable<any>> {
+  public getObservableFor(fsEvent: TFsEvent): Promise<plugins.smartrx.rxjs.Observable<[string, plugins.fs.Stats]>> {
     const done = plugins.smartpromise.defer<plugins.smartrx.rxjs.Observable<any>>();
     this.watchingDeferred.promise.then(() => {
       const eventObservable = this.eventObservablemap.getObservableForEmitterEvent(

ts/smartchok.plugins.ts

@@ -1,7 +1,9 @@
 // node native
+import * as fs from 'fs';
 import * as path from 'path';
 
 export {
+  fs,
   path
 }