unitsnet-js
Version:
A better way to hold unit variables and easily convert to the destination unit
479 lines (478 loc) • 22.6 kB
JavaScript
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.VolumePerLength = exports.VolumePerLengthUnits = void 0;
const base_unit_1 = require("../base-unit");
/** VolumePerLengthUnits enumeration */
var VolumePerLengthUnits;
(function (VolumePerLengthUnits) {
/** */
VolumePerLengthUnits["CubicMetersPerMeter"] = "CubicMeterPerMeter";
/** */
VolumePerLengthUnits["LitersPerMeter"] = "LiterPerMeter";
/** */
VolumePerLengthUnits["LitersPerKilometer"] = "LiterPerKilometer";
/** */
VolumePerLengthUnits["LitersPerMillimeter"] = "LiterPerMillimeter";
/** */
VolumePerLengthUnits["OilBarrelsPerFoot"] = "OilBarrelPerFoot";
/** */
VolumePerLengthUnits["CubicYardsPerFoot"] = "CubicYardPerFoot";
/** */
VolumePerLengthUnits["CubicYardsPerUsSurveyFoot"] = "CubicYardPerUsSurveyFoot";
/** */
VolumePerLengthUnits["UsGallonsPerMile"] = "UsGallonPerMile";
/** */
VolumePerLengthUnits["ImperialGallonsPerMile"] = "ImperialGallonPerMile";
})(VolumePerLengthUnits = exports.VolumePerLengthUnits || (exports.VolumePerLengthUnits = {}));
/** Volume, typically of fluid, that a container can hold within a unit of length. */
class VolumePerLength extends base_unit_1.BaseUnit {
/**
* Create a new VolumePerLength.
* @param value The value.
* @param fromUnit The ‘VolumePerLength’ unit to create from.
* The default unit is CubicMetersPerMeter
*/
constructor(value, fromUnit = VolumePerLengthUnits.CubicMetersPerMeter) {
super();
this.cubicmeterspermeterLazy = null;
this.literspermeterLazy = null;
this.litersperkilometerLazy = null;
this.literspermillimeterLazy = null;
this.oilbarrelsperfootLazy = null;
this.cubicyardsperfootLazy = null;
this.cubicyardsperussurveyfootLazy = null;
this.usgallonspermileLazy = null;
this.imperialgallonspermileLazy = 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 VolumePerLength is CubicMetersPerMeter.
* 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 VolumePerLengthUnits.CubicMetersPerMeter;
}
/** */
get CubicMetersPerMeter() {
if (this.cubicmeterspermeterLazy !== null) {
return this.cubicmeterspermeterLazy;
}
return this.cubicmeterspermeterLazy = this.convertFromBase(VolumePerLengthUnits.CubicMetersPerMeter);
}
/** */
get LitersPerMeter() {
if (this.literspermeterLazy !== null) {
return this.literspermeterLazy;
}
return this.literspermeterLazy = this.convertFromBase(VolumePerLengthUnits.LitersPerMeter);
}
/** */
get LitersPerKilometer() {
if (this.litersperkilometerLazy !== null) {
return this.litersperkilometerLazy;
}
return this.litersperkilometerLazy = this.convertFromBase(VolumePerLengthUnits.LitersPerKilometer);
}
/** */
get LitersPerMillimeter() {
if (this.literspermillimeterLazy !== null) {
return this.literspermillimeterLazy;
}
return this.literspermillimeterLazy = this.convertFromBase(VolumePerLengthUnits.LitersPerMillimeter);
}
/** */
get OilBarrelsPerFoot() {
if (this.oilbarrelsperfootLazy !== null) {
return this.oilbarrelsperfootLazy;
}
return this.oilbarrelsperfootLazy = this.convertFromBase(VolumePerLengthUnits.OilBarrelsPerFoot);
}
/** */
get CubicYardsPerFoot() {
if (this.cubicyardsperfootLazy !== null) {
return this.cubicyardsperfootLazy;
}
return this.cubicyardsperfootLazy = this.convertFromBase(VolumePerLengthUnits.CubicYardsPerFoot);
}
/** */
get CubicYardsPerUsSurveyFoot() {
if (this.cubicyardsperussurveyfootLazy !== null) {
return this.cubicyardsperussurveyfootLazy;
}
return this.cubicyardsperussurveyfootLazy = this.convertFromBase(VolumePerLengthUnits.CubicYardsPerUsSurveyFoot);
}
/** */
get UsGallonsPerMile() {
if (this.usgallonspermileLazy !== null) {
return this.usgallonspermileLazy;
}
return this.usgallonspermileLazy = this.convertFromBase(VolumePerLengthUnits.UsGallonsPerMile);
}
/** */
get ImperialGallonsPerMile() {
if (this.imperialgallonspermileLazy !== null) {
return this.imperialgallonspermileLazy;
}
return this.imperialgallonspermileLazy = this.convertFromBase(VolumePerLengthUnits.ImperialGallonsPerMile);
}
/**
* Create a new VolumePerLength instance from a CubicMetersPerMeter
*
* @param value The unit as CubicMetersPerMeter to create a new VolumePerLength from.
* @returns The new VolumePerLength instance.
*/
static FromCubicMetersPerMeter(value) {
return new VolumePerLength(value, VolumePerLengthUnits.CubicMetersPerMeter);
}
/**
* Create a new VolumePerLength instance from a LitersPerMeter
*
* @param value The unit as LitersPerMeter to create a new VolumePerLength from.
* @returns The new VolumePerLength instance.
*/
static FromLitersPerMeter(value) {
return new VolumePerLength(value, VolumePerLengthUnits.LitersPerMeter);
}
/**
* Create a new VolumePerLength instance from a LitersPerKilometer
*
* @param value The unit as LitersPerKilometer to create a new VolumePerLength from.
* @returns The new VolumePerLength instance.
*/
static FromLitersPerKilometer(value) {
return new VolumePerLength(value, VolumePerLengthUnits.LitersPerKilometer);
}
/**
* Create a new VolumePerLength instance from a LitersPerMillimeter
*
* @param value The unit as LitersPerMillimeter to create a new VolumePerLength from.
* @returns The new VolumePerLength instance.
*/
static FromLitersPerMillimeter(value) {
return new VolumePerLength(value, VolumePerLengthUnits.LitersPerMillimeter);
}
/**
* Create a new VolumePerLength instance from a OilBarrelsPerFoot
*
* @param value The unit as OilBarrelsPerFoot to create a new VolumePerLength from.
* @returns The new VolumePerLength instance.
*/
static FromOilBarrelsPerFoot(value) {
return new VolumePerLength(value, VolumePerLengthUnits.OilBarrelsPerFoot);
}
/**
* Create a new VolumePerLength instance from a CubicYardsPerFoot
*
* @param value The unit as CubicYardsPerFoot to create a new VolumePerLength from.
* @returns The new VolumePerLength instance.
*/
static FromCubicYardsPerFoot(value) {
return new VolumePerLength(value, VolumePerLengthUnits.CubicYardsPerFoot);
}
/**
* Create a new VolumePerLength instance from a CubicYardsPerUsSurveyFoot
*
* @param value The unit as CubicYardsPerUsSurveyFoot to create a new VolumePerLength from.
* @returns The new VolumePerLength instance.
*/
static FromCubicYardsPerUsSurveyFoot(value) {
return new VolumePerLength(value, VolumePerLengthUnits.CubicYardsPerUsSurveyFoot);
}
/**
* Create a new VolumePerLength instance from a UsGallonsPerMile
*
* @param value The unit as UsGallonsPerMile to create a new VolumePerLength from.
* @returns The new VolumePerLength instance.
*/
static FromUsGallonsPerMile(value) {
return new VolumePerLength(value, VolumePerLengthUnits.UsGallonsPerMile);
}
/**
* Create a new VolumePerLength instance from a ImperialGallonsPerMile
*
* @param value The unit as ImperialGallonsPerMile to create a new VolumePerLength from.
* @returns The new VolumePerLength instance.
*/
static FromImperialGallonsPerMile(value) {
return new VolumePerLength(value, VolumePerLengthUnits.ImperialGallonsPerMile);
}
/**
* Gets the base unit enumeration associated with VolumePerLength
* @returns The unit enumeration that can be used to interact with this type
*/
static getUnitEnum() {
return VolumePerLengthUnits;
}
/**
* 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 VolumePerLengthUnits.CubicMetersPerMeter;
}
/**
* Create API DTO represent a VolumePerLength unit.
* @param holdInUnit The specific VolumePerLength unit to be used in the unit representation at the DTO
*/
toDto(holdInUnit = VolumePerLengthUnits.CubicMetersPerMeter) {
return {
value: this.convert(holdInUnit),
unit: holdInUnit
};
}
/**
* Create a VolumePerLength unit from an API DTO representation.
* @param dtoVolumePerLength The VolumePerLength API DTO representation
*/
static FromDto(dtoVolumePerLength) {
return new VolumePerLength(dtoVolumePerLength.value, dtoVolumePerLength.unit);
}
/**
* Convert VolumePerLength 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 VolumePerLengthUnits.CubicMetersPerMeter: return this.CubicMetersPerMeter;
case VolumePerLengthUnits.LitersPerMeter: return this.LitersPerMeter;
case VolumePerLengthUnits.LitersPerKilometer: return this.LitersPerKilometer;
case VolumePerLengthUnits.LitersPerMillimeter: return this.LitersPerMillimeter;
case VolumePerLengthUnits.OilBarrelsPerFoot: return this.OilBarrelsPerFoot;
case VolumePerLengthUnits.CubicYardsPerFoot: return this.CubicYardsPerFoot;
case VolumePerLengthUnits.CubicYardsPerUsSurveyFoot: return this.CubicYardsPerUsSurveyFoot;
case VolumePerLengthUnits.UsGallonsPerMile: return this.UsGallonsPerMile;
case VolumePerLengthUnits.ImperialGallonsPerMile: return this.ImperialGallonsPerMile;
default:
break;
}
return Number.NaN;
}
convertFromBase(toUnit) {
if (base_unit_1.areAnyOperatorsOverridden())
switch (toUnit) {
case VolumePerLengthUnits.CubicMetersPerMeter: return this.value;
case VolumePerLengthUnits.LitersPerMeter: return super.internalMultiply(this.value, 1000);
case VolumePerLengthUnits.LitersPerKilometer: return super.internalMultiply(this.value, 1e6);
case VolumePerLengthUnits.LitersPerMillimeter: return this.value;
case VolumePerLengthUnits.OilBarrelsPerFoot: {
const v4 = super.internalDivide(0.3048, 0.158987294928);
return super.internalMultiply(this.value, v4);
}
case VolumePerLengthUnits.CubicYardsPerFoot: {
const v4 = super.internalDivide(0.3048, 0.764554857984);
return super.internalMultiply(this.value, v4);
}
case VolumePerLengthUnits.CubicYardsPerUsSurveyFoot: {
const v5 = super.internalMultiply(0.764554857984, 3937);
const v6 = super.internalDivide(1200, v5);
return super.internalMultiply(this.value, v6);
}
case VolumePerLengthUnits.UsGallonsPerMile: {
const v4 = super.internalDivide(1609.344, 0.003785411784);
return super.internalMultiply(this.value, v4);
}
case VolumePerLengthUnits.ImperialGallonsPerMile: {
const v4 = super.internalDivide(1609.344, 0.00454609);
return super.internalMultiply(this.value, v4);
}
default: return Number.NaN;
}
switch (toUnit) {
case VolumePerLengthUnits.CubicMetersPerMeter: return this.value;
case VolumePerLengthUnits.LitersPerMeter: return this.value * 1000;
case VolumePerLengthUnits.LitersPerKilometer: return this.value * 1e6;
case VolumePerLengthUnits.LitersPerMillimeter: return this.value;
case VolumePerLengthUnits.OilBarrelsPerFoot: return this.value * 0.3048 / 0.158987294928;
case VolumePerLengthUnits.CubicYardsPerFoot: return this.value * 0.3048 / 0.764554857984;
case VolumePerLengthUnits.CubicYardsPerUsSurveyFoot: return this.value * 1200 / (0.764554857984 * 3937);
case VolumePerLengthUnits.UsGallonsPerMile: return this.value * 1609.344 / 0.003785411784;
case VolumePerLengthUnits.ImperialGallonsPerMile: return this.value * 1609.344 / 0.00454609;
default: return Number.NaN;
}
}
convertToBase(value, fromUnit) {
if (base_unit_1.areAnyOperatorsOverridden())
switch (fromUnit) {
case VolumePerLengthUnits.CubicMetersPerMeter: return value;
case VolumePerLengthUnits.LitersPerMeter: return super.internalDivide(value, 1000);
case VolumePerLengthUnits.LitersPerKilometer: return super.internalDivide(value, 1e6);
case VolumePerLengthUnits.LitersPerMillimeter: return value;
case VolumePerLengthUnits.OilBarrelsPerFoot: {
const v4 = super.internalDivide(0.158987294928, 0.3048);
return super.internalMultiply(value, v4);
}
case VolumePerLengthUnits.CubicYardsPerFoot: {
const v4 = super.internalDivide(0.764554857984, 0.3048);
return super.internalMultiply(value, v4);
}
case VolumePerLengthUnits.CubicYardsPerUsSurveyFoot: {
const v3 = super.internalMultiply(value, 0.764554857984);
const v6 = super.internalDivide(3937, 1200);
return super.internalMultiply(v3, v6);
}
case VolumePerLengthUnits.UsGallonsPerMile: {
const v4 = super.internalDivide(0.003785411784, 1609.344);
return super.internalMultiply(value, v4);
}
case VolumePerLengthUnits.ImperialGallonsPerMile: {
const v4 = super.internalDivide(0.00454609, 1609.344);
return super.internalMultiply(value, v4);
}
default: return Number.NaN;
}
switch (fromUnit) {
case VolumePerLengthUnits.CubicMetersPerMeter: return value;
case VolumePerLengthUnits.LitersPerMeter: return value / 1000;
case VolumePerLengthUnits.LitersPerKilometer: return value / 1e6;
case VolumePerLengthUnits.LitersPerMillimeter: return value;
case VolumePerLengthUnits.OilBarrelsPerFoot: return value * 0.158987294928 / 0.3048;
case VolumePerLengthUnits.CubicYardsPerFoot: return value * 0.764554857984 / 0.3048;
case VolumePerLengthUnits.CubicYardsPerUsSurveyFoot: return value * 0.764554857984 * 3937 / 1200;
case VolumePerLengthUnits.UsGallonsPerMile: return value * 0.003785411784 / 1609.344;
case VolumePerLengthUnits.ImperialGallonsPerMile: return value * 0.00454609 / 1609.344;
default: return Number.NaN;
}
}
/**
* Format the VolumePerLength to string.
* Note! the default format for VolumePerLength is CubicMetersPerMeter.
* To specify the unit format set the 'unit' parameter.
* @param unit The unit to format the VolumePerLength.
* @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 VolumePerLength.
*/
toString(unit = VolumePerLengthUnits.CubicMetersPerMeter, 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 VolumePerLengthUnits.CubicMetersPerMeter:
return super.truncateFractionDigits(this.CubicMetersPerMeter, options) + ` m³/m`;
case VolumePerLengthUnits.LitersPerMeter:
return super.truncateFractionDigits(this.LitersPerMeter, options) + ` l/m`;
case VolumePerLengthUnits.LitersPerKilometer:
return super.truncateFractionDigits(this.LitersPerKilometer, options) + ` l/km`;
case VolumePerLengthUnits.LitersPerMillimeter:
return super.truncateFractionDigits(this.LitersPerMillimeter, options) + ` l/mm`;
case VolumePerLengthUnits.OilBarrelsPerFoot:
return super.truncateFractionDigits(this.OilBarrelsPerFoot, options) + ` bbl/ft`;
case VolumePerLengthUnits.CubicYardsPerFoot:
return super.truncateFractionDigits(this.CubicYardsPerFoot, options) + ` yd³/ft`;
case VolumePerLengthUnits.CubicYardsPerUsSurveyFoot:
return super.truncateFractionDigits(this.CubicYardsPerUsSurveyFoot, options) + ` yd³/ftUS`;
case VolumePerLengthUnits.UsGallonsPerMile:
return super.truncateFractionDigits(this.UsGallonsPerMile, options) + ` gal (U.S.)/mi`;
case VolumePerLengthUnits.ImperialGallonsPerMile:
return super.truncateFractionDigits(this.ImperialGallonsPerMile, options) + ` gal (imp.)/mi`;
default:
break;
}
return this.value.toString();
}
/**
* Get VolumePerLength unit abbreviation.
* Note! the default abbreviation for VolumePerLength is CubicMetersPerMeter.
* To specify the unit abbreviation set the 'unitAbbreviation' parameter.
* @param unitAbbreviation The unit abbreviation of the VolumePerLength.
* @returns The abbreviation string of VolumePerLength.
*/
getUnitAbbreviation(unitAbbreviation = VolumePerLengthUnits.CubicMetersPerMeter) {
switch (unitAbbreviation) {
case VolumePerLengthUnits.CubicMetersPerMeter:
return `m³/m`;
case VolumePerLengthUnits.LitersPerMeter:
return `l/m`;
case VolumePerLengthUnits.LitersPerKilometer:
return `l/km`;
case VolumePerLengthUnits.LitersPerMillimeter:
return `l/mm`;
case VolumePerLengthUnits.OilBarrelsPerFoot:
return `bbl/ft`;
case VolumePerLengthUnits.CubicYardsPerFoot:
return `yd³/ft`;
case VolumePerLengthUnits.CubicYardsPerUsSurveyFoot:
return `yd³/ftUS`;
case VolumePerLengthUnits.UsGallonsPerMile:
return `gal (U.S.)/mi`;
case VolumePerLengthUnits.ImperialGallonsPerMile:
return `gal (imp.)/mi`;
default:
break;
}
return '';
}
/**
* Check if the given VolumePerLength are equals to the current VolumePerLength.
* @param volumePerLength The other VolumePerLength.
* @returns True if the given VolumePerLength are equal to the current VolumePerLength.
*/
equals(volumePerLength) {
return super.internalEquals(this.value, volumePerLength.BaseValue);
}
/**
* Compare the given VolumePerLength against the current VolumePerLength.
* @param volumePerLength The other VolumePerLength.
* @returns 0 if they are equal, -1 if the current VolumePerLength is less then other, 1 if the current VolumePerLength is greater then other.
*/
compareTo(volumePerLength) {
return super.internalCompareTo(this.value, volumePerLength.BaseValue);
}
/**
* Add the given VolumePerLength with the current VolumePerLength.
* @param volumePerLength The other VolumePerLength.
* @returns A new VolumePerLength instance with the results.
*/
add(volumePerLength) {
return new VolumePerLength(super.internalAdd(this.value, volumePerLength.BaseValue));
}
/**
* Subtract the given VolumePerLength with the current VolumePerLength.
* @param volumePerLength The other VolumePerLength.
* @returns A new VolumePerLength instance with the results.
*/
subtract(volumePerLength) {
return new VolumePerLength(super.internalSubtract(this.value, volumePerLength.BaseValue));
}
/**
* Multiply the given VolumePerLength with the current VolumePerLength.
* @param volumePerLength The other VolumePerLength.
* @returns A new VolumePerLength instance with the results.
*/
multiply(volumePerLength) {
return new VolumePerLength(super.internalMultiply(this.value, volumePerLength.BaseValue));
}
/**
* Divide the given VolumePerLength with the current VolumePerLength.
* @param volumePerLength The other VolumePerLength.
* @returns A new VolumePerLength instance with the results.
*/
divide(volumePerLength) {
return new VolumePerLength(super.internalDivide(this.value, volumePerLength.BaseValue));
}
/**
* Modulo the given VolumePerLength with the current VolumePerLength.
* @param volumePerLength The other VolumePerLength.
* @returns A new VolumePerLength instance with the results.
*/
modulo(volumePerLength) {
return new VolumePerLength(super.internalModulo(this.value, volumePerLength.BaseValue));
}
/**
* Pow the given VolumePerLength with the current VolumePerLength.
* @param volumePerLength The other VolumePerLength.
* @returns A new VolumePerLength instance with the results.
*/
pow(volumePerLength) {
return new VolumePerLength(super.internalPow(this.value, volumePerLength.BaseValue));
}
}
exports.VolumePerLength = VolumePerLength;