CurrencyPipe — Angular

Преобразует число в строку с валютой, форматируя её согласно правилам локали, которые определяют группировку разрядов и разделитель, символ десятичной точки и другие настройки, зависящие от локали.

Использование канала

{{ value_expression | currency:currencyCode:display:digitsInfo:locale }}

API

class CurrencyPipe implements PipeTransform {
  constructor(_locale: string, _defaultCurrencyCode?: string): CurrencyPipe;
  transform(value: string | number, currencyCode?: string | undefined, display?: string | boolean | undefined, digitsInfo?: string | undefined, locale?: string | undefined): string | null;
  transform(value: null | undefined, currencyCode?: string | undefined, display?: string | boolean | undefined, digitsInfo?: string | undefined, locale?: string | undefined): null;
  transform(value: string | number | null | undefined, currencyCode?: string | undefined, display?: string | boolean | undefined, digitsInfo?: string | undefined, locale?: string | undefined): string | null;
}

constructor

CurrencyPipe

@param_localestring

@param_defaultCurrencyCodestring

@returnsCurrencyPipe

transform

3 перегрузки

@paramvaluestring | number

Число, которое нужно отформатировать как валюту.

@paramcurrencyCodestring | undefined

Код валюты ISO 4217, например USD для доллара США и EUR для евро. Код валюты по умолчанию можно настроить с помощью токена внедрения DEFAULT_CURRENCY_CODE.

@paramdisplaystring | boolean | undefined

Формат отображения обозначения валюты. Возможны следующие варианты:

code: отображать код (например, USD).
symbol(по умолчанию): отображать символ (например, $).
symbol-narrow: использовать узкий символ для локалей, в которых у валюты есть два символа. Например, у канадского доллара CAD есть символ CA$ и узкий символ $. Если у локали нет узкого символа, используется стандартный символ этой локали.
String: использовать указанное строковое значение вместо кода или символа. Например, пустая строка скроет валюту и её символ.
Boolean (помечен как устаревший в версии 5): true для символа и false для code.

@paramdigitsInfostring | undefined

Параметры десятичного представления, заданные строкой в следующем формате:
{minIntegerDigits}.{minFractionDigits}-{maxFractionDigits}.

minIntegerDigits: минимальное количество цифр в целой части до десятичной точки. Значение по умолчанию — 1.
minFractionDigits: минимальное количество цифр после десятичной точки. Значение по умолчанию — 2.
maxFractionDigits: максимальное количество цифр после десятичной точки. Значение по умолчанию — 2. Если значение не задано, число форматируется с подходящим количеством цифр согласно спецификации ISO 4217. Например, у канадского доллара две цифры, а у чилийского песо их нет.

@paramlocalestring | undefined

Код локали, задающий используемые правила форматирования. Если значение не указано, используется значение LOCALE_ID, которое по умолчанию равно en-US. См. раздел Настройка локали приложения.

@returnsstring | null

@paramvaluenull | undefined

@paramcurrencyCodestring | undefined

@paramdisplaystring | boolean | undefined

@paramdigitsInfostring | undefined

@paramlocalestring | undefined

@returnsnull

@paramvaluestring | number | null | undefined

@paramcurrencyCodestring | undefined

@paramdisplaystring | boolean | undefined

@paramdigitsInfostring | undefined

@paramlocalestring | undefined

@returnsstring | null

Описание

Экспортируется модулем

CommonModule

Примечания по использованию

В следующем примере показано, как канал преобразует числа в текстовые строки согласно различным спецификациям формата, если локаль по умолчанию вызывающего кода — en-US.

@Component({
  selector: 'currency-pipe',
  imports: [CurrencyPipe],
  template: `<div>
    <!--output '$0.26'-->
    <p>A: {{ a | currency }}</p>

    <!--output 'CA$0.26'-->
    <p>A: {{ a | currency: 'CAD' }}</p>

    <!--output 'CAD0.26'-->
    <p>A: {{ a | currency: 'CAD' : 'code' }}</p>

    <!--output 'CA$0,001.35'-->
    <p>B: {{ b | currency: 'CAD' : 'symbol' : '4.2-2' }}</p>

    <!--output '$0,001.35'-->
    <p>B: {{ b | currency: 'CAD' : 'symbol-narrow' : '4.2-2' }}</p>

    <!--output '0 001,35 CA$'-->
    <p>B: {{ b | currency: 'CAD' : 'symbol' : '4.2-2' : 'fr' }}</p>

    <!--output 'CLP1' because CLP has no cents-->
    <p>B: {{ b | currency: 'CLP' }}</p>
  </div>`,
})
export class CurrencyPipeComponent {
  a: number = 0.259;
  b: number = 1.3495;
}