@cloud-carbon-footprint/core/src/IFootprintEstimator.ts

The core logic to get cloud usage data and estimate energy and carbon emissions.

/*
 * © 2021 Thoughtworks, Inc.
 */

import {
  FootprintEstimate,
  IUsageData,
  CloudConstantsEmissionsFactors,
  CloudConstants,
} from '.'

export default interface IFootprintEstimator {
  estimate(
    data: IUsageData[],
    region: string,
    emissionsFactors: CloudConstantsEmissionsFactors,
    constants?: CloudConstants,
  ): FootprintEstimate[]
}