TeenyStatistics.d.ts
3.87 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
/**
* @license
* Copyright 2020 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
export interface TeenyStatisticsOptions {
/**
* A positive number representing when to issue a warning about the number
* of concurrent requests using teeny-request.
* Set to 0 to disable this warning.
* Corresponds to the TEENY_REQUEST_WARN_CONCURRENT_REQUESTS environment
* variable.
*/
concurrentRequests?: number;
}
declare type TeenyStatisticsConfig = Required<TeenyStatisticsOptions>;
/**
* TeenyStatisticsCounters is distinct from TeenyStatisticsOptions:
* Used when dumping current counters and other internal metrics.
*/
export interface TeenyStatisticsCounters {
concurrentRequests: number;
}
/**
* @class TeenyStatisticsWarning
* @extends Error
* @description While an error, is used for emitting warnings when
* meeting certain configured thresholds.
* @see process.emitWarning
*/
export declare class TeenyStatisticsWarning extends Error {
static readonly CONCURRENT_REQUESTS = "ConcurrentRequestsExceededWarning";
threshold: number;
type: string;
value: number;
/**
* @param {string} message
*/
constructor(message: string);
}
/**
* @class TeenyStatistics
* @description Maintain various statistics internal to teeny-request. Tracking
* is not automatic and must be instrumented within teeny-request.
*/
export declare class TeenyStatistics {
/**
* @description A default threshold representing when to warn about excessive
* in-flight/concurrent requests.
* @type {number}
* @static
* @readonly
* @default 5000
*/
static readonly DEFAULT_WARN_CONCURRENT_REQUESTS = 5000;
/**
* @type {TeenyStatisticsConfig}
* @private
*/
private _options;
/**
* @type {number}
* @private
* @default 0
*/
private _concurrentRequests;
/**
* @type {boolean}
* @private
* @default false
*/
private _didConcurrentRequestWarn;
/**
* @param {TeenyStatisticsOptions} [opts]
*/
constructor(opts?: TeenyStatisticsOptions);
/**
* Returns a copy of the current options.
* @return {TeenyStatisticsOptions}
*/
getOptions(): TeenyStatisticsOptions;
/**
* Change configured statistics options. This will not preserve unspecified
* options that were previously specified, i.e. this is a reset of options.
* @param {TeenyStatisticsOptions} [opts]
* @returns {TeenyStatisticsConfig} The previous options.
* @see _prepareOptions
*/
setOptions(opts?: TeenyStatisticsOptions): TeenyStatisticsConfig;
/**
* @readonly
* @return {TeenyStatisticsCounters}
*/
get counters(): TeenyStatisticsCounters;
/**
* @description Should call this right before making a request.
*/
requestStarting(): void;
/**
* @description When using `requestStarting`, call this after the request
* has finished.
*/
requestFinished(): void;
/**
* Configuration Precedence:
* 1. Dependency inversion via defined option.
* 2. Global numeric environment variable.
* 3. Built-in default.
* This will not preserve unspecified options previously specified.
* @param {TeenyStatisticsOptions} [opts]
* @returns {TeenyStatisticsOptions}
* @private
*/
private static _prepareOptions;
}
export {};