unitsnet-js/dist/gen-units/electricpotentialdc.g.js

A better way to hold unit variables and easily convert to the destination unit

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.ElectricPotentialDc = exports.ElectricPotentialDcUnits = void 0;
const base_unit_1 = require("../base-unit");
/** ElectricPotentialDcUnits enumeration */
var ElectricPotentialDcUnits;
(function (ElectricPotentialDcUnits) {
    /** */
    ElectricPotentialDcUnits["VoltsDc"] = "VoltDc";
    /** */
    ElectricPotentialDcUnits["MicrovoltsDc"] = "MicrovoltDc";
    /** */
    ElectricPotentialDcUnits["MillivoltsDc"] = "MillivoltDc";
    /** */
    ElectricPotentialDcUnits["KilovoltsDc"] = "KilovoltDc";
    /** */
    ElectricPotentialDcUnits["MegavoltsDc"] = "MegavoltDc";
})(ElectricPotentialDcUnits = exports.ElectricPotentialDcUnits || (exports.ElectricPotentialDcUnits = {}));
/** The Electric Potential of a system known to use Direct Current. */
class ElectricPotentialDc extends base_unit_1.BaseUnit {
    /**
     * Create a new ElectricPotentialDc.
     * @param value The value.
     * @param fromUnit The ‘ElectricPotentialDc’ unit to create from.
     * The default unit is VoltsDc
     */
    constructor(value, fromUnit = ElectricPotentialDcUnits.VoltsDc) {
        super();
        this.voltsdcLazy = null;
        this.microvoltsdcLazy = null;
        this.millivoltsdcLazy = null;
        this.kilovoltsdcLazy = null;
        this.megavoltsdcLazy = 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 ElectricPotentialDc is VoltsDc.
     * 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 ElectricPotentialDcUnits.VoltsDc;
    }
    /** */
    get VoltsDc() {
        if (this.voltsdcLazy !== null) {
            return this.voltsdcLazy;
        }
        return this.voltsdcLazy = this.convertFromBase(ElectricPotentialDcUnits.VoltsDc);
    }
    /** */
    get MicrovoltsDc() {
        if (this.microvoltsdcLazy !== null) {
            return this.microvoltsdcLazy;
        }
        return this.microvoltsdcLazy = this.convertFromBase(ElectricPotentialDcUnits.MicrovoltsDc);
    }
    /** */
    get MillivoltsDc() {
        if (this.millivoltsdcLazy !== null) {
            return this.millivoltsdcLazy;
        }
        return this.millivoltsdcLazy = this.convertFromBase(ElectricPotentialDcUnits.MillivoltsDc);
    }
    /** */
    get KilovoltsDc() {
        if (this.kilovoltsdcLazy !== null) {
            return this.kilovoltsdcLazy;
        }
        return this.kilovoltsdcLazy = this.convertFromBase(ElectricPotentialDcUnits.KilovoltsDc);
    }
    /** */
    get MegavoltsDc() {
        if (this.megavoltsdcLazy !== null) {
            return this.megavoltsdcLazy;
        }
        return this.megavoltsdcLazy = this.convertFromBase(ElectricPotentialDcUnits.MegavoltsDc);
    }
    /**
     * Create a new ElectricPotentialDc instance from a VoltsDc
     *
     * @param value The unit as VoltsDc to create a new ElectricPotentialDc from.
     * @returns The new ElectricPotentialDc instance.
     */
    static FromVoltsDc(value) {
        return new ElectricPotentialDc(value, ElectricPotentialDcUnits.VoltsDc);
    }
    /**
     * Create a new ElectricPotentialDc instance from a MicrovoltsDc
     *
     * @param value The unit as MicrovoltsDc to create a new ElectricPotentialDc from.
     * @returns The new ElectricPotentialDc instance.
     */
    static FromMicrovoltsDc(value) {
        return new ElectricPotentialDc(value, ElectricPotentialDcUnits.MicrovoltsDc);
    }
    /**
     * Create a new ElectricPotentialDc instance from a MillivoltsDc
     *
     * @param value The unit as MillivoltsDc to create a new ElectricPotentialDc from.
     * @returns The new ElectricPotentialDc instance.
     */
    static FromMillivoltsDc(value) {
        return new ElectricPotentialDc(value, ElectricPotentialDcUnits.MillivoltsDc);
    }
    /**
     * Create a new ElectricPotentialDc instance from a KilovoltsDc
     *
     * @param value The unit as KilovoltsDc to create a new ElectricPotentialDc from.
     * @returns The new ElectricPotentialDc instance.
     */
    static FromKilovoltsDc(value) {
        return new ElectricPotentialDc(value, ElectricPotentialDcUnits.KilovoltsDc);
    }
    /**
     * Create a new ElectricPotentialDc instance from a MegavoltsDc
     *
     * @param value The unit as MegavoltsDc to create a new ElectricPotentialDc from.
     * @returns The new ElectricPotentialDc instance.
     */
    static FromMegavoltsDc(value) {
        return new ElectricPotentialDc(value, ElectricPotentialDcUnits.MegavoltsDc);
    }
    /**
     * Gets the base unit enumeration associated with ElectricPotentialDc
     * @returns The unit enumeration that can be used to interact with this type
     */
    static getUnitEnum() {
        return ElectricPotentialDcUnits;
    }
    /**
     * 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 ElectricPotentialDcUnits.VoltsDc;
    }
    /**
     * Create API DTO represent a ElectricPotentialDc unit.
     * @param holdInUnit The specific ElectricPotentialDc unit to be used in the unit representation at the DTO
     */
    toDto(holdInUnit = ElectricPotentialDcUnits.VoltsDc) {
        return {
            value: this.convert(holdInUnit),
            unit: holdInUnit
        };
    }
    /**
     * Create a ElectricPotentialDc unit from an API DTO representation.
     * @param dtoElectricPotentialDc The ElectricPotentialDc API DTO representation
     */
    static FromDto(dtoElectricPotentialDc) {
        return new ElectricPotentialDc(dtoElectricPotentialDc.value, dtoElectricPotentialDc.unit);
    }
    /**
     * Convert ElectricPotentialDc 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 ElectricPotentialDcUnits.VoltsDc: return this.VoltsDc;
            case ElectricPotentialDcUnits.MicrovoltsDc: return this.MicrovoltsDc;
            case ElectricPotentialDcUnits.MillivoltsDc: return this.MillivoltsDc;
            case ElectricPotentialDcUnits.KilovoltsDc: return this.KilovoltsDc;
            case ElectricPotentialDcUnits.MegavoltsDc: return this.MegavoltsDc;
            default:
                break;
        }
        return Number.NaN;
    }
    convertFromBase(toUnit) {
        if (base_unit_1.areAnyOperatorsOverridden())
            switch (toUnit) {
                case ElectricPotentialDcUnits.VoltsDc: return this.value;
                case ElectricPotentialDcUnits.MicrovoltsDc: return super.internalDivide(this.value, 0.000001);
                case ElectricPotentialDcUnits.MillivoltsDc: return super.internalDivide(this.value, 0.001);
                case ElectricPotentialDcUnits.KilovoltsDc: return super.internalDivide(this.value, 1000);
                case ElectricPotentialDcUnits.MegavoltsDc: return super.internalDivide(this.value, 1000000);
                default: return Number.NaN;
            }
        switch (toUnit) {
            case ElectricPotentialDcUnits.VoltsDc: return this.value;
            case ElectricPotentialDcUnits.MicrovoltsDc: return (this.value) / 0.000001;
            case ElectricPotentialDcUnits.MillivoltsDc: return (this.value) / 0.001;
            case ElectricPotentialDcUnits.KilovoltsDc: return (this.value) / 1000;
            case ElectricPotentialDcUnits.MegavoltsDc: return (this.value) / 1000000;
            default: return Number.NaN;
        }
    }
    convertToBase(value, fromUnit) {
        if (base_unit_1.areAnyOperatorsOverridden())
            switch (fromUnit) {
                case ElectricPotentialDcUnits.VoltsDc: return value;
                case ElectricPotentialDcUnits.MicrovoltsDc: return super.internalMultiply(value, 0.000001);
                case ElectricPotentialDcUnits.MillivoltsDc: return super.internalMultiply(value, 0.001);
                case ElectricPotentialDcUnits.KilovoltsDc: return super.internalMultiply(value, 1000);
                case ElectricPotentialDcUnits.MegavoltsDc: return super.internalMultiply(value, 1000000);
                default: return Number.NaN;
            }
        switch (fromUnit) {
            case ElectricPotentialDcUnits.VoltsDc: return value;
            case ElectricPotentialDcUnits.MicrovoltsDc: return (value) * 0.000001;
            case ElectricPotentialDcUnits.MillivoltsDc: return (value) * 0.001;
            case ElectricPotentialDcUnits.KilovoltsDc: return (value) * 1000;
            case ElectricPotentialDcUnits.MegavoltsDc: return (value) * 1000000;
            default: return Number.NaN;
        }
    }
    /**
     * Format the ElectricPotentialDc to string.
     * Note! the default format for ElectricPotentialDc is VoltsDc.
     * To specify the unit format set the 'unit' parameter.
     * @param unit The unit to format the ElectricPotentialDc.
     * @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 ElectricPotentialDc.
     */
    toString(unit = ElectricPotentialDcUnits.VoltsDc, 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 ElectricPotentialDcUnits.VoltsDc:
                return super.truncateFractionDigits(this.VoltsDc, options) + ` Vdc`;
            case ElectricPotentialDcUnits.MicrovoltsDc:
                return super.truncateFractionDigits(this.MicrovoltsDc, options) + ` μVdc`;
            case ElectricPotentialDcUnits.MillivoltsDc:
                return super.truncateFractionDigits(this.MillivoltsDc, options) + ` mVdc`;
            case ElectricPotentialDcUnits.KilovoltsDc:
                return super.truncateFractionDigits(this.KilovoltsDc, options) + ` kVdc`;
            case ElectricPotentialDcUnits.MegavoltsDc:
                return super.truncateFractionDigits(this.MegavoltsDc, options) + ` MVdc`;
            default:
                break;
        }
        return this.value.toString();
    }
    /**
     * Get ElectricPotentialDc unit abbreviation.
     * Note! the default abbreviation for ElectricPotentialDc is VoltsDc.
     * To specify the unit abbreviation set the 'unitAbbreviation' parameter.
     * @param unitAbbreviation The unit abbreviation of the ElectricPotentialDc.
     * @returns The abbreviation string of ElectricPotentialDc.
     */
    getUnitAbbreviation(unitAbbreviation = ElectricPotentialDcUnits.VoltsDc) {
        switch (unitAbbreviation) {
            case ElectricPotentialDcUnits.VoltsDc:
                return `Vdc`;
            case ElectricPotentialDcUnits.MicrovoltsDc:
                return `μVdc`;
            case ElectricPotentialDcUnits.MillivoltsDc:
                return `mVdc`;
            case ElectricPotentialDcUnits.KilovoltsDc:
                return `kVdc`;
            case ElectricPotentialDcUnits.MegavoltsDc:
                return `MVdc`;
            default:
                break;
        }
        return '';
    }
    /**
     * Check if the given ElectricPotentialDc are equals to the current ElectricPotentialDc.
     * @param electricPotentialDc The other ElectricPotentialDc.
     * @returns True if the given ElectricPotentialDc are equal to the current ElectricPotentialDc.
     */
    equals(electricPotentialDc) {
        return super.internalEquals(this.value, electricPotentialDc.BaseValue);
    }
    /**
     * Compare the given ElectricPotentialDc against the current ElectricPotentialDc.
     * @param electricPotentialDc The other ElectricPotentialDc.
     * @returns 0 if they are equal, -1 if the current ElectricPotentialDc is less then other, 1 if the current ElectricPotentialDc is greater then other.
     */
    compareTo(electricPotentialDc) {
        return super.internalCompareTo(this.value, electricPotentialDc.BaseValue);
    }
    /**
     * Add the given ElectricPotentialDc with the current ElectricPotentialDc.
     * @param electricPotentialDc The other ElectricPotentialDc.
     * @returns A new ElectricPotentialDc instance with the results.
     */
    add(electricPotentialDc) {
        return new ElectricPotentialDc(super.internalAdd(this.value, electricPotentialDc.BaseValue));
    }
    /**
     * Subtract the given ElectricPotentialDc with the current ElectricPotentialDc.
     * @param electricPotentialDc The other ElectricPotentialDc.
     * @returns A new ElectricPotentialDc instance with the results.
     */
    subtract(electricPotentialDc) {
        return new ElectricPotentialDc(super.internalSubtract(this.value, electricPotentialDc.BaseValue));
    }
    /**
     * Multiply the given ElectricPotentialDc with the current ElectricPotentialDc.
     * @param electricPotentialDc The other ElectricPotentialDc.
     * @returns A new ElectricPotentialDc instance with the results.
     */
    multiply(electricPotentialDc) {
        return new ElectricPotentialDc(super.internalMultiply(this.value, electricPotentialDc.BaseValue));
    }
    /**
     * Divide the given ElectricPotentialDc with the current ElectricPotentialDc.
     * @param electricPotentialDc The other ElectricPotentialDc.
     * @returns A new ElectricPotentialDc instance with the results.
     */
    divide(electricPotentialDc) {
        return new ElectricPotentialDc(super.internalDivide(this.value, electricPotentialDc.BaseValue));
    }
    /**
     * Modulo the given ElectricPotentialDc with the current ElectricPotentialDc.
     * @param electricPotentialDc The other ElectricPotentialDc.
     * @returns A new ElectricPotentialDc instance with the results.
     */
    modulo(electricPotentialDc) {
        return new ElectricPotentialDc(super.internalModulo(this.value, electricPotentialDc.BaseValue));
    }
    /**
     * Pow the given ElectricPotentialDc with the current ElectricPotentialDc.
     * @param electricPotentialDc The other ElectricPotentialDc.
     * @returns A new ElectricPotentialDc instance with the results.
     */
    pow(electricPotentialDc) {
        return new ElectricPotentialDc(super.internalPow(this.value, electricPotentialDc.BaseValue));
    }
}
exports.ElectricPotentialDc = ElectricPotentialDc;