UNPKG

@angular/common

Version:

Angular - commonly needed directives and services

95 lines (94 loc) 3.6 kB
/** * @license * Copyright Google Inc. All Rights Reserved. * * Use of this source code is governed by an MIT-style license that can be * found in the LICENSE file at https://angular.io/license */ import { PipeTransform } from '@angular/core'; /** * @ngModule CommonModule * @whatItDoes Formats a number according to locale rules. * @howToUse `number_expression | number[:digitInfo]` * * Formats a number as text. Group sizing and separator and other locale-specific * configurations are based on the active locale. * * where `expression` is a number: * - `digitInfo` is a `string` which has a following format: <br> * <code>{minIntegerDigits}.{minFractionDigits}-{maxFractionDigits}</code> * - `minIntegerDigits` is the minimum number of integer digits to use. Defaults to `1`. * - `minFractionDigits` is the minimum number of digits after fraction. Defaults to `0`. * - `maxFractionDigits` is the maximum number of digits after fraction. Defaults to `3`. * * For more information on the acceptable range for each of these numbers and other * details see your native internationalization library. * * WARNING: this pipe uses the Internationalization API which is not yet available in all browsers * and may require a polyfill. See [Browser Support](guide/browser-support) for details. * * ### Example * * {@example common/pipes/ts/number_pipe.ts region='DeprecatedNumberPipe'} * * @stable */ export declare class DeprecatedDecimalPipe implements PipeTransform { private _locale; constructor(_locale: string); transform(value: any, digits?: string): string | null; } /** * @ngModule CommonModule * @whatItDoes Formats a number as a percentage according to locale rules. * @howToUse `number_expression | percent[:digitInfo]` * * @description * * Formats a number as percentage. * * - `digitInfo` See {@link DecimalPipe} for detailed description. * * WARNING: this pipe uses the Internationalization API which is not yet available in all browsers * and may require a polyfill. See [Browser Support](guide/browser-support) for details. * * ### Example * * {@example common/pipes/ts/percent_pipe.ts region='DeprecatedPercentPipe'} * * @stable */ export declare class DeprecatedPercentPipe implements PipeTransform { private _locale; constructor(_locale: string); transform(value: any, digits?: string): string | null; } /** * @ngModule CommonModule * @whatItDoes Formats a number as currency using locale rules. * @howToUse `number_expression | currency[:currencyCode[:symbolDisplay[:digitInfo]]]` * @description * * Use `currency` to format a number as currency. * * - `currencyCode` is the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code, such * as `USD` for the US dollar and `EUR` for the euro. * - `symbolDisplay` is a boolean indicating whether to use the currency symbol or code. * - `true`: use symbol (e.g. `$`). * - `false`(default): use code (e.g. `USD`). * - `digitInfo` See {@link DecimalPipe} for detailed description. * * WARNING: this pipe uses the Internationalization API which is not yet available in all browsers * and may require a polyfill. See [Browser Support](guide/browser-support) for details. * * ### Example * * {@example common/pipes/ts/currency_pipe.ts region='DeprecatedCurrencyPipe'} * * @stable */ export declare class DeprecatedCurrencyPipe implements PipeTransform { private _locale; constructor(_locale: string); transform(value: any, currencyCode?: string, symbolDisplay?: boolean, digits?: string): string | null; }