Today is {{today | date}}
+ *Or if you prefer, {{today | date:'fullDate'}}
+ *The time is {{today | date:'h:mm a z'}}
+ *{minIntegerDigits}.{minFractionDigits}-{maxFractionDigits}.
- * - `minIntegerDigits` is the minimum number of integer digits to use. Defaults to `1`.
- * - `minFractionDigits` is the minimum number of digits after the decimal point. Defaults to
- * `0`.
- * - `maxFractionDigits` is the maximum number of digits after the decimal point. Defaults to
- * `3`.
- * @param locale a `string` defining the locale to use (uses the current {@link LOCALE_ID} by
- * default).
+ * - `minIntegerDigits`: The minimum number of integer digits before the decimal point.
+ * Default is `1`.
+ * - `minFractionDigits`: The minimum number of digits after the decimal point.
+ * Default is `0`.
+ * - `maxFractionDigits`: The maximum number of digits after the decimal point.
+ * Default is `3`.
+ * @param locale A locale code for the locale format rules to use.
+ * When not supplied, uses the value of `LOCALE_ID`, which is `en-US` by default.
+ * See [Setting your app locale](guide/i18n#setting-up-the-locale-of-your-app).
*/
transform(value: any, digitsInfo?: string, locale?: string): string|null {
if (isEmpty(value)) return null;
@@ -60,12 +68,19 @@ export class DecimalPipe implements PipeTransform {
* @ngModule CommonModule
* @description
*
- * Uses the function {@link formatPercent} to format a number as a percentage according
- * to locale rules.
+ * Transforms a number to a percentage
+ * string, formatted according to locale rules that determine group sizing and
+ * separator, decimal-point character, and other locale-specific
+ * configurations.
*
- * ### Example
+ * @see `formatPercent()`
*
- * {@example common/pipes/ts/percent_pipe.ts region='PercentPipe'}
+ * @usageNotes
+ * The following code shows how the pipe transforms numbers
+ * into text strings, according to various format specifications,
+ * where the caller's default locale is `en-US`.
+ *
+ * {minIntegerDigits}.{minFractionDigits}-{maxFractionDigits}.
+ * - `minIntegerDigits`: The minimum number of integer digits before the decimal point.
+ * Default is `1`.
+ * - `minFractionDigits`: The minimum number of digits after the decimal point.
+ * Default is `0`.
+ * - `maxFractionDigits`: The maximum number of digits after the decimal point.
+ * Default is `3`.
+ * @param locale A locale code for the locale format rules to use.
+ * When not supplied, uses the value of `LOCALE_ID`, which is `en-US` by default.
+ * See [Setting your app locale](guide/i18n#setting-up-the-locale-of-your-app).
*/
transform(value: any, digitsInfo?: string, locale?: string): string|null {
if (isEmpty(value)) return null;
@@ -98,12 +122,19 @@ export class PercentPipe implements PipeTransform {
* @ngModule CommonModule
* @description
*
- * Uses the functions {@link getCurrencySymbol} and {@link formatCurrency} to format a
- * number as currency using locale rules.
+ * Transforms a number to a currency string, formatted according to locale rules
+ * that determine group sizing and separator, decimal-point character,
+ * and other locale-specific configurations.
*
- * ### Example
+ * @see `getCurrencySymbol()`
+ * @see `formatCurrency()`
*
- * {@example common/pipes/ts/currency_pipe.ts region='CurrencyPipe'}
+ * @usageNotes
+ * The following code shows how the pipe transforms numbers
+ * into text strings, according to various format specifications,
+ * where the caller's default locale is `en-US`.
+ *
+ * {minIntegerDigits}.{minFractionDigits}-{maxFractionDigits}.
+ * - `minIntegerDigits`: The minimum number of integer digits before the decimal point.
+ * Default is `1`.
+ * - `minFractionDigits`: The minimum number of digits after the decimal point.
+ * Default is `0`.
+ * - `maxFractionDigits`: The maximum number of digits after the decimal point.
+ * Default is `3`.
+ * @param locale A locale code for the locale format rules to use.
+ * When not supplied, uses the value of `LOCALE_ID`, which is `en-US` by default.
+ * See [Setting your app locale](guide/i18n#setting-up-the-locale-of-your-app).
*/
transform(
value: any, currencyCode?: string,
@@ -167,7 +209,7 @@ function isEmpty(value: any): boolean {
}
/**
- * Transforms a string into a number (if needed)
+ * Transforms a string into a number (if needed).
*/
function strToNumber(value: number | string): number {
// Convert strings to numbers