docs(extension-metrics): add packageDocumentation

Signed-off-by: Rifa Achrinza <25147899+achrinza@users.noreply.github.com>
loopbackio · Feb 22, 2020 · 8bc738b · 8bc738b
1 parent d7a01c4
commit 8bc738b
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/extensions/metrics/src/index.ts b/extensions/metrics/src/index.ts
@@ -3,6 +3,13 @@
 // This file is licensed under the MIT License.
 // License text available at https://opensource.org/licenses/MIT
 
+/**
+ * This module contains a component that reports metrics of Node.js, LoopBack
+ * framework, and your application to Prometheus.
+ *
+ * @packageDocumentation
+ */
+
 export * from 'prom-client';
 export * from './keys';
 export * from './metrics.component';