Revision 679779 of Intl.NumberFormat

<div>{{JSRef("Global_Objects", "NumberFormat", "Intl,Collator,DateTimeFormat")}}</div>

<h2 id="Summary">Summary</h2>
<p>The <strong><code>Intl.NumberFormat</code></strong> object is a constructor for objects that enable language sensitive number formatting.</p>

<h2 id="Syntax">Syntax</h2>
<pre class="syntaxbox"><code>new Intl.NumberFormat([<var>locales</var>[, <var>options</var>]])
Intl.NumberFormat.call(<var>this</var>[, <var>locales</var>[, <var>options</var>]])
</code></pre>

<h3 id="Parameters">Parameters</h3>
<dl>
 <dt><code>locales</code></dt>
 <dd>
  <p>A string with a BCP 47 language tag, or an array of such strings. For the general form and interpretation of the <code>locales</code> argument, see the {{jsxref("Global_Objects/Intl", "Intl page", "#Locale_identification_and_negotiation", 1)}}. The following Unicode extension key is allowed:</p>
  <dl>
   <dt><code>nu</code></dt>
   <dd>The numbering system to be used. Possible values include: <code>"arab"</code>, <code>"arabext"</code>, <code>"bali"</code>, <code>"beng"</code>, <code>"deva"</code>, <code>"fullwide"</code>, <code>"gujr"</code>, <code>"guru"</code>, <code>"hanidec"</code>, <code>"khmr"</code>, <code>"knda"</code>, <code>"laoo"</code>, <code>"latn"</code>, <code>"limb"</code>, <code>"mlym"</code>, <code>"mong"</code>, <code>"mymr"</code>, <code>"orya"</code>, <code>"tamldec"</code>, <code>"telu"</code>, <code>"thai"</code>, <code>"tibt"</code>.</dd>
  </dl>
 </dd>
 <dt><code>options</code></dt>
 <dd>
  <p>An object with some or all of the following properties:</p>
  <dl>
   <dt><code>localeMatcher</code></dt>
   <dd>The locale matching algorithm to use. Possible values are <code>"lookup"</code> and <code>"best fit"</code>; the default is <code>"best fit"</code>. For information about this option, see the {{jsxref("Global_Objects/Intl", "Intl page", "#Locale_negotiation", 1)}}.</dd>
   <dt><code>style</code></dt>
   <dd>The formatting style to use. Possible values are <code>"decimal"</code> for plain number formatting, <code>"currency"</code> for currency formatting, and <code>"percent"</code> for percent formatting; the default is <code>"decimal"</code>.</dd>
   <dt><code>currency</code></dt>
   <dd>The currency to use in currency formatting. Possible values are the ISO 4217 currency codes, such as <code>"USD"</code> for the US dollar, <code>"EUR"</code> for the euro, or <code>"CNY"</code> for the Chinese RMB — see the <a href="https://www.currency-iso.org/en/home/tables/table-a1.html">Current currency &amp; funds code list</a>. There is no default value; if the <code>style</code> is <code>"currency"</code>, the <code>currency</code> property must be provided.</dd>
   <dt><code>currencyDisplay</code></dt>
   <dd>How to display the currency in currency formatting. Possible values are <code>"symbol"</code> to use a localized currency symbol such as €, <code>"code"</code> to use the ISO currency code, <code>"name"</code> to use a localized currency name such as <code>"dollar"</code>; the default is <code>"symbol"</code>.</dd>
   <dt><code>useGrouping</code></dt>
   <dd>Whether to use grouping separators, such as thousands separators or thousand/lakh/crore separators. Possible values are <code>true</code> and <code>false</code>; the default is <code>true</code>.</dd>
  </dl>
  <p>The following properties fall into two groups: <code>minimumIntegerDigits</code>, <code>minimumFractionDigits</code>, and <code>maximumFractionDigits</code> in one group, <code>minimumSignificantDigits</code> and <code>maximumSignificantDigits</code> in the other. If at least one property from the second group is defined, then the first group is ignored.</p>
  <dl>
   <dt><code>minimumIntegerDigits</code></dt>
   <dd>The minimum number of integer digits to use. Possible values are from 1 to 21; the default is 1.</dd>
   <dt><code>minimumFractionDigits</code></dt>
   <dd>The minimum number of fraction digits to use. Possible values are from 0 to 20; the default for plain number and percent formatting is 0; the default for currency formatting is the number of minor unit digits provided by the <a href="https://www.currency-iso.org/en/home/tables/table-a1.html">ISO 4217 currency code list</a> (2 if the list doesn't provide that information).</dd>
   <dt><code>maximumFractionDigits</code></dt>
   <dd>The maximum number of fraction digits to use. Possible values are from 0 to 20; the default for plain number formatting is the larger of <code>minimumFractionDigits</code> and 3; the default for currency formatting is the larger of <code>minimumFractionDigits</code> and the number of minor unit digits provided by the <a href="https://www.currency-iso.org/en/home/tables/table-a1.html">ISO 4217 currency code list</a> (2 if the list doesn't provide that information); the default for percent formatting is the larger of <code>minimumFractionDigits</code> and 0.</dd>
   <dt><code>minimumSignificantDigits</code></dt>
   <dd>The minimum number of significant digits to use. Possible values are from 1 to 21; the default is 1.</dd>
   <dt><code>maximumSignificantDigits</code></dt>
   <dd>The maximum number of significant digits to use. Possible values are from 1 to 21; the default is <code>minimumSignificantDigits</code>.</dd>
  </dl>
 </dd>
</dl>

<h2 id="Description" name="Description">Description</h2>

<h3 id="Properties" name="Properties">Properties</h3>
<dl>
 <dt>{{jsxref("NumberFormat.prototype", "Intl.NumberFormat.prototype")}}</dt>
 <dd>Allows the addition of properties to all objects.</dd>
</dl>

<h3 id="Methods">Methods</h3>
<dl>
 <dt>{{jsxref("NumberFormat.supportedLocalesOf", "Intl.NumberFormat.supportedLocalesOf()")}}</dt>
 <dd>Returns an array containing those of the provided locales that are supported without having to fall back to the runtime's default locale.</dd>
</dl>

<h2 id="NumberFormat_instances"><code>NumberFormat</code> instances</h2>

<h3 id="Properties_of_NumberFormat_instance">Properties</h3>
<p><code>NumberFormat</code> instances inherit the following properties from their prototype:</p>
<div>{{page('/en-US/docs/Web/JavaScript/Reference/Global_Objects/NumberFormat/prototype', 'Properties')}}</div>

<h3 id="Methods_of_NumberFormat_instance">Methods</h3>
<p><code>NumberFormat</code> instances inherit the following methods from their prototype:</p>
<div>{{page('/en-US/docs/Web/JavaScript/Reference/Global_Objects/NumberFormat/prototype', 'Methods')}}</div>

<h2 id="Examples">Examples</h2>

<h3 id="Example:_Basic_usage" name="Example:_Basic_usage">Example: Basic usage</h3>
<p>In basic use without specifying a locale, a formatted string in the default locale and with default options is returned.</p>
<pre class="brush: js">var number = 3500;

console.log(new Intl.NumberFormat().format(number));
// → '3,500' if in US English locale
</pre>

<h3 id="Example:_Using_locales" name="Example:_Using_locales">Example: Using <code>locales</code></h3>
<p>This example shows some of the variations in localized number formats. In order to get the format of the language used in the user interface of your application, make sure to specify that language (and possibly some fallback languages) using the <code>locales</code> argument:</p>
<pre class="brush: js">var number = 123456.789;

// German uses comma as decimal separator and period for thousands
console.log(new Intl.NumberFormat('de-DE').format(number));
// → 123.456,789

// Arabic in most Arabic speaking countries uses real Arabic digits
console.log(new Intl.NumberFormat('ar-EG').format(number));
// → ١٢٣٤٥٦٫٧٨٩

// India uses thousands/lakh/crore separators
console.log(new Intl.NumberFormat('en-IN').format(number));
// → 1,23,456.789

// the nu extension key requests a numbering system, e.g. Chinese decimal
console.log(new Intl.NumberFormat('zh-Hans-CN-u-nu-hanidec').format(number));
// → 一二三,四五六.七八九

// when requesting a language that may not be supported, such as
// Balinese, include a fallback language, in this case Indonesian
console.log(new Intl.NumberFormat(['ban', 'id']).format(number));
// → 123.456,789
</pre>

<h3 id="Example:_Using_options" name="Example:_Using_options">Example: Using <code>options</code></h3>
<p>The results can be customized using the <code>options</code> argument:</p>
<pre class="brush: js">
var number = 123456.789;

// request a currency format
console.log(new Intl.NumberFormat('de-DE', { style: 'currency', currency: 'EUR' }).format(number));
// → 123.456,79 €

// the Japanese yen doesn't use a minor unit
console.log(new Intl.NumberFormat('ja-JP', { style: 'currency', currency: 'JPY' }).format(number));
// → ￥123,457

// limit to three significant digits
console.log(new Intl.NumberFormat('en-IN', { maximumSignificantDigits: 3 }).format(number));
// → 1,23,000
</pre>

<h2 id="Specifications">Specifications</h2>
<table class="standard-table">
 <tbody>
  <tr>
   <th scope="col">Specification</th>
   <th scope="col">Status</th>
   <th scope="col">Comment</th>
  </tr>
  <tr>
   <td>{{SpecName('ES Int 1.0', '#sec-11.1', 'Intl.NumberFormat')}}</td>
   <td>{{Spec2('ES Int 1.0')}}</td>
   <td>Initial definition.</td>
  </tr>
 </tbody>
</table>

<h2 id="Browser_compatibility" name="Browser_compatibility">Browser compatibility</h2>
<div>{{CompatibilityTable}}</div>
<div id="compat-desktop">
 <table class="compat-table">
  <tbody>
   <tr>
    <th>Feature</th>
    <th>Chrome</th>
    <th>Firefox (Gecko)</th>
    <th>Internet Explorer</th>
    <th>Opera</th>
    <th>Safari (WebKit)</th>
   </tr>
   <tr>
    <td>Basic support</td>
    <td>{{CompatChrome("24")}}</td>
    <td>{{CompatGeckoDesktop("29")}}</td>
    <td>{{CompatIE("11")}}</td>
    <td>{{CompatOpera("15")}}</td>
    <td>{{CompatNo}}</td>
   </tr>
  </tbody>
 </table>
</div>
<div id="compat-mobile">
 <table class="compat-table">
  <tbody>
   <tr>
    <th>Feature</th>
    <th>Android</th>
    <th>Chrome for Android</th>
    <th>Firefox Mobile (Gecko)</th>
    <th>IE Phone</th>
    <th>Opera Mobile</th>
    <th>Safari Mobile</th>
   </tr>
   <tr>
    <td>Basic support</td>
    <td>{{CompatNo}}</td>
    <td>{{CompatChrome("26")}}</td>
    <td>
     {{CompatNo}}<br>
     {{bug("864843")}}
    </td>
    <td>{{CompatNo}}</td>
    <td>{{CompatNo}}</td>
    <td>{{CompatNo}}</td>
   </tr>
  </tbody>
 </table>
</div>

<h2 id="See_also">See also</h2>
<div>{{page('/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl', 'See_also')}}</div>