carbonlog-cf/dist/index.d.mts

DEFRA conversion factors for carbon footprint calculations

interface RawFactor {
    id: string;
    scope: string;
    activity: string;
    category: string;
    subcategory: string;
    unit: string;
    type: string;
    subtype: string;
    ghg: string;
    conversionFactor: number;
}
interface Multiplier {
    id: string;
    activity: string;
    co2: number;
    co2e: number;
}
interface MultiplierResult extends Multiplier {
    value: number;
}
interface EmissionResult {
    inputAmount: number;
    unit: string;
    co2e: number;
    co2?: number;
    ch4?: number;
    n2o?: number;
}

interface FactorQuery {
    activity: string;
    category?: string;
    subcategory?: string;
    unit: string;
    ghg: string;
    type?: string;
    subtype?: string;
}
declare const GHG_LABELS: {
    readonly CO2E: "kg CO2e";
    readonly CO2: "kg CO2e of CO2 per unit";
    readonly CH4: "kg CO2e of CH4 per unit";
    readonly N2O: "kg CO2e of N2O per unit";
};
declare function findAllGhgFactors(query: FactorQuery): RawFactor[];
declare function findAllGhgFactorsAndCalculate(query: FactorQuery, value: number): {
    co2e: number;
    co2: number;
    ch4: number;
    n2o: number;
    unit: string;
    inputAmount: number;
};
declare function factorById(id: string): RawFactor | undefined;
declare function factorByIdAndCalculate(id: string, value: number): number;
declare function findCoicopMultiplier(activity: string): Multiplier | undefined;
declare function findCoicopMultiplierAndCalculate(activity: string, value: number): {
    co2: null;
    co2e: null;
    value: number;
    id: null;
    activity: null;
} | {
    co2: number;
    co2e: number;
    value: number;
    id: string;
    activity: string;
};
declare function findSicMultiplier(activity: string): Multiplier | undefined;
declare function findSicMultiplierAndCalculate(activity: string, value: number): {
    co2: null;
    co2e: null;
    value: number;
    id: null;
    activity: null;
} | {
    co2: number;
    co2e: number;
    value: number;
    id: string;
    activity: string;
};

export { type EmissionResult, type FactorQuery, GHG_LABELS, type Multiplier, type MultiplierResult, type RawFactor, factorById, factorByIdAndCalculate, findAllGhgFactors, findAllGhgFactorsAndCalculate, findCoicopMultiplier, findCoicopMultiplierAndCalculate, findSicMultiplier, findSicMultiplierAndCalculate };