UNPKG

unitsnet-js

Version:

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

207 lines (206 loc) 10.4 kB
import { BaseUnit, ToStringOptions } from "../base-unit"; /** API DTO represents a ThermalInsulance */ export interface ThermalInsulanceDto { /** The value of the ThermalInsulance */ value: number; /** The specific unit that the ThermalInsulance value is representing */ unit: ThermalInsulanceUnits; } /** ThermalInsulanceUnits enumeration */ export declare enum ThermalInsulanceUnits { /** */ SquareMeterKelvinsPerKilowatt = "SquareMeterKelvinPerKilowatt", /** */ SquareMeterKelvinsPerWatt = "SquareMeterKelvinPerWatt", /** */ SquareMeterDegreesCelsiusPerWatt = "SquareMeterDegreeCelsiusPerWatt", /** */ SquareCentimeterKelvinsPerWatt = "SquareCentimeterKelvinPerWatt", /** */ SquareMillimeterKelvinsPerWatt = "SquareMillimeterKelvinPerWatt", /** */ SquareCentimeterHourDegreesCelsiusPerKilocalorie = "SquareCentimeterHourDegreeCelsiusPerKilocalorie", /** */ HourSquareFeetDegreesFahrenheitPerBtu = "HourSquareFeetDegreeFahrenheitPerBtu" } /** Thermal insulance (R-value) is a measure of a material's resistance to the heat current. It quantifies how effectively a material can resist the transfer of heat through conduction, convection, and radiation. It has the units square metre kelvins per watt (m2⋅K/W) in SI units or square foot degree Fahrenheit–hours per British thermal unit (ft2⋅°F⋅h/Btu) in imperial units. The higher the thermal insulance, the better a material insulates against heat transfer. It is commonly used in construction to assess the insulation properties of materials such as walls, roofs, and insulation products. */ export declare class ThermalInsulance extends BaseUnit { protected value: number; private squaremeterkelvinsperkilowattLazy; private squaremeterkelvinsperwattLazy; private squaremeterdegreescelsiusperwattLazy; private squarecentimeterkelvinsperwattLazy; private squaremillimeterkelvinsperwattLazy; private squarecentimeterhourdegreescelsiusperkilocalorieLazy; private hoursquarefeetdegreesfahrenheitperbtuLazy; /** * Create a new ThermalInsulance. * @param value The value. * @param fromUnit The ‘ThermalInsulance’ unit to create from. * The default unit is SquareMeterKelvinsPerKilowatt */ constructor(value: number, fromUnit?: ThermalInsulanceUnits); /** * The base value of ThermalInsulance is SquareMeterKelvinsPerKilowatt. * This accessor used when needs a value for calculations and it's better to use directly the base value */ get BaseValue(): number; /** Gets the default unit used when creating instances of the unit or its DTO */ protected get baseUnit(): ThermalInsulanceUnits.SquareMeterKelvinsPerKilowatt; /** */ get SquareMeterKelvinsPerKilowatt(): number; /** */ get SquareMeterKelvinsPerWatt(): number; /** */ get SquareMeterDegreesCelsiusPerWatt(): number; /** */ get SquareCentimeterKelvinsPerWatt(): number; /** */ get SquareMillimeterKelvinsPerWatt(): number; /** */ get SquareCentimeterHourDegreesCelsiusPerKilocalorie(): number; /** */ get HourSquareFeetDegreesFahrenheitPerBtu(): number; /** * Create a new ThermalInsulance instance from a SquareMeterKelvinsPerKilowatt * * @param value The unit as SquareMeterKelvinsPerKilowatt to create a new ThermalInsulance from. * @returns The new ThermalInsulance instance. */ static FromSquareMeterKelvinsPerKilowatt(value: number): ThermalInsulance; /** * Create a new ThermalInsulance instance from a SquareMeterKelvinsPerWatt * * @param value The unit as SquareMeterKelvinsPerWatt to create a new ThermalInsulance from. * @returns The new ThermalInsulance instance. */ static FromSquareMeterKelvinsPerWatt(value: number): ThermalInsulance; /** * Create a new ThermalInsulance instance from a SquareMeterDegreesCelsiusPerWatt * * @param value The unit as SquareMeterDegreesCelsiusPerWatt to create a new ThermalInsulance from. * @returns The new ThermalInsulance instance. */ static FromSquareMeterDegreesCelsiusPerWatt(value: number): ThermalInsulance; /** * Create a new ThermalInsulance instance from a SquareCentimeterKelvinsPerWatt * * @param value The unit as SquareCentimeterKelvinsPerWatt to create a new ThermalInsulance from. * @returns The new ThermalInsulance instance. */ static FromSquareCentimeterKelvinsPerWatt(value: number): ThermalInsulance; /** * Create a new ThermalInsulance instance from a SquareMillimeterKelvinsPerWatt * * @param value The unit as SquareMillimeterKelvinsPerWatt to create a new ThermalInsulance from. * @returns The new ThermalInsulance instance. */ static FromSquareMillimeterKelvinsPerWatt(value: number): ThermalInsulance; /** * Create a new ThermalInsulance instance from a SquareCentimeterHourDegreesCelsiusPerKilocalorie * * @param value The unit as SquareCentimeterHourDegreesCelsiusPerKilocalorie to create a new ThermalInsulance from. * @returns The new ThermalInsulance instance. */ static FromSquareCentimeterHourDegreesCelsiusPerKilocalorie(value: number): ThermalInsulance; /** * Create a new ThermalInsulance instance from a HourSquareFeetDegreesFahrenheitPerBtu * * @param value The unit as HourSquareFeetDegreesFahrenheitPerBtu to create a new ThermalInsulance from. * @returns The new ThermalInsulance instance. */ static FromHourSquareFeetDegreesFahrenheitPerBtu(value: number): ThermalInsulance; /** * Gets the base unit enumeration associated with ThermalInsulance * @returns The unit enumeration that can be used to interact with this type */ protected static getUnitEnum(): typeof ThermalInsulanceUnits; /** * 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 */ protected static getBaseUnit(): ThermalInsulanceUnits.SquareMeterKelvinsPerKilowatt; /** * Create API DTO represent a ThermalInsulance unit. * @param holdInUnit The specific ThermalInsulance unit to be used in the unit representation at the DTO */ toDto(holdInUnit?: ThermalInsulanceUnits): ThermalInsulanceDto; /** * Create a ThermalInsulance unit from an API DTO representation. * @param dtoThermalInsulance The ThermalInsulance API DTO representation */ static FromDto(dtoThermalInsulance: ThermalInsulanceDto): ThermalInsulance; /** * Convert ThermalInsulance to a specific unit value. * @param toUnit The specific unit to convert to * @returns The value of the specific unit provided. */ convert(toUnit: ThermalInsulanceUnits): number; private convertFromBase; private convertToBase; /** * Format the ThermalInsulance to string. * Note! the default format for ThermalInsulance is SquareMeterKelvinsPerKilowatt. * To specify the unit format set the 'unit' parameter. * @param unit The unit to format the ThermalInsulance. * @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 ThermalInsulance. */ toString(unit?: ThermalInsulanceUnits, options?: number | ToStringOptions): string; /** * Get ThermalInsulance unit abbreviation. * Note! the default abbreviation for ThermalInsulance is SquareMeterKelvinsPerKilowatt. * To specify the unit abbreviation set the 'unitAbbreviation' parameter. * @param unitAbbreviation The unit abbreviation of the ThermalInsulance. * @returns The abbreviation string of ThermalInsulance. */ getUnitAbbreviation(unitAbbreviation?: ThermalInsulanceUnits): string; /** * Check if the given ThermalInsulance are equals to the current ThermalInsulance. * @param thermalInsulance The other ThermalInsulance. * @returns True if the given ThermalInsulance are equal to the current ThermalInsulance. */ equals(thermalInsulance: ThermalInsulance): boolean; /** * Compare the given ThermalInsulance against the current ThermalInsulance. * @param thermalInsulance The other ThermalInsulance. * @returns 0 if they are equal, -1 if the current ThermalInsulance is less then other, 1 if the current ThermalInsulance is greater then other. */ compareTo(thermalInsulance: ThermalInsulance): number; /** * Add the given ThermalInsulance with the current ThermalInsulance. * @param thermalInsulance The other ThermalInsulance. * @returns A new ThermalInsulance instance with the results. */ add(thermalInsulance: ThermalInsulance): ThermalInsulance; /** * Subtract the given ThermalInsulance with the current ThermalInsulance. * @param thermalInsulance The other ThermalInsulance. * @returns A new ThermalInsulance instance with the results. */ subtract(thermalInsulance: ThermalInsulance): ThermalInsulance; /** * Multiply the given ThermalInsulance with the current ThermalInsulance. * @param thermalInsulance The other ThermalInsulance. * @returns A new ThermalInsulance instance with the results. */ multiply(thermalInsulance: ThermalInsulance): ThermalInsulance; /** * Divide the given ThermalInsulance with the current ThermalInsulance. * @param thermalInsulance The other ThermalInsulance. * @returns A new ThermalInsulance instance with the results. */ divide(thermalInsulance: ThermalInsulance): ThermalInsulance; /** * Modulo the given ThermalInsulance with the current ThermalInsulance. * @param thermalInsulance The other ThermalInsulance. * @returns A new ThermalInsulance instance with the results. */ modulo(thermalInsulance: ThermalInsulance): ThermalInsulance; /** * Pow the given ThermalInsulance with the current ThermalInsulance. * @param thermalInsulance The other ThermalInsulance. * @returns A new ThermalInsulance instance with the results. */ pow(thermalInsulance: ThermalInsulance): ThermalInsulance; }