fix: ts declaration metrics option and getMetrics function

This commit is contained in:
Guy Berkovich
2023-04-26 17:35:52 +03:00
committed by Manuel Astudillo
parent e1883f01c2
commit 11331b718a
Vendored
+27
View File
@@ -85,6 +85,12 @@ declare namespace Bull {
limiter?: RateLimiter | undefined;
defaultJobOptions?: JobOptions | undefined;
metrics?: MetricsOpts; // Configure metrics
}
interface MetricsOpts {
maxDataPoints?: number; // Max number of data points to collect, granularity is fixed at one minute.
}
interface AdvancedSettings {
@@ -887,6 +893,27 @@ declare namespace Bull {
limit?: number
): Promise<Array<Job<T>>>;
/**
* Returns a promise that resolves to a Metrics object.
* @param type Job metric type either 'completed' or 'failed'
* @param start Start point of the metrics, where 0 is the newest point to be returned.
* @param end End point of the metrics, where -1 is the oldest point to be returned.
* @returns - Returns an object with queue metrics.
*/
getMetrics(
type: 'completed' | 'failed',
start?: number,
end?: number
) : Promise<{
meta: {
count: number;
prevTS: number;
prevCount: number;
};
data: number[];
count: number;
}>
/**
* Returns a promise that marks the start of a transaction block.
*/