Método Number toLocaleString() do JavaScript

Definição e uso

toLocaleString() Retorna o número como uma string usando o formato de idioma local.

O formato de idioma depende do ajuste regional do seu computador.

Exemplo

Exemplo 1

Usando o ajuste regional para formatar o número como uma string:

let num = 1000000;
let text = num.toLocaleString();

Experimente pessoalmente

Exemplo 2

Usando o ambiente de idioma específico da Finlândia para formatar o número como uma string:

let num = 1000000;
let text = num.toLocaleString("fi-FI");

Experimente pessoalmente

Exemplo 3

Usando o ambiente de idioma específico dos EUA para formatar o número como uma string de moeda:

let num = 1000000;
let text = num.toLocaleString("en-US", {style:"currency", currency:"USD"});

Experimente pessoalmente

Exemplo 4

Use opções Formatação de moeda com parâmetro (objeto):

let num = new Number(1000000);
const myObj = {
  style: "currency",
  currency: "EUR"
}
let text = num.toLocaleString("en-GB", myObj);

Experimente pessoalmente

Exemplo 5

let num = new Number(1000000);
let text = num.toLocaleString("en-GB", {style:"currency", currency:"EUR"});

Experimente pessoalmente

Exemplo 6

Use o ambiente de idioma específico do JAPAN:

let num = 1000000;
let text = num.toLocaleString("ja-JP", {style:"currency", currency:"JPY"});

Experimente pessoalmente

Gramática

number.toLocaleString(locales, opções)

Parâmetro

Parâmetro Descrição
locales Opcional. Formato específico do idioma a ser usado. Veja a tabela a seguir.
opções Opcional. Um objeto com opções de formatação. Veja a tabela a seguir.

locales Valores aceitáveis:

  • ar-SA Árabe (Arábia Saudita)
  • bn-BD Bengali (Bangladesh)
  • bn-IN Bengali (Índia)
  • cs-CZ Checo (República Tcheca)
  • da-DK Dinamarquês (Dinamarca)
  • de-AT Alemão austríaco
  • de-CH Alemão suíço
  • de-DE Alemão padrão (usado na Alemanha)
  • el-GR Grego moderno
  • en-AU Inglês australiano
  • en-CA Inglês canadense
  • en-GB Inglês britânico
  • en-IE Inglês irlandês
  • en-IN Inglês indiano
  • en-NZ Inglês neozelandês
  • en-US Inglês americano
  • en-ZA Inglês (África do Sul)
  • es-AR Espanhol argentino
  • es-CL Espanhol chileno
  • es-CO Espanhol colombiano
  • es-ES Espanhol castelhano (usado no nordeste da Espanha)
  • es-MX Espanhol mexicano
  • es-US Espanhol americano
  • fi-FI Finlandês (Finlândia)
  • fr-BE Francês belga
  • fr-CA Francês canadense
  • fr-CH Francês suíço
  • fr-FR Francês padrão (especialmente na França)
  • he-IL Hebraico (Israel)
  • hi-IN Hindi (Índia)
  • hu-HU Húngaro (Hungria)
  • id-ID Indonésio (Indonésia)
  • it-CH Italiano da Suíça
  • it-IT Italiano padrão (usado na Itália)
  • ja-JP Japonês (Japão)
  • ko-KR Coreano (República da Coreia)
  • nl-BE Holandês da Bélgica
  • nl-NL Holandês padrão (holandês)
  • no-NO Norueguês (Noruega)
  • pl-PL Polonês (Polônia)
  • pt-BR Português do Brasil
  • pt-PT Português europeu (português escrito e falado)
  • ro-RO Romeno (Romênia)
  • ru-RU Russo (Federação Russa)
  • sk-SK Eslovaquês (Eslováquia)
  • sv-SE Sueco (Suécia)
  • ta-IN Tâmil da Índia
  • ta-LK Tâmil do Sri Lanka
  • th-TH Tailandês (Tailândia)
  • tr-TR Turco (Turquia)
  • zh-CN China continental, caracteres simplificados
  • zh-HK Hong Kong, caracteres tradicionais
  • zh-TW Taiwan, caracteres tradicionais

opções Opções aceitas pelo parâmetro:

opções valor
currency Valores válidos: qualquer código de moeda (como "EUR", "USD", "INR" etc.).
currencyDisplay

Valores válidos:

  • "symbol"(padrão)
  • "code"
  • "name"
localeMatcher

Valores válidos:

  • "best-fit"(padrão)
  • "lookup"
maximumFractionDigits Número de 0 a 20 (padrão é 3)
maximumSignificantDigits Número de 1 a 21 (padrão é 21)
minimumFractionDigits Número de 0 a 20 (padrão é 3)
minimumIntegerDigits Número de 1 a 21 (padrão é 1)
minimumSignificantDigits Número de 1 a 21 (padrão é 21)
style

Valores válidos:

  • "currency"
  • "decimal"(padrão)
  • "percent"
useGrouping

Valores válidos:

  • "true"(padrão)
  • "false"

Valor retornado

Tipo Descrição
String Representa a string de número formatado localmente.

Detalhes técnicos

Valor retornado

A representação de número em string, determinada pela implementação, é formatada conforme as normas locais, o que pode afetar os símbolos de ponto decimal ou separador de milha.

lança

Exceção Descrição
TypeError lança uma exceção se o objeto chamado não for Number.

Suporte do navegador

toLocaleString() É uma característica do ECMAScript3 (ES3).

Todos os navegadores suportam completamente ES3 (JavaScript 1999):

Chrome IE Edge Firefox Safari Opera
Chrome IE Edge Firefox Safari Opera
Suporte Suporte Suporte Suporte Suporte Suporte