Add JSDoc for CumulativeEntry interface and its members

census-instrumentation · May 8, 2019 · 565b325 · 565b325
1 parent 5aa9f43
commit 565b325
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/packages/opencensus-core/src/metrics/cumulative/derived-cumulative.ts b/packages/opencensus-core/src/metrics/cumulative/derived-cumulative.ts
@@ -23,9 +23,16 @@ import * as util from '../utils';
 
 type ValueExtractor = () => number;
 
+/**
+ * An interface that describes the entry for every TimeSeries (Point) added to
+ * the Cumulative metric.
+ */
 interface CumulativeEntry {
+  /** The list of the label values. */
   readonly labelValues: LabelValue[];
+  /** The function to get the actual value of point. */
   readonly extractor: ValueExtractor;
+  /** The previous value of the point. */
   prevValue: number;
 }