unitsnet-js
Version:
A better way to hold unit variables and easily convert to the destination unit
279 lines (278 loc) • 12.7 kB
JavaScript
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.ReactiveEnergy = exports.ReactiveEnergyUnits = void 0;
const base_unit_1 = require("../base-unit");
/** ReactiveEnergyUnits enumeration */
var ReactiveEnergyUnits;
(function (ReactiveEnergyUnits) {
/** */
ReactiveEnergyUnits["VoltampereReactiveHours"] = "VoltampereReactiveHour";
/** */
ReactiveEnergyUnits["KilovoltampereReactiveHours"] = "KilovoltampereReactiveHour";
/** */
ReactiveEnergyUnits["MegavoltampereReactiveHours"] = "MegavoltampereReactiveHour";
})(ReactiveEnergyUnits = exports.ReactiveEnergyUnits || (exports.ReactiveEnergyUnits = {}));
/** The Volt-ampere reactive hour (expressed as varh) is the reactive power of one Volt-ampere reactive produced in one hour. */
class ReactiveEnergy extends base_unit_1.BaseUnit {
/**
* Create a new ReactiveEnergy.
* @param value The value.
* @param fromUnit The ‘ReactiveEnergy’ unit to create from.
* The default unit is VoltampereReactiveHours
*/
constructor(value, fromUnit = ReactiveEnergyUnits.VoltampereReactiveHours) {
super();
this.voltamperereactivehoursLazy = null;
this.kilovoltamperereactivehoursLazy = null;
this.megavoltamperereactivehoursLazy = null;
if (value === undefined || value === null || Number.isNaN(value)) {
throw new TypeError('invalid unit value ‘' + value + '’');
}
this.value = this.convertToBase(value, fromUnit);
}
/**
* The base value of ReactiveEnergy is VoltampereReactiveHours.
* This accessor used when needs a value for calculations and it's better to use directly the base value
*/
get BaseValue() {
return this.value;
}
/** Gets the default unit used when creating instances of the unit or its DTO */
get baseUnit() {
return ReactiveEnergyUnits.VoltampereReactiveHours;
}
/** */
get VoltampereReactiveHours() {
if (this.voltamperereactivehoursLazy !== null) {
return this.voltamperereactivehoursLazy;
}
return this.voltamperereactivehoursLazy = this.convertFromBase(ReactiveEnergyUnits.VoltampereReactiveHours);
}
/** */
get KilovoltampereReactiveHours() {
if (this.kilovoltamperereactivehoursLazy !== null) {
return this.kilovoltamperereactivehoursLazy;
}
return this.kilovoltamperereactivehoursLazy = this.convertFromBase(ReactiveEnergyUnits.KilovoltampereReactiveHours);
}
/** */
get MegavoltampereReactiveHours() {
if (this.megavoltamperereactivehoursLazy !== null) {
return this.megavoltamperereactivehoursLazy;
}
return this.megavoltamperereactivehoursLazy = this.convertFromBase(ReactiveEnergyUnits.MegavoltampereReactiveHours);
}
/**
* Create a new ReactiveEnergy instance from a VoltampereReactiveHours
*
* @param value The unit as VoltampereReactiveHours to create a new ReactiveEnergy from.
* @returns The new ReactiveEnergy instance.
*/
static FromVoltampereReactiveHours(value) {
return new ReactiveEnergy(value, ReactiveEnergyUnits.VoltampereReactiveHours);
}
/**
* Create a new ReactiveEnergy instance from a KilovoltampereReactiveHours
*
* @param value The unit as KilovoltampereReactiveHours to create a new ReactiveEnergy from.
* @returns The new ReactiveEnergy instance.
*/
static FromKilovoltampereReactiveHours(value) {
return new ReactiveEnergy(value, ReactiveEnergyUnits.KilovoltampereReactiveHours);
}
/**
* Create a new ReactiveEnergy instance from a MegavoltampereReactiveHours
*
* @param value The unit as MegavoltampereReactiveHours to create a new ReactiveEnergy from.
* @returns The new ReactiveEnergy instance.
*/
static FromMegavoltampereReactiveHours(value) {
return new ReactiveEnergy(value, ReactiveEnergyUnits.MegavoltampereReactiveHours);
}
/**
* Gets the base unit enumeration associated with ReactiveEnergy
* @returns The unit enumeration that can be used to interact with this type
*/
static getUnitEnum() {
return ReactiveEnergyUnits;
}
/**
* Gets the default unit used when creating instances of the unit or its DTO
* @returns The unit enumeration value used as a default parameter in constructor and DTO methods
*/
static getBaseUnit() {
return ReactiveEnergyUnits.VoltampereReactiveHours;
}
/**
* Create API DTO represent a ReactiveEnergy unit.
* @param holdInUnit The specific ReactiveEnergy unit to be used in the unit representation at the DTO
*/
toDto(holdInUnit = ReactiveEnergyUnits.VoltampereReactiveHours) {
return {
value: this.convert(holdInUnit),
unit: holdInUnit
};
}
/**
* Create a ReactiveEnergy unit from an API DTO representation.
* @param dtoReactiveEnergy The ReactiveEnergy API DTO representation
*/
static FromDto(dtoReactiveEnergy) {
return new ReactiveEnergy(dtoReactiveEnergy.value, dtoReactiveEnergy.unit);
}
/**
* Convert ReactiveEnergy to a specific unit value.
* @param toUnit The specific unit to convert to
* @returns The value of the specific unit provided.
*/
convert(toUnit) {
switch (toUnit) {
case ReactiveEnergyUnits.VoltampereReactiveHours: return this.VoltampereReactiveHours;
case ReactiveEnergyUnits.KilovoltampereReactiveHours: return this.KilovoltampereReactiveHours;
case ReactiveEnergyUnits.MegavoltampereReactiveHours: return this.MegavoltampereReactiveHours;
default:
break;
}
return Number.NaN;
}
convertFromBase(toUnit) {
if (base_unit_1.areAnyOperatorsOverridden())
switch (toUnit) {
case ReactiveEnergyUnits.VoltampereReactiveHours: return this.value;
case ReactiveEnergyUnits.KilovoltampereReactiveHours: return super.internalDivide(this.value, 1000);
case ReactiveEnergyUnits.MegavoltampereReactiveHours: return super.internalDivide(this.value, 1000000);
default: return Number.NaN;
}
switch (toUnit) {
case ReactiveEnergyUnits.VoltampereReactiveHours: return this.value;
case ReactiveEnergyUnits.KilovoltampereReactiveHours: return (this.value) / 1000;
case ReactiveEnergyUnits.MegavoltampereReactiveHours: return (this.value) / 1000000;
default: return Number.NaN;
}
}
convertToBase(value, fromUnit) {
if (base_unit_1.areAnyOperatorsOverridden())
switch (fromUnit) {
case ReactiveEnergyUnits.VoltampereReactiveHours: return value;
case ReactiveEnergyUnits.KilovoltampereReactiveHours: return super.internalMultiply(value, 1000);
case ReactiveEnergyUnits.MegavoltampereReactiveHours: return super.internalMultiply(value, 1000000);
default: return Number.NaN;
}
switch (fromUnit) {
case ReactiveEnergyUnits.VoltampereReactiveHours: return value;
case ReactiveEnergyUnits.KilovoltampereReactiveHours: return (value) * 1000;
case ReactiveEnergyUnits.MegavoltampereReactiveHours: return (value) * 1000000;
default: return Number.NaN;
}
}
/**
* Format the ReactiveEnergy to string.
* Note! the default format for ReactiveEnergy is VoltampereReactiveHours.
* To specify the unit format set the 'unit' parameter.
* @param unit The unit to format the ReactiveEnergy.
* @param options The ToString options, it also can be the number of fractional digits to keep that deprecated and moved to the options object. support in number will be dropped in the upcoming versions.
* @returns The string format of the ReactiveEnergy.
*/
toString(unit = ReactiveEnergyUnits.VoltampereReactiveHours, options) {
if (typeof options === 'number') {
console.warn('The number parameter is deprecated and moved to the options object. support in number will be dropped in the upcoming versions.');
options = { fractionalDigits: options };
}
switch (unit) {
case ReactiveEnergyUnits.VoltampereReactiveHours:
return super.truncateFractionDigits(this.VoltampereReactiveHours, options) + ` varh`;
case ReactiveEnergyUnits.KilovoltampereReactiveHours:
return super.truncateFractionDigits(this.KilovoltampereReactiveHours, options) + ` kvarh`;
case ReactiveEnergyUnits.MegavoltampereReactiveHours:
return super.truncateFractionDigits(this.MegavoltampereReactiveHours, options) + ` Mvarh`;
default:
break;
}
return this.value.toString();
}
/**
* Get ReactiveEnergy unit abbreviation.
* Note! the default abbreviation for ReactiveEnergy is VoltampereReactiveHours.
* To specify the unit abbreviation set the 'unitAbbreviation' parameter.
* @param unitAbbreviation The unit abbreviation of the ReactiveEnergy.
* @returns The abbreviation string of ReactiveEnergy.
*/
getUnitAbbreviation(unitAbbreviation = ReactiveEnergyUnits.VoltampereReactiveHours) {
switch (unitAbbreviation) {
case ReactiveEnergyUnits.VoltampereReactiveHours:
return `varh`;
case ReactiveEnergyUnits.KilovoltampereReactiveHours:
return `kvarh`;
case ReactiveEnergyUnits.MegavoltampereReactiveHours:
return `Mvarh`;
default:
break;
}
return '';
}
/**
* Check if the given ReactiveEnergy are equals to the current ReactiveEnergy.
* @param reactiveEnergy The other ReactiveEnergy.
* @returns True if the given ReactiveEnergy are equal to the current ReactiveEnergy.
*/
equals(reactiveEnergy) {
return super.internalEquals(this.value, reactiveEnergy.BaseValue);
}
/**
* Compare the given ReactiveEnergy against the current ReactiveEnergy.
* @param reactiveEnergy The other ReactiveEnergy.
* @returns 0 if they are equal, -1 if the current ReactiveEnergy is less then other, 1 if the current ReactiveEnergy is greater then other.
*/
compareTo(reactiveEnergy) {
return super.internalCompareTo(this.value, reactiveEnergy.BaseValue);
}
/**
* Add the given ReactiveEnergy with the current ReactiveEnergy.
* @param reactiveEnergy The other ReactiveEnergy.
* @returns A new ReactiveEnergy instance with the results.
*/
add(reactiveEnergy) {
return new ReactiveEnergy(super.internalAdd(this.value, reactiveEnergy.BaseValue));
}
/**
* Subtract the given ReactiveEnergy with the current ReactiveEnergy.
* @param reactiveEnergy The other ReactiveEnergy.
* @returns A new ReactiveEnergy instance with the results.
*/
subtract(reactiveEnergy) {
return new ReactiveEnergy(super.internalSubtract(this.value, reactiveEnergy.BaseValue));
}
/**
* Multiply the given ReactiveEnergy with the current ReactiveEnergy.
* @param reactiveEnergy The other ReactiveEnergy.
* @returns A new ReactiveEnergy instance with the results.
*/
multiply(reactiveEnergy) {
return new ReactiveEnergy(super.internalMultiply(this.value, reactiveEnergy.BaseValue));
}
/**
* Divide the given ReactiveEnergy with the current ReactiveEnergy.
* @param reactiveEnergy The other ReactiveEnergy.
* @returns A new ReactiveEnergy instance with the results.
*/
divide(reactiveEnergy) {
return new ReactiveEnergy(super.internalDivide(this.value, reactiveEnergy.BaseValue));
}
/**
* Modulo the given ReactiveEnergy with the current ReactiveEnergy.
* @param reactiveEnergy The other ReactiveEnergy.
* @returns A new ReactiveEnergy instance with the results.
*/
modulo(reactiveEnergy) {
return new ReactiveEnergy(super.internalModulo(this.value, reactiveEnergy.BaseValue));
}
/**
* Pow the given ReactiveEnergy with the current ReactiveEnergy.
* @param reactiveEnergy The other ReactiveEnergy.
* @returns A new ReactiveEnergy instance with the results.
*/
pow(reactiveEnergy) {
return new ReactiveEnergy(super.internalPow(this.value, reactiveEnergy.BaseValue));
}
}
exports.ReactiveEnergy = ReactiveEnergy;