Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 | 1x 1x 1x 1x 1x 1x 1x | import { Client } from "../Client";
import { LOCATION_API_PATH, POST } from "../Constants";
import { LocationRequest } from "../interfaces/Api";
import { EmissionResponse } from "../interfaces/response/EmissionResponse";
import { EmissionResponseWithDetails } from "../interfaces/response/EmissionResponseWithDetails";
import { makeApiRequest } from "../request";
/**
* Performs scope 2 purchased energy Emission calculations by making a POST request to the location API endpoint.
*
* @export
* @param {LocationRequest} payload - The location request data to be sent to the API
* @return {Promise<EmissionResponse | EmissionResponseWithDetails>} A promise that resolves to the emission calculation result. Returns EmissionResponseWithDetails if includeDetails is true, otherwise EmissionResponse
* @throws {Error} May throw an error if the API request fails
*
* @example
* const calculationRequest = {
"time" : {
"date": "2025-01-04"
},
"location": {
"country": "usa",
"stateProvince": "new york"
},
"activity": {
"type":"electricity",
"unit": "kwh",
"value": 14123143
},
"includeDetails": true
};
* const result = await calculate(calculationRequest);
*/
export async function calculate(
payload: LocationRequest
): Promise<EmissionResponse | EmissionResponseWithDetails> {
const client = Client.getInstance();
const url = client.getDomain() + LOCATION_API_PATH;
return makeApiRequest<EmissionResponse | EmissionResponseWithDetails>({
method: POST,
url,
data: payload,
});
} |