docs: document accounting format

telerik · Jun 12, 2017 · 0f3f4f4 · 0f3f4f4
1 parent a3e34bf
commit 0f3f4f4
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 3 deletions.
diff --git a/docs/num-formatting/api.md b/docs/num-formatting/api.md
@@ -33,6 +33,7 @@ Specifies the format style.
 The supported values are:
 * `"decimal"`
 * `"currency"`
+* `"accounting"`
 * `"percent"`
 * `"scientific"`
 

diff --git a/docs/num-formatting/index.md b/docs/num-formatting/index.md
@@ -43,6 +43,16 @@ Standard number formatting can be specified by passing an options object or a st
 
         formatNumber(1234.5678, "c5", "bg"); // 1 234,56780 лв
 
+* **The `"a"` specifier**&mdash;Same as `"c"` but uses the currency accounting format.
+
+  > The locale numbers `currencies` data and the supplemental `currencyData` must be loaded for the currency formatting to work.
+
+        import { formatNumber } from '@telerik/kendo-intl';
+
+        formatNumber(-1234.5678, "a"); // ($1,234.57)
+
+        formatNumber(1234.5678, "a3", "de-CH"); // 1’234.568 CHF
+
 * **The `"p"` specifier**&mdash;Formats the number as a percentage based on the locale. The passed number is multiplied by 100. To specify precision, add a number after `"p"`. By default, the number is formatted and rounded to zero decimal digits.
 
         import { formatNumber } from '@telerik/kendo-intl';
@@ -69,7 +79,7 @@ Standard number formatting can be specified by passing an options object or a st
         }); // 1,234.5678
 
         formatNumber(1234.5678, {
-            style: "currency",            
+            style: "currency",
             currency: "EUR",
             currencyDisplay: "displayName"
         }, "bg"); // 1 234,57 евро
@@ -90,7 +100,7 @@ The supported format specifiers are:
 
         import { formatNumber } from '@telerik/kendo-intl';
 
-        formatNumber(1234.5678, "00000"); // 01235    
+        formatNumber(1234.5678, "00000"); // 01235
 
 * **The `"#"` specifier**&mdash;A digit placeholder. It replaces the Pound sign with the corresponding digit if one is present. Otherwise, no digit appears in the result string.
 

diff --git a/src/numbers.d.ts b/src/numbers.d.ts
@@ -6,7 +6,7 @@ export interface NumberFormatOptions {
     /**
      * Specifies the format style.
      */
-    style?: 'decimal' | 'currency' | 'percent' | 'scientific';
+    style?: 'decimal' | 'currency' | 'percent' | 'scientific' | 'accounting';
 
     /**
      * Defines the currency code of the currency that is used in the formatting.