feat: uses default export and updated types

BREAKING CHANGE:

Changed to using a default export for TestConsumer and added a named export for
'createMetric' utility object.

Updated types to contain all exports.

Author: leftieFriele

README.md

@@ -18,7 +18,7 @@ Below is a sample test showing how this could be used:
 ```js
 const test = require('tap');
 const Metrics = require('@metrics/client');
-const { TestConsumer } = require('@metrics/test-consumer');
+const TestConsumer = require('@metrics/test-consumer');
 
 test('some test case', async () => {
     const metrics = new Metrics();
@@ -48,6 +48,7 @@ test('some test case', async () => {
     -   [start](#start)
     -   [stop](#stop)
     -  [getResults](#async-getresults)
+- [createMetrics](#createmetrics)
 
 ### constructor(metrics)
 
@@ -63,4 +64,8 @@ Ends the stream setup for the client, returns a Promise which resolves to an arr
 
 ### async .getResults()
 
-Returns a promise which resolves to an array containing collected `[@metrics/metrics](https://metrics-js.github.io/reference/metric/)` objects.
+Returns a promise which resolves to an array containing collected `[@metrics/metrics](https://metrics-js.github.io/reference/metric/)` objects.
+
+### createMetrics
+
+Utility object with functions for creating mock `Metric` objects, has the functions `.timer` and `.counter`.

lib/index.js

@@ -149,7 +149,5 @@ const createMetric = {
 	}),
 };
 
-module.exports = {
-	TestConsumer,
-	createMetric,
-};
+module.exports = TestConsumer;
+module.exports.createMetric = createMetric;

test-consumer.d.ts

@@ -1,10 +1,31 @@
-import MetricsClient, {MetricsCounter, MetricsGauge, MetricsHistogram, MetricsSummary} from '@metrics/client';
+import MetricsClient from '@metrics/client';
 import Metric from "@metrics/metric";
 
-declare class TestConsumer  {
+declare class TestConsumer {
     constructor(metrics: MetricsClient);
+
     start();
+
     stop();
+
     getResults(): Promise<Array<Metric>>;
 }
+
+declare namespace TestConsumer {
+    /**
+     * Contains utility functions for creating `Metrics` objects in tests.
+     */
+    export interface CreateMetric {
+        timer: (options: CreateMetricOptions) => Metric;
+        counter: (options: CreateMetricOptions) => Metric;
+    }
+
+    type CreateMetricOptions = {
+        uri?: string;
+        method?: string;
+        status?: number | string;
+        type?: string | Object
+    }
+    export const createMetric: CreateMetric;
+}
 export = TestConsumer;

test/index.js

@@ -3,7 +3,8 @@
 const { test } = require("tap");
 const MetricsClient = require("@metrics/client");
 
-const { TestConsumer, createMetric } = require("../lib/index");
+const TestConsumer = require("../lib/index");
+const { createMetric } = TestConsumer;
 
 test("has a start and stop method", async (t) => {
 	const testHelper = new TestConsumer(new MetricsClient());