unitsnet-js

import { BaseUnit, ToStringOptions } from "../base-unit"; /** API DTO represents a SpecificEntropy */ export interface SpecificEntropyDto { /** The value of the SpecificEntropy */ value: number; /** The specific unit that the SpecificEntropy value is representing */ unit: SpecificEntropyUnits; } /** SpecificEntropyUnits enumeration */ export declare enum SpecificEntropyUnits { /** */ JoulesPerKilogramKelvin = "JoulePerKilogramKelvin", /** */ JoulesPerKilogramDegreeCelsius = "JoulePerKilogramDegreeCelsius", /** */ CaloriesPerGramKelvin = "CaloriePerGramKelvin", /** */ BtusPerPoundFahrenheit = "BtuPerPoundFahrenheit", /** */ KilojoulesPerKilogramKelvin = "KilojoulePerKilogramKelvin", /** */ MegajoulesPerKilogramKelvin = "MegajoulePerKilogramKelvin", /** */ KilojoulesPerKilogramDegreeCelsius = "KilojoulePerKilogramDegreeCelsius", /** */ MegajoulesPerKilogramDegreeCelsius = "MegajoulePerKilogramDegreeCelsius", /** */ KilocaloriesPerGramKelvin = "KilocaloriePerGramKelvin" } /** Specific entropy is an amount of energy required to raise temperature of a substance by 1 Kelvin per unit mass. */ export declare class SpecificEntropy extends BaseUnit { protected value: number; private joulesperkilogramkelvinLazy; private joulesperkilogramdegreecelsiusLazy; private caloriespergramkelvinLazy; private btusperpoundfahrenheitLazy; private kilojoulesperkilogramkelvinLazy; private megajoulesperkilogramkelvinLazy; private kilojoulesperkilogramdegreecelsiusLazy; private megajoulesperkilogramdegreecelsiusLazy; private kilocaloriespergramkelvinLazy; /** * Create a new SpecificEntropy. * @param value The value. * @param fromUnit The ‘SpecificEntropy’ unit to create from. * The default unit is JoulesPerKilogramKelvin */ constructor(value: number, fromUnit?: SpecificEntropyUnits); /** * The base value of SpecificEntropy is JoulesPerKilogramKelvin. * 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(): SpecificEntropyUnits.JoulesPerKilogramKelvin; /** */ get JoulesPerKilogramKelvin(): number; /** */ get JoulesPerKilogramDegreeCelsius(): number; /** */ get CaloriesPerGramKelvin(): number; /** */ get BtusPerPoundFahrenheit(): number; /** */ get KilojoulesPerKilogramKelvin(): number; /** */ get MegajoulesPerKilogramKelvin(): number; /** */ get KilojoulesPerKilogramDegreeCelsius(): number; /** */ get MegajoulesPerKilogramDegreeCelsius(): number; /** */ get KilocaloriesPerGramKelvin(): number; /** * Create a new SpecificEntropy instance from a JoulesPerKilogramKelvin * * @param value The unit as JoulesPerKilogramKelvin to create a new SpecificEntropy from. * @returns The new SpecificEntropy instance. */ static FromJoulesPerKilogramKelvin(value: number): SpecificEntropy; /** * Create a new SpecificEntropy instance from a JoulesPerKilogramDegreeCelsius * * @param value The unit as JoulesPerKilogramDegreeCelsius to create a new SpecificEntropy from. * @returns The new SpecificEntropy instance. */ static FromJoulesPerKilogramDegreeCelsius(value: number): SpecificEntropy; /** * Create a new SpecificEntropy instance from a CaloriesPerGramKelvin * * @param value The unit as CaloriesPerGramKelvin to create a new SpecificEntropy from. * @returns The new SpecificEntropy instance. */ static FromCaloriesPerGramKelvin(value: number): SpecificEntropy; /** * Create a new SpecificEntropy instance from a BtusPerPoundFahrenheit * * @param value The unit as BtusPerPoundFahrenheit to create a new SpecificEntropy from. * @returns The new SpecificEntropy instance. */ static FromBtusPerPoundFahrenheit(value: number): SpecificEntropy; /** * Create a new SpecificEntropy instance from a KilojoulesPerKilogramKelvin * * @param value The unit as KilojoulesPerKilogramKelvin to create a new SpecificEntropy from. * @returns The new SpecificEntropy instance. */ static FromKilojoulesPerKilogramKelvin(value: number): SpecificEntropy; /** * Create a new SpecificEntropy instance from a MegajoulesPerKilogramKelvin * * @param value The unit as MegajoulesPerKilogramKelvin to create a new SpecificEntropy from. * @returns The new SpecificEntropy instance. */ static FromMegajoulesPerKilogramKelvin(value: number): SpecificEntropy; /** * Create a new SpecificEntropy instance from a KilojoulesPerKilogramDegreeCelsius * * @param value The unit as KilojoulesPerKilogramDegreeCelsius to create a new SpecificEntropy from. * @returns The new SpecificEntropy instance. */ static FromKilojoulesPerKilogramDegreeCelsius(value: number): SpecificEntropy; /** * Create a new SpecificEntropy instance from a MegajoulesPerKilogramDegreeCelsius * * @param value The unit as MegajoulesPerKilogramDegreeCelsius to create a new SpecificEntropy from. * @returns The new SpecificEntropy instance. */ static FromMegajoulesPerKilogramDegreeCelsius(value: number): SpecificEntropy; /** * Create a new SpecificEntropy instance from a KilocaloriesPerGramKelvin * * @param value The unit as KilocaloriesPerGramKelvin to create a new SpecificEntropy from. * @returns The new SpecificEntropy instance. */ static FromKilocaloriesPerGramKelvin(value: number): SpecificEntropy; /** * Gets the base unit enumeration associated with SpecificEntropy * @returns The unit enumeration that can be used to interact with this type */ protected static getUnitEnum(): typeof SpecificEntropyUnits; /** * 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(): SpecificEntropyUnits.JoulesPerKilogramKelvin; /** * Create API DTO represent a SpecificEntropy unit. * @param holdInUnit The specific SpecificEntropy unit to be used in the unit representation at the DTO */ toDto(holdInUnit?: SpecificEntropyUnits): SpecificEntropyDto; /** * Create a SpecificEntropy unit from an API DTO representation. * @param dtoSpecificEntropy The SpecificEntropy API DTO representation */ static FromDto(dtoSpecificEntropy: SpecificEntropyDto): SpecificEntropy; /** * Convert SpecificEntropy to a specific unit value. * @param toUnit The specific unit to convert to * @returns The value of the specific unit provided. */ convert(toUnit: SpecificEntropyUnits): number; private convertFromBase; private convertToBase; /** * Format the SpecificEntropy to string. * Note! the default format for SpecificEntropy is JoulesPerKilogramKelvin. * To specify the unit format set the 'unit' parameter. * @param unit The unit to format the SpecificEntropy. * @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 SpecificEntropy. */ toString(unit?: SpecificEntropyUnits, options?: number | ToStringOptions): string; /** * Get SpecificEntropy unit abbreviation. * Note! the default abbreviation for SpecificEntropy is JoulesPerKilogramKelvin. * To specify the unit abbreviation set the 'unitAbbreviation' parameter. * @param unitAbbreviation The unit abbreviation of the SpecificEntropy. * @returns The abbreviation string of SpecificEntropy. */ getUnitAbbreviation(unitAbbreviation?: SpecificEntropyUnits): string; /** * Check if the given SpecificEntropy are equals to the current SpecificEntropy. * @param specificEntropy The other SpecificEntropy. * @returns True if the given SpecificEntropy are equal to the current SpecificEntropy. */ equals(specificEntropy: SpecificEntropy): boolean; /** * Compare the given SpecificEntropy against the current SpecificEntropy. * @param specificEntropy The other SpecificEntropy. * @returns 0 if they are equal, -1 if the current SpecificEntropy is less then other, 1 if the current SpecificEntropy is greater then other. */ compareTo(specificEntropy: SpecificEntropy): number; /** * Add the given SpecificEntropy with the current SpecificEntropy. * @param specificEntropy The other SpecificEntropy. * @returns A new SpecificEntropy instance with the results. */ add(specificEntropy: SpecificEntropy): SpecificEntropy; /** * Subtract the given SpecificEntropy with the current SpecificEntropy. * @param specificEntropy The other SpecificEntropy. * @returns A new SpecificEntropy instance with the results. */ subtract(specificEntropy: SpecificEntropy): SpecificEntropy; /** * Multiply the given SpecificEntropy with the current SpecificEntropy. * @param specificEntropy The other SpecificEntropy. * @returns A new SpecificEntropy instance with the results. */ multiply(specificEntropy: SpecificEntropy): SpecificEntropy; /** * Divide the given SpecificEntropy with the current SpecificEntropy. * @param specificEntropy The other SpecificEntropy. * @returns A new SpecificEntropy instance with the results. */ divide(specificEntropy: SpecificEntropy): SpecificEntropy; /** * Modulo the given SpecificEntropy with the current SpecificEntropy. * @param specificEntropy The other SpecificEntropy. * @returns A new SpecificEntropy instance with the results. */ modulo(specificEntropy: SpecificEntropy): SpecificEntropy; /** * Pow the given SpecificEntropy with the current SpecificEntropy. * @param specificEntropy The other SpecificEntropy. * @returns A new SpecificEntropy instance with the results. */ pow(specificEntropy: SpecificEntropy): SpecificEntropy; }