unitsnet-js
Version:
A better way to hold unit variables and easily convert to the destination unit
279 lines (278 loc) • 11.7 kB
JavaScript
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.LeakRate = exports.LeakRateUnits = void 0;
const base_unit_1 = require("../base-unit");
/** LeakRateUnits enumeration */
var LeakRateUnits;
(function (LeakRateUnits) {
/** */
LeakRateUnits["PascalCubicMetersPerSecond"] = "PascalCubicMeterPerSecond";
/** */
LeakRateUnits["MillibarLitersPerSecond"] = "MillibarLiterPerSecond";
/** */
LeakRateUnits["TorrLitersPerSecond"] = "TorrLiterPerSecond";
})(LeakRateUnits = exports.LeakRateUnits || (exports.LeakRateUnits = {}));
/** A leakage rate of QL = 1 Pa-m³/s is given when the pressure in a closed, evacuated container with a volume of 1 m³ rises by 1 Pa per second or when the pressure in the container drops by 1 Pa in the event of overpressure. */
class LeakRate extends base_unit_1.BaseUnit {
/**
* Create a new LeakRate.
* @param value The value.
* @param fromUnit The ‘LeakRate’ unit to create from.
* The default unit is PascalCubicMetersPerSecond
*/
constructor(value, fromUnit = LeakRateUnits.PascalCubicMetersPerSecond) {
super();
this.pascalcubicmeterspersecondLazy = null;
this.millibarliterspersecondLazy = null;
this.torrliterspersecondLazy = 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 LeakRate is PascalCubicMetersPerSecond.
* 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 LeakRateUnits.PascalCubicMetersPerSecond;
}
/** */
get PascalCubicMetersPerSecond() {
if (this.pascalcubicmeterspersecondLazy !== null) {
return this.pascalcubicmeterspersecondLazy;
}
return this.pascalcubicmeterspersecondLazy = this.convertFromBase(LeakRateUnits.PascalCubicMetersPerSecond);
}
/** */
get MillibarLitersPerSecond() {
if (this.millibarliterspersecondLazy !== null) {
return this.millibarliterspersecondLazy;
}
return this.millibarliterspersecondLazy = this.convertFromBase(LeakRateUnits.MillibarLitersPerSecond);
}
/** */
get TorrLitersPerSecond() {
if (this.torrliterspersecondLazy !== null) {
return this.torrliterspersecondLazy;
}
return this.torrliterspersecondLazy = this.convertFromBase(LeakRateUnits.TorrLitersPerSecond);
}
/**
* Create a new LeakRate instance from a PascalCubicMetersPerSecond
*
* @param value The unit as PascalCubicMetersPerSecond to create a new LeakRate from.
* @returns The new LeakRate instance.
*/
static FromPascalCubicMetersPerSecond(value) {
return new LeakRate(value, LeakRateUnits.PascalCubicMetersPerSecond);
}
/**
* Create a new LeakRate instance from a MillibarLitersPerSecond
*
* @param value The unit as MillibarLitersPerSecond to create a new LeakRate from.
* @returns The new LeakRate instance.
*/
static FromMillibarLitersPerSecond(value) {
return new LeakRate(value, LeakRateUnits.MillibarLitersPerSecond);
}
/**
* Create a new LeakRate instance from a TorrLitersPerSecond
*
* @param value The unit as TorrLitersPerSecond to create a new LeakRate from.
* @returns The new LeakRate instance.
*/
static FromTorrLitersPerSecond(value) {
return new LeakRate(value, LeakRateUnits.TorrLitersPerSecond);
}
/**
* Gets the base unit enumeration associated with LeakRate
* @returns The unit enumeration that can be used to interact with this type
*/
static getUnitEnum() {
return LeakRateUnits;
}
/**
* 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 LeakRateUnits.PascalCubicMetersPerSecond;
}
/**
* Create API DTO represent a LeakRate unit.
* @param holdInUnit The specific LeakRate unit to be used in the unit representation at the DTO
*/
toDto(holdInUnit = LeakRateUnits.PascalCubicMetersPerSecond) {
return {
value: this.convert(holdInUnit),
unit: holdInUnit
};
}
/**
* Create a LeakRate unit from an API DTO representation.
* @param dtoLeakRate The LeakRate API DTO representation
*/
static FromDto(dtoLeakRate) {
return new LeakRate(dtoLeakRate.value, dtoLeakRate.unit);
}
/**
* Convert LeakRate 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 LeakRateUnits.PascalCubicMetersPerSecond: return this.PascalCubicMetersPerSecond;
case LeakRateUnits.MillibarLitersPerSecond: return this.MillibarLitersPerSecond;
case LeakRateUnits.TorrLitersPerSecond: return this.TorrLitersPerSecond;
default:
break;
}
return Number.NaN;
}
convertFromBase(toUnit) {
if (base_unit_1.areAnyOperatorsOverridden())
switch (toUnit) {
case LeakRateUnits.PascalCubicMetersPerSecond: return this.value;
case LeakRateUnits.MillibarLitersPerSecond: return super.internalMultiply(this.value, 10);
case LeakRateUnits.TorrLitersPerSecond: return super.internalMultiply(this.value, 7.5);
default: return Number.NaN;
}
switch (toUnit) {
case LeakRateUnits.PascalCubicMetersPerSecond: return this.value;
case LeakRateUnits.MillibarLitersPerSecond: return this.value * 10;
case LeakRateUnits.TorrLitersPerSecond: return this.value * 7.5;
default: return Number.NaN;
}
}
convertToBase(value, fromUnit) {
if (base_unit_1.areAnyOperatorsOverridden())
switch (fromUnit) {
case LeakRateUnits.PascalCubicMetersPerSecond: return value;
case LeakRateUnits.MillibarLitersPerSecond: return super.internalDivide(value, 10);
case LeakRateUnits.TorrLitersPerSecond: return super.internalDivide(value, 7.5);
default: return Number.NaN;
}
switch (fromUnit) {
case LeakRateUnits.PascalCubicMetersPerSecond: return value;
case LeakRateUnits.MillibarLitersPerSecond: return value / 10;
case LeakRateUnits.TorrLitersPerSecond: return value / 7.5;
default: return Number.NaN;
}
}
/**
* Format the LeakRate to string.
* Note! the default format for LeakRate is PascalCubicMetersPerSecond.
* To specify the unit format set the 'unit' parameter.
* @param unit The unit to format the LeakRate.
* @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 LeakRate.
*/
toString(unit = LeakRateUnits.PascalCubicMetersPerSecond, 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 LeakRateUnits.PascalCubicMetersPerSecond:
return super.truncateFractionDigits(this.PascalCubicMetersPerSecond, options) + ` Pa·m³/s`;
case LeakRateUnits.MillibarLitersPerSecond:
return super.truncateFractionDigits(this.MillibarLitersPerSecond, options) + ` mbar·l/s`;
case LeakRateUnits.TorrLitersPerSecond:
return super.truncateFractionDigits(this.TorrLitersPerSecond, options) + ` Torr·l/s`;
default:
break;
}
return this.value.toString();
}
/**
* Get LeakRate unit abbreviation.
* Note! the default abbreviation for LeakRate is PascalCubicMetersPerSecond.
* To specify the unit abbreviation set the 'unitAbbreviation' parameter.
* @param unitAbbreviation The unit abbreviation of the LeakRate.
* @returns The abbreviation string of LeakRate.
*/
getUnitAbbreviation(unitAbbreviation = LeakRateUnits.PascalCubicMetersPerSecond) {
switch (unitAbbreviation) {
case LeakRateUnits.PascalCubicMetersPerSecond:
return `Pa·m³/s`;
case LeakRateUnits.MillibarLitersPerSecond:
return `mbar·l/s`;
case LeakRateUnits.TorrLitersPerSecond:
return `Torr·l/s`;
default:
break;
}
return '';
}
/**
* Check if the given LeakRate are equals to the current LeakRate.
* @param leakRate The other LeakRate.
* @returns True if the given LeakRate are equal to the current LeakRate.
*/
equals(leakRate) {
return super.internalEquals(this.value, leakRate.BaseValue);
}
/**
* Compare the given LeakRate against the current LeakRate.
* @param leakRate The other LeakRate.
* @returns 0 if they are equal, -1 if the current LeakRate is less then other, 1 if the current LeakRate is greater then other.
*/
compareTo(leakRate) {
return super.internalCompareTo(this.value, leakRate.BaseValue);
}
/**
* Add the given LeakRate with the current LeakRate.
* @param leakRate The other LeakRate.
* @returns A new LeakRate instance with the results.
*/
add(leakRate) {
return new LeakRate(super.internalAdd(this.value, leakRate.BaseValue));
}
/**
* Subtract the given LeakRate with the current LeakRate.
* @param leakRate The other LeakRate.
* @returns A new LeakRate instance with the results.
*/
subtract(leakRate) {
return new LeakRate(super.internalSubtract(this.value, leakRate.BaseValue));
}
/**
* Multiply the given LeakRate with the current LeakRate.
* @param leakRate The other LeakRate.
* @returns A new LeakRate instance with the results.
*/
multiply(leakRate) {
return new LeakRate(super.internalMultiply(this.value, leakRate.BaseValue));
}
/**
* Divide the given LeakRate with the current LeakRate.
* @param leakRate The other LeakRate.
* @returns A new LeakRate instance with the results.
*/
divide(leakRate) {
return new LeakRate(super.internalDivide(this.value, leakRate.BaseValue));
}
/**
* Modulo the given LeakRate with the current LeakRate.
* @param leakRate The other LeakRate.
* @returns A new LeakRate instance with the results.
*/
modulo(leakRate) {
return new LeakRate(super.internalModulo(this.value, leakRate.BaseValue));
}
/**
* Pow the given LeakRate with the current LeakRate.
* @param leakRate The other LeakRate.
* @returns A new LeakRate instance with the results.
*/
pow(leakRate) {
return new LeakRate(super.internalPow(this.value, leakRate.BaseValue));
}
}
exports.LeakRate = LeakRate;