1 | /**
|
2 | * Copyright 2019, OpenCensus Authors
|
3 | *
|
4 | * Licensed under the Apache License, Version 2.0 (the "License");
|
5 | * you may not use this file except in compliance with the License.
|
6 | * You may obtain a copy of the License at
|
7 | *
|
8 | * http://www.apache.org/licenses/LICENSE-2.0
|
9 | *
|
10 | * Unless required by applicable law or agreed to in writing, software
|
11 | * distributed under the License is distributed on an "AS IS" BASIS,
|
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
13 | * See the License for the specific language governing permissions and
|
14 | * limitations under the License.
|
15 | */
|
16 | import { TimeSeries, Timestamp } from '../export/types';
|
17 | export interface CumulativePoint {
|
18 | /** Reset cumulative metric. */
|
19 | reset(): void;
|
20 | /**
|
21 | * Increment the cumulative metric.
|
22 | * @param val The new value.
|
23 | */
|
24 | inc(val?: number): void;
|
25 | /**
|
26 | * Returns the TimeSeries with one or more Point.
|
27 | *
|
28 | * @param now The time at which the cumulative is recorded.
|
29 | * @returns The TimeSeries.
|
30 | */
|
31 | getTimeSeries(now: Timestamp): TimeSeries;
|
32 | }
|