formatQuantity Method

formatQuantity(props)

Generates a formatted string asynchronously for a quantity given the provided properties.

formatQuantity(props: { kindOfQuantityName: string, value: number, valueUnitName: string }): Promise<string>

@returns A promise resolving to a formatted string.

Parameter	Type	Description
props	{ kindOfQuantityName: string, value: number, valueUnitName: string }	an object containing value, valueUnitName, and kindOfQuantityName.

Returns - Promise

A promise resolving to a formatted string.

formatQuantity(magnitude, formatSpec?)

Generates a formatted string for a quantity given its format spec.

formatQuantity(magnitude: number, formatSpec?: FormatterSpec): string

@returns a formatted string.

Parameter	Type	Description
magnitude	number	The magnitude of the quantity.
formatSpec	FormatterSpec	The format specification. See methods getFormatterSpecByQuantityType and findFormatterSpecByQuantityType.

Returns - string

a formatted string.

Defined in

• core/frontend/src/quantity-formatting/QuantityFormatter.ts Line 921