unitsnet-js
Version:
A better way to hold unit variables and easily convert to the destination unit
223 lines (222 loc) • 9.34 kB
JavaScript
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.LuminousIntensity = exports.LuminousIntensityUnits = void 0;
const base_unit_1 = require("../base-unit");
/** LuminousIntensityUnits enumeration */
var LuminousIntensityUnits;
(function (LuminousIntensityUnits) {
/** */
LuminousIntensityUnits["Candela"] = "Candela";
})(LuminousIntensityUnits = exports.LuminousIntensityUnits || (exports.LuminousIntensityUnits = {}));
/** In photometry, luminous intensity is a measure of the wavelength-weighted power emitted by a light source in a particular direction per unit solid angle, based on the luminosity function, a standardized model of the sensitivity of the human eye. */
class LuminousIntensity extends base_unit_1.BaseUnit {
/**
* Create a new LuminousIntensity.
* @param value The value.
* @param fromUnit The ‘LuminousIntensity’ unit to create from.
* The default unit is Candela
*/
constructor(value, fromUnit = LuminousIntensityUnits.Candela) {
super();
this.candelaLazy = 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 LuminousIntensity is Candela.
* 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 LuminousIntensityUnits.Candela;
}
/** */
get Candela() {
if (this.candelaLazy !== null) {
return this.candelaLazy;
}
return this.candelaLazy = this.convertFromBase(LuminousIntensityUnits.Candela);
}
/**
* Create a new LuminousIntensity instance from a Candela
*
* @param value The unit as Candela to create a new LuminousIntensity from.
* @returns The new LuminousIntensity instance.
*/
static FromCandela(value) {
return new LuminousIntensity(value, LuminousIntensityUnits.Candela);
}
/**
* Gets the base unit enumeration associated with LuminousIntensity
* @returns The unit enumeration that can be used to interact with this type
*/
static getUnitEnum() {
return LuminousIntensityUnits;
}
/**
* 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 LuminousIntensityUnits.Candela;
}
/**
* Create API DTO represent a LuminousIntensity unit.
* @param holdInUnit The specific LuminousIntensity unit to be used in the unit representation at the DTO
*/
toDto(holdInUnit = LuminousIntensityUnits.Candela) {
return {
value: this.convert(holdInUnit),
unit: holdInUnit
};
}
/**
* Create a LuminousIntensity unit from an API DTO representation.
* @param dtoLuminousIntensity The LuminousIntensity API DTO representation
*/
static FromDto(dtoLuminousIntensity) {
return new LuminousIntensity(dtoLuminousIntensity.value, dtoLuminousIntensity.unit);
}
/**
* Convert LuminousIntensity 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 LuminousIntensityUnits.Candela: return this.Candela;
default:
break;
}
return Number.NaN;
}
convertFromBase(toUnit) {
if (base_unit_1.areAnyOperatorsOverridden())
switch (toUnit) {
case LuminousIntensityUnits.Candela: return this.value;
default: return Number.NaN;
}
switch (toUnit) {
case LuminousIntensityUnits.Candela: return this.value;
default: return Number.NaN;
}
}
convertToBase(value, fromUnit) {
if (base_unit_1.areAnyOperatorsOverridden())
switch (fromUnit) {
case LuminousIntensityUnits.Candela: return value;
default: return Number.NaN;
}
switch (fromUnit) {
case LuminousIntensityUnits.Candela: return value;
default: return Number.NaN;
}
}
/**
* Format the LuminousIntensity to string.
* Note! the default format for LuminousIntensity is Candela.
* To specify the unit format set the 'unit' parameter.
* @param unit The unit to format the LuminousIntensity.
* @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 LuminousIntensity.
*/
toString(unit = LuminousIntensityUnits.Candela, 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 LuminousIntensityUnits.Candela:
return super.truncateFractionDigits(this.Candela, options) + ` cd`;
default:
break;
}
return this.value.toString();
}
/**
* Get LuminousIntensity unit abbreviation.
* Note! the default abbreviation for LuminousIntensity is Candela.
* To specify the unit abbreviation set the 'unitAbbreviation' parameter.
* @param unitAbbreviation The unit abbreviation of the LuminousIntensity.
* @returns The abbreviation string of LuminousIntensity.
*/
getUnitAbbreviation(unitAbbreviation = LuminousIntensityUnits.Candela) {
switch (unitAbbreviation) {
case LuminousIntensityUnits.Candela:
return `cd`;
default:
break;
}
return '';
}
/**
* Check if the given LuminousIntensity are equals to the current LuminousIntensity.
* @param luminousIntensity The other LuminousIntensity.
* @returns True if the given LuminousIntensity are equal to the current LuminousIntensity.
*/
equals(luminousIntensity) {
return super.internalEquals(this.value, luminousIntensity.BaseValue);
}
/**
* Compare the given LuminousIntensity against the current LuminousIntensity.
* @param luminousIntensity The other LuminousIntensity.
* @returns 0 if they are equal, -1 if the current LuminousIntensity is less then other, 1 if the current LuminousIntensity is greater then other.
*/
compareTo(luminousIntensity) {
return super.internalCompareTo(this.value, luminousIntensity.BaseValue);
}
/**
* Add the given LuminousIntensity with the current LuminousIntensity.
* @param luminousIntensity The other LuminousIntensity.
* @returns A new LuminousIntensity instance with the results.
*/
add(luminousIntensity) {
return new LuminousIntensity(super.internalAdd(this.value, luminousIntensity.BaseValue));
}
/**
* Subtract the given LuminousIntensity with the current LuminousIntensity.
* @param luminousIntensity The other LuminousIntensity.
* @returns A new LuminousIntensity instance with the results.
*/
subtract(luminousIntensity) {
return new LuminousIntensity(super.internalSubtract(this.value, luminousIntensity.BaseValue));
}
/**
* Multiply the given LuminousIntensity with the current LuminousIntensity.
* @param luminousIntensity The other LuminousIntensity.
* @returns A new LuminousIntensity instance with the results.
*/
multiply(luminousIntensity) {
return new LuminousIntensity(super.internalMultiply(this.value, luminousIntensity.BaseValue));
}
/**
* Divide the given LuminousIntensity with the current LuminousIntensity.
* @param luminousIntensity The other LuminousIntensity.
* @returns A new LuminousIntensity instance with the results.
*/
divide(luminousIntensity) {
return new LuminousIntensity(super.internalDivide(this.value, luminousIntensity.BaseValue));
}
/**
* Modulo the given LuminousIntensity with the current LuminousIntensity.
* @param luminousIntensity The other LuminousIntensity.
* @returns A new LuminousIntensity instance with the results.
*/
modulo(luminousIntensity) {
return new LuminousIntensity(super.internalModulo(this.value, luminousIntensity.BaseValue));
}
/**
* Pow the given LuminousIntensity with the current LuminousIntensity.
* @param luminousIntensity The other LuminousIntensity.
* @returns A new LuminousIntensity instance with the results.
*/
pow(luminousIntensity) {
return new LuminousIntensity(super.internalPow(this.value, luminousIntensity.BaseValue));
}
}
exports.LuminousIntensity = LuminousIntensity;