Superminaren
/
kvm
mirror of https://github.com/jetkvm/kvm.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs: add JSDoc comments to createChartArray function in Metric component for better documentation

This commit is contained in:
Adam Shiervani 2025-08-28 12:05:18 +02:00
parent 8a07f7d186
commit 0340aa3749
1 changed files with 7 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
ui/src/components/Metric.tsx
View File

@ -1,3 +1,4 @@
/* eslint-disable react-refresh/only-export-components */
import { ComponentProps } from "react"; import { ComponentProps } from "react";
import { cva, cx } from "cva"; import { cva, cx } from "cva";
@ -28,7 +29,12 @@ interface MetricProps<T, K extends keyof T> {
badgeTheme?: ComponentProps<typeof MetricHeader>["badgeTheme"]; badgeTheme?: ComponentProps<typeof MetricHeader>["badgeTheme"];
} }
/* eslint-disable-next-line */ /**
* Creates a chart array from a metrics map and a metric name.
*
* @param metrics - Expected to be ordered from oldest to newest.
* @param metricName - Name of the metric to create a chart array for.
*/
export function createChartArray<T, K extends keyof T>( export function createChartArray<T, K extends keyof T>(
metrics: Map<number, T>, metrics: Map<number, T>,
metricName: K, metricName: K,