@angular/common

formatCurrency

function

stable

Formats a number as currency using locale rules.

API

function formatCurrency(
  value: number,
  locale: string,
  currency: string,
  currencyCode?: string | undefined,
  digitsInfo?: string | undefined,
): string;

formatCurrency

string

Formats a number as currency using locale rules.

@paramvaluenumber

The number to format.

@paramlocalestring

A locale code for the locale format rules to use.

@paramcurrencystring

A string containing the currency symbol or its name, such as "$" or "Canadian Dollar". Used in output string, but does not affect the operation of the function.

@paramcurrencyCodestring | undefined

The ISO 4217 currency code, such as USD for the US dollar and EUR for the euro. Used to determine the number of digits in the decimal part.

@paramdigitsInfostring | undefined

Decimal representation options, specified by a string in the following format: {minIntegerDigits}.{minFractionDigits}-{maxFractionDigits}. See DecimalPipe for more details.

@returnsstring

Description

Formats a number as currency using locale rules.

Exported by

CommonModule