index.d.ts: make Options#errorCallback optional

This commit adds a test that checks different value types for
`errorCallback`, but we must skip it because it causes issues with the
garbage collection.

Signed-off-by: Paul Maréchal <[email protected]>

Author: paul-marechal

index.d.ts

@@ -60,8 +60,8 @@ declare module 'nsfw' {
         interface Options {
             /** time in milliseconds to debounce the event callback */
             debounceMS?: number;
-            /**  callback to fire in the case of errors */
-            errorCallback: (err: any) => void
+            /** callback to fire in the case of errors */
+            errorCallback?: (err: any) => void
         }
     }
 

js/spec/index-spec.js

@@ -562,6 +562,31 @@ describe('Node Sentinel File Watcher', function() {
         watch = null;
       }
     });
+
+    it('Can pass falsy values to errorCallback', async function() {
+      const ok = [undefined, null, 0, '', false];
+      const notOk = [1, true, 'a', {}, []];
+      await Promise.all([
+        ...ok.map(async errorCallback => nsfw(
+          workDir,
+          () => {},
+          { errorCallback }
+        )),
+        ...notOk.map(async errorCallback => {
+          try {
+            await nsfw(
+              workDir,
+              () => {},
+              { errorCallback },
+            );
+          } catch (error) {
+            assert.ok(error.message === 'options.errorCallback must be a function.');
+            return;
+          }
+          assert.fail('nsfw must error if errorCallback is not a function nor a falsy value');
+        })
+      ]);
+    });
   });
 
   describe('Stress', function() {