@tgwf/co2
Version:
Work out the co2 of your digital services
197 lines (196 loc) • 7.66 kB
JavaScript
var __defProp = Object.defineProperty;
var __getOwnPropSymbols = Object.getOwnPropertySymbols;
var __hasOwnProp = Object.prototype.hasOwnProperty;
var __propIsEnum = Object.prototype.propertyIsEnumerable;
var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
var __spreadValues = (a, b) => {
for (var prop in b || (b = {}))
if (__hasOwnProp.call(b, prop))
__defNormalProp(a, prop, b[prop]);
if (__getOwnPropSymbols)
for (var prop of __getOwnPropSymbols(b)) {
if (__propIsEnum.call(b, prop))
__defNormalProp(a, prop, b[prop]);
}
return a;
};
var __objRest = (source, exclude) => {
var target = {};
for (var prop in source)
if (__hasOwnProp.call(source, prop) && exclude.indexOf(prop) < 0)
target[prop] = source[prop];
if (source != null && __getOwnPropSymbols)
for (var prop of __getOwnPropSymbols(source)) {
if (exclude.indexOf(prop) < 0 && __propIsEnum.call(source, prop))
target[prop] = source[prop];
}
return target;
};
import OneByte from "./1byte.js";
import SustainableWebDesignV3 from "./sustainable-web-design-v3.js";
import SustainableWebDesignV4 from "./sustainable-web-design-v4.js";
import {
parseByteTraceOptions,
parseVisitTraceOptions
} from "./helpers/index.js";
class CO2 {
constructor(options) {
this.model = new SustainableWebDesignV3();
if ((options == null ? void 0 : options.model) === "1byte") {
this.model = new OneByte();
} else if ((options == null ? void 0 : options.model) === "swd") {
this.model = new SustainableWebDesignV3();
if ((options == null ? void 0 : options.version) === 4) {
this.model = new SustainableWebDesignV4();
}
} else if (options == null ? void 0 : options.model) {
throw new Error(
'"'.concat(options.model, '" is not a valid model. Please use "1byte" for the OneByte model, and "swd" for the Sustainable Web Design model.\nSee https://developers.thegreenwebfoundation.org/co2js/models/ to learn more about the models available in CO2.js.')
);
}
if ((options == null ? void 0 : options.rating) && typeof options.rating !== "boolean") {
throw new Error(
"The rating option must be a boolean. Please use true or false.\nSee https://developers.thegreenwebfoundation.org/co2js/options/ to learn more about the options available in CO2.js."
);
}
const allowRatings = !!this.model.allowRatings;
this._segment = (options == null ? void 0 : options.results) === "segment";
this._rating = (options == null ? void 0 : options.rating) === true;
if (!allowRatings && this._rating) {
throw new Error(
"The rating system is not supported in the model you are using. Try using the Sustainable Web Design model instead.\nSee https://developers.thegreenwebfoundation.org/co2js/models/ to learn more about the models available in CO2.js."
);
}
}
/**
* Accept a figure in bytes for data transfer, and a boolean for whether
* the domain shows as 'green', and return a CO2 figure for energy used to shift the corresponding
* the data transfer.
*
* @param {number} bytes
* @param {boolean} green
* @return {number|CO2EstimateComponentsPerByte} the amount of CO2 in grammes or its separate components
*/
perByte(bytes, green = false) {
return this.model.perByte(bytes, green, this._segment, this._rating);
}
/**
* Accept a figure in bytes for data transfer, and a boolean for whether
* the domain shows as 'green', and return a CO2 figure for energy used to shift the corresponding
* the data transfer.
*
* @param {number} bytes
* @param {boolean} green
* @return {number|CO2EstimateComponentsPerVisit} the amount of CO2 in grammes or its separate components
*/
perVisit(bytes, green = false) {
var _a;
if ((_a = this.model) == null ? void 0 : _a.perVisit) {
return this.model.perVisit(bytes, green, this._segment, this._rating);
} else {
throw new Error(
"The perVisit() method is not supported in the model you are using. Try using perByte() instead.\nSee https://developers.thegreenwebfoundation.org/co2js/methods/ to learn more about the methods available in CO2.js."
);
}
}
/**
* Accept a figure in bytes for data transfer, a boolean for whether
* the domain shows as 'green', and an options object.
* Returns an object containing CO2 figure, green boolean, and object of the variables used in calculating the CO2 figure.
*
* @param {number} bytes
* @param {boolean} green
* @param {Object} options
* @return {CO2EstimateTraceResultPerByte} the amount of CO2 in grammes
*/
perByteTrace(bytes, green = false, options = {}) {
const adjustments = parseByteTraceOptions(
options,
this.model.version,
green
);
const _a = adjustments, { gridIntensity } = _a, traceVariables = __objRest(_a, ["gridIntensity"]);
const _b = traceVariables, {
dataReloadRatio,
firstVisitPercentage,
returnVisitPercentage
} = _b, otherVariables = __objRest(_b, [
"dataReloadRatio",
"firstVisitPercentage",
"returnVisitPercentage"
]);
return {
co2: this.model.perByte(
bytes,
green,
this._segment,
this._rating,
adjustments
),
green,
variables: __spreadValues({
description: "Below are the variables used to calculate this CO2 estimate.",
bytes,
gridIntensity: __spreadValues({
description: "The grid intensity (grams per kilowatt-hour) used to calculate this CO2 estimate."
}, adjustments.gridIntensity)
}, otherVariables)
};
}
/**
* Accept a figure in bytes for data transfer, a boolean for whether
* the domain shows as 'green', and an options object.
* Returns an object containing CO2 figure, green boolean, and object of the variables used in calculating the CO2 figure.
*
* @param {number} bytes
* @param {boolean} green
* @param {Object} options
* @return {CO2EstimateTraceResultPerVisit} the amount of CO2 in grammes
*/
perVisitTrace(bytes, green = false, options = {}) {
var _a;
if ((_a = this.model) == null ? void 0 : _a.perVisit) {
const adjustments = parseVisitTraceOptions(
options,
this.model.version,
green
);
const _b = adjustments, { gridIntensity } = _b, variables = __objRest(_b, ["gridIntensity"]);
return {
co2: this.model.perVisit(
bytes,
green,
this._segment,
this._rating,
adjustments
),
green,
variables: __spreadValues({
description: "Below are the variables used to calculate this CO2 estimate.",
bytes,
gridIntensity: __spreadValues({
description: "The grid intensity (grams per kilowatt-hour) used to calculate this CO2 estimate."
}, adjustments.gridIntensity)
}, variables)
};
} else {
throw new Error(
"The perVisitTrace() method is not supported in the model you are using. Try using perByte() instead.\nSee https://developers.thegreenwebfoundation.org/co2js/methods/ to learn more about the methods available in CO2.js."
);
}
}
SustainableWebDesignV3() {
return new SustainableWebDesignV3();
}
SustainableWebDesignV4() {
return new SustainableWebDesignV4();
}
OneByte() {
return new OneByte();
}
}
var co2_default = CO2;
export {
CO2,
co2_default as default
};