cardamon
Version:
A CLI tool for measuring the carbon footprint and energy consumption of web pages using the Cardamon model
40 lines • 1.29 kB
TypeScript
/**
* Cardamon.ts
* Implementation of the Cardamon Model
*/
import type { CardamonConfig, EmissionsMetrics, EnergyMetrics, RegionalDistribution } from './types.ts';
/**
* Main Cardamon SDK class for calculating web application energy consumption and emissions
*/
export declare class Cardamon {
private config;
private backendMeasurementDurationMs;
private co2BreakdownByRegion;
constructor(config: CardamonConfig);
/**
* Validates and normalizes configuration, applying defaults where needed
*/
private validateConfig;
/**
* Calculates all energy and emissions metrics
*/
calculateMetrics(): {
energy: EnergyMetrics;
emissions: EmissionsMetrics;
};
private calculateFrontendCPUEnergy;
private calculateFrontendScreenEnergy;
private calculateFrontendNetworkEnergy;
private calculateFrontendIdleEnergy;
private calculateBackendCPUEnergy;
private calculateBackendNetworkEnergy;
private calculateBackendIdleEnergy;
private calculateBackendEmbodiedEmissions;
private calculateFrontendEmbodiedEmissions;
getCO2BreakdownByRegion(): (RegionalDistribution & {
co2: number;
type: string;
})[];
private calculateEmissions;
}
//# sourceMappingURL=cardamon.d.ts.map