Merge pull request #19 from eik-lib/metrics

feat: Add .metrics getter
eik-lib · Jul 6, 2020 · 93f3dc7 · 93f3dc7
2 parents 892a80e + a5f3584
commit 93f3dc7
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -93,6 +93,10 @@ const SinkCustom = class SinkCustom extends Sink {
         });
     }
 
+    get metrics() {
+        return // Custom metric stream code
+    }
+
     get [Symbol.toStringTag]() {
         return 'SinkCustom';
     }

diff --git a/lib/main.js b/lib/main.js
@@ -17,6 +17,10 @@ const Sink = class Sink {
         throw new Error('.exist method is not implemented');
     }
 
+    get metrics() {
+        throw new Error('.metrics getter is not implemented');
+    }
+
     static validateFilePath(filePath) {
         if (typeof filePath !== 'string') throw new TypeError('Argument must be a String');
         if (filePath === '') throw new TypeError('Argument can not be an empty String');

diff --git a/test/main.js b/test/main.js
@@ -41,6 +41,14 @@ test('Sink() - Call .exist() method', (t) => {
     t.end();
 });
 
+test('Sink() - Call .metrics getter', (t) => {
+    const obj = new Sink();
+    t.throws(() => {
+        const metric = obj.metrics; // eslint-disable-line no-unused-vars
+    }, /.metrics getter is not implemented/, 'Should throw');
+    t.end();
+});
+
 test('Sink() - Call .validateFilePath() with legal value', (t) => {
     t.equal(Sink.validateFilePath('foo'), 'foo', 'Should return value');
     t.end();