unitsnet-js

import { BaseUnit, ToStringOptions } from "../base-unit"; /** API DTO represents a Luminosity */ export interface LuminosityDto { /** The value of the Luminosity */ value: number; /** The specific unit that the Luminosity value is representing */ unit: LuminosityUnits; } /** LuminosityUnits enumeration */ export declare enum LuminosityUnits { /** */ Watts = "Watt", /** */ SolarLuminosities = "SolarLuminosity", /** */ Femtowatts = "Femtowatt", /** */ Picowatts = "Picowatt", /** */ Nanowatts = "Nanowatt", /** */ Microwatts = "Microwatt", /** */ Milliwatts = "Milliwatt", /** */ Deciwatts = "Deciwatt", /** */ Decawatts = "Decawatt", /** */ Kilowatts = "Kilowatt", /** */ Megawatts = "Megawatt", /** */ Gigawatts = "Gigawatt", /** */ Terawatts = "Terawatt", /** */ Petawatts = "Petawatt" } /** Luminosity is an absolute measure of radiated electromagnetic power (light), the radiant power emitted by a light-emitting object. */ export declare class Luminosity extends BaseUnit { protected value: number; private wattsLazy; private solarluminositiesLazy; private femtowattsLazy; private picowattsLazy; private nanowattsLazy; private microwattsLazy; private milliwattsLazy; private deciwattsLazy; private decawattsLazy; private kilowattsLazy; private megawattsLazy; private gigawattsLazy; private terawattsLazy; private petawattsLazy; /** * Create a new Luminosity. * @param value The value. * @param fromUnit The ‘Luminosity’ unit to create from. * The default unit is Watts */ constructor(value: number, fromUnit?: LuminosityUnits); /** * The base value of Luminosity is Watts. * 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(): LuminosityUnits.Watts; /** */ get Watts(): number; /** */ get SolarLuminosities(): number; /** */ get Femtowatts(): number; /** */ get Picowatts(): number; /** */ get Nanowatts(): number; /** */ get Microwatts(): number; /** */ get Milliwatts(): number; /** */ get Deciwatts(): number; /** */ get Decawatts(): number; /** */ get Kilowatts(): number; /** */ get Megawatts(): number; /** */ get Gigawatts(): number; /** */ get Terawatts(): number; /** */ get Petawatts(): number; /** * Create a new Luminosity instance from a Watts * * @param value The unit as Watts to create a new Luminosity from. * @returns The new Luminosity instance. */ static FromWatts(value: number): Luminosity; /** * Create a new Luminosity instance from a SolarLuminosities * * @param value The unit as SolarLuminosities to create a new Luminosity from. * @returns The new Luminosity instance. */ static FromSolarLuminosities(value: number): Luminosity; /** * Create a new Luminosity instance from a Femtowatts * * @param value The unit as Femtowatts to create a new Luminosity from. * @returns The new Luminosity instance. */ static FromFemtowatts(value: number): Luminosity; /** * Create a new Luminosity instance from a Picowatts * * @param value The unit as Picowatts to create a new Luminosity from. * @returns The new Luminosity instance. */ static FromPicowatts(value: number): Luminosity; /** * Create a new Luminosity instance from a Nanowatts * * @param value The unit as Nanowatts to create a new Luminosity from. * @returns The new Luminosity instance. */ static FromNanowatts(value: number): Luminosity; /** * Create a new Luminosity instance from a Microwatts * * @param value The unit as Microwatts to create a new Luminosity from. * @returns The new Luminosity instance. */ static FromMicrowatts(value: number): Luminosity; /** * Create a new Luminosity instance from a Milliwatts * * @param value The unit as Milliwatts to create a new Luminosity from. * @returns The new Luminosity instance. */ static FromMilliwatts(value: number): Luminosity; /** * Create a new Luminosity instance from a Deciwatts * * @param value The unit as Deciwatts to create a new Luminosity from. * @returns The new Luminosity instance. */ static FromDeciwatts(value: number): Luminosity; /** * Create a new Luminosity instance from a Decawatts * * @param value The unit as Decawatts to create a new Luminosity from. * @returns The new Luminosity instance. */ static FromDecawatts(value: number): Luminosity; /** * Create a new Luminosity instance from a Kilowatts * * @param value The unit as Kilowatts to create a new Luminosity from. * @returns The new Luminosity instance. */ static FromKilowatts(value: number): Luminosity; /** * Create a new Luminosity instance from a Megawatts * * @param value The unit as Megawatts to create a new Luminosity from. * @returns The new Luminosity instance. */ static FromMegawatts(value: number): Luminosity; /** * Create a new Luminosity instance from a Gigawatts * * @param value The unit as Gigawatts to create a new Luminosity from. * @returns The new Luminosity instance. */ static FromGigawatts(value: number): Luminosity; /** * Create a new Luminosity instance from a Terawatts * * @param value The unit as Terawatts to create a new Luminosity from. * @returns The new Luminosity instance. */ static FromTerawatts(value: number): Luminosity; /** * Create a new Luminosity instance from a Petawatts * * @param value The unit as Petawatts to create a new Luminosity from. * @returns The new Luminosity instance. */ static FromPetawatts(value: number): Luminosity; /** * Gets the base unit enumeration associated with Luminosity * @returns The unit enumeration that can be used to interact with this type */ protected static getUnitEnum(): typeof LuminosityUnits; /** * 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(): LuminosityUnits.Watts; /** * Create API DTO represent a Luminosity unit. * @param holdInUnit The specific Luminosity unit to be used in the unit representation at the DTO */ toDto(holdInUnit?: LuminosityUnits): LuminosityDto; /** * Create a Luminosity unit from an API DTO representation. * @param dtoLuminosity The Luminosity API DTO representation */ static FromDto(dtoLuminosity: LuminosityDto): Luminosity; /** * Convert Luminosity to a specific unit value. * @param toUnit The specific unit to convert to * @returns The value of the specific unit provided. */ convert(toUnit: LuminosityUnits): number; private convertFromBase; private convertToBase; /** * Format the Luminosity to string. * Note! the default format for Luminosity is Watts. * To specify the unit format set the 'unit' parameter. * @param unit The unit to format the Luminosity. * @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 Luminosity. */ toString(unit?: LuminosityUnits, options?: number | ToStringOptions): string; /** * Get Luminosity unit abbreviation. * Note! the default abbreviation for Luminosity is Watts. * To specify the unit abbreviation set the 'unitAbbreviation' parameter. * @param unitAbbreviation The unit abbreviation of the Luminosity. * @returns The abbreviation string of Luminosity. */ getUnitAbbreviation(unitAbbreviation?: LuminosityUnits): string; /** * Check if the given Luminosity are equals to the current Luminosity. * @param luminosity The other Luminosity. * @returns True if the given Luminosity are equal to the current Luminosity. */ equals(luminosity: Luminosity): boolean; /** * Compare the given Luminosity against the current Luminosity. * @param luminosity The other Luminosity. * @returns 0 if they are equal, -1 if the current Luminosity is less then other, 1 if the current Luminosity is greater then other. */ compareTo(luminosity: Luminosity): number; /** * Add the given Luminosity with the current Luminosity. * @param luminosity The other Luminosity. * @returns A new Luminosity instance with the results. */ add(luminosity: Luminosity): Luminosity; /** * Subtract the given Luminosity with the current Luminosity. * @param luminosity The other Luminosity. * @returns A new Luminosity instance with the results. */ subtract(luminosity: Luminosity): Luminosity; /** * Multiply the given Luminosity with the current Luminosity. * @param luminosity The other Luminosity. * @returns A new Luminosity instance with the results. */ multiply(luminosity: Luminosity): Luminosity; /** * Divide the given Luminosity with the current Luminosity. * @param luminosity The other Luminosity. * @returns A new Luminosity instance with the results. */ divide(luminosity: Luminosity): Luminosity; /** * Modulo the given Luminosity with the current Luminosity. * @param luminosity The other Luminosity. * @returns A new Luminosity instance with the results. */ modulo(luminosity: Luminosity): Luminosity; /** * Pow the given Luminosity with the current Luminosity. * @param luminosity The other Luminosity. * @returns A new Luminosity instance with the results. */ pow(luminosity: Luminosity): Luminosity; }