fix(MetricFactory): more specific return type for createMetricSearch

Fixes #583
cdklabs · Oct 24, 2024 · 1b54d60 · 1b54d60
1 parent 3c5ec1b
commit 1b54d60
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 6 deletions.
diff --git a/API.md b/API.md
diff --git a/README.md b/README.md
@@ -202,7 +202,7 @@ Multiple metrics cannot be rendered with anomaly detection in a single widget du
 ```ts
 monitorCustom({
   title: "Metric with anomaly detection",
-  metrics: [
+  metricGroups: [
     {
       metric: m1,
       anomalyDetectionStandardDeviationToRender: 3
@@ -216,7 +216,7 @@ Adding an alarm:
 ```ts
 monitorCustom({
   title: "Metric with anomaly detection and alarm",
-  metrics: [
+  metricGroups: [
     {
       metric: m1,
       alarmFriendlyName: "MetricWithAnomalyDetectionAlarm",
@@ -238,7 +238,7 @@ monitorCustom({
 ```ts
 monitorCustom({
   title: "Metric search",
-  metrics: [
+  metricGroups: [
     {
       searchQuery: "My.Prefix.",
       dimensionsMap: {

diff --git a/lib/common/metric/MetricFactory.ts b/lib/common/metric/MetricFactory.ts
@@ -146,7 +146,7 @@ export class MetricFactory {
     period?: Duration,
     region?: string,
     account?: string,
-  ): IMetric {
+  ): MathExpression {
     const finalPeriod =
       period ?? this.globalDefaults.period ?? DefaultMetricPeriod;
     const searchNamespace = this.getNamespaceWithFallback(namespace);