benchmark-meter
Version:
benchmark-meter is a straightforward benchmarking tool designed for measuring the performance of algorithms
55 lines (53 loc) • 1.13 kB
TypeScript
export interface IAlgorithmBody {
name: string;
fn: () => unknown;
repeat: number;
}
/**
* Represents the result of a performance measurement for a specific algorithm.
*
* @interface IResult
*/
export interface IResult {
/**
* The name of the algorithm.
*
* @type {string}
*/
name: string;
/**
* The average duration of the algorithm.
*
* @type {string}
*/
average: string;
/**
* The duration of the fastest execution of the algorithm.
*
* @type {string}
*/
fastest: string;
/**
* The duration of the slowest execution of the algorithm.
*
* @type {string}
*/
slowest: string;
}
/**
* Options for configuring the Algorithm execution.
*
* @interface IBenchmarkOptions
* @since 1.0.0
*/
export interface IBenchmarkOptions {
/**
* The number of times the algorithm will be executed.
*
* @remarks
* This value determines how many times the algorithm will be repeated for accurate performance measurement.
* @default 10
* @type {number}
*/
repeat?: number;
}