feat: add getMetricValueByName function

Retrieves last metric value based off of the name provided

.vscode/settings.json

@@ -3,5 +3,8 @@
   "editor.formatOnSave": true,
   "files.exclude": {
     "**/node_modules/*": true
-  }
+  },
+  "cSpell.words": [
+    "grafana"
+  ]
 }

CHANGELOG.md

@@ -1,9 +1,7 @@
-# Changelog for component-template
+# Changelog for grafana-metric
 
 ## v0.0.0 (YYYY/MM/DD)
 
-### Breaking changes
-
 ### Features / enhancements
 
-### Bug fixes
+- Add getMetricValueByName which retrieves last metric value based off of the name provided.

README.md

@@ -1,26 +1,15 @@
-# Component name
+# HTMLGraphics metric
 
-A short description of the component
-
-E.g. This component adds two numbers together.
-It also has a variable and function that returns "something".
+Retrieves metric value from Grafana's [data interface](https://grafana.com/docs/grafana/latest/packages_api/data/paneldata/).
 
 ## Usage
 
-Description/example on how to use the component.
-
-### add
-
-```ts
-import { add } from "@gapit/component-template";
-
-add(2, 3); // Returns 5
-```
+### getMetricValueByName
 
-### SOMETHING_VARIABLE
+Retrieves last metric value based off of the name provided.
 
 ```ts
-import { SOMETHING_VARIABLE } from "@gapit/component-template";
+import { getMetricValueByName } from "@gapit/grafana-metric";
 
-console.log(SOMETHING_VARIABLE); // Returns "something
+getMetricValueByName("metric-name"); // Returns metric value
 ```

jest.config.js

@@ -1,5 +1,5 @@
 module.exports = {
-  roots: ["<rootDir>/src", "<rootDir>/test"],
+  roots: ["<rootDir>/src"],
   testMatch: ["**/__tests__/**/*.+(ts|js)", "**/?(*.)+(spec|test).+(ts|js)"],
   transform: {
     "^.+\\.(ts)$": "ts-jest",