Object.prototype.toLocaleString()

O método toLocaleString() retorna uma cadeia de caracteres (string) representando o objeto. Este método é feito para ser sobrescrito por objetos derivados para propósitos de localização específica.

Experimente

Sintaxe

obj.toLocaleString()

Valor de retorno

Uma string representando o objeto.

Descrição

toLocaleString do Object retorna o resultado da chamada toString().

Esta função é provida para dar aos objetos um método toLocaleString genérico, mesmo que nem todos os usem. Veja a lista abaixo.

Objetos sobrescrevendo toLocaleString

Exemplos

Sobrescrita do Array toLocaleString()

Em objetos Array, toLocaleString() pode ser usado para imprimir valores do arranjo como uma string, opcionalmente com identificadores de localização específicos (como símbolos monetários) atrelados a eles:

Por exemplo:

js
const testArray = [4, 7, 10];

let euroPrices = testArray.toLocaleString("fr", {
  style: "currency",
  currency: "EUR",
});
// "4,00 €,7,00 €,10,00 €"

Sobrescrita do Date toLocaleString()

Em objetos Date, toLocaleString() (en-US) é usado para imprimir datas mais apropriadas para localizações específicas:

Por exemplo:

js
const testDate = new Date(Date.now());
// "Date Fri May 29 2020 18:04:24 GMT+0100 (British Summer Time)"

let deDate = testDate.toLocaleString("de");
// "29.5.2020, 18:04:24"

var frDate = testDate.toLocaleString("fr");
//"29/05/2020 à 18:04:24"

Sobrescrita de Number toLocaleString()

Em objetos Number, toLocaleString() é usado para imprimir números para localizações específicas, e.g. com os corretos separadores:

Por exemplo:

js
const testNumber = 2901234564;
// "2901234564"

let deNumber = testNumber.toLocaleString("de");
// "2.901.234.564"

let frNumber = testNumber.toLocaleString("fr");
// "2 901 234 564"

Especificações

Specification
ECMAScript Language Specification
# sec-object.prototype.tolocalestring

Compatibilidade com navegadores

BCD tables only load in the browser

Veja também