String.prototype.toLocaleUpperCase()

O método toLocaleUpperCase() retorna o valor da string em maiúsculas, de acordo com qualquer mapeamento de caixa de texto específico da localidade.

Sintaxe

str.toLocaleUpperCase()
str.toLocaleUpperCase(locale)
str.toLocaleUpperCase([locale, locale, ...])

Parâmetros

locale
Opcional. O parâmetro locale indica a localização a ser usada para converter para maiúsculas de acordo com qualquer mapeamento de caixa de texto específico da localidade. Se vários locais forem fornecidos em um Array, a melhor localidade disponível é usada. A localidade padrão é a localidade atual do ambiente do host.

Valor retornado

Uma nova string que representa a string original convertida em maiúsculas, de acordo com qualquer mapeamento de caixa de texto específico da localidade.

Exceções

  • Um RangeError ("invalid language tag: xx_yy") é lançado se um argumento locale não for uma tag de idioma válido.
  • Um TypeError ("invalid element in locales argument") é lançado se um elemento do array não for do tipo string.

Descrição

O método toLocaleUpperCase() retorna o valor da string convertida em maiúsculas de acordo com qualquer mapeamento de caixa de texto específico da localidade. toLocaleUpperCase() não afeta o valor da string em si. Na maioria dos casos, ele produzirá o mesmo resultado que toUpperCase(), mas para alguns locais, como turco, cujos mapeamentos de caixa de texto não seguem o mapeamento de caixa de texto padrão em Unicode, pode haver um resultado diferente.

Observe também que a conversão não é necessariamente um mapeamento de caracteres 1:1, pois alguns caracteres podem resultar em dois (ou até mais) caracteres quando transformados em maiúsculas. Portanto, o comprimento da string resultante pode ser diferente do comprimento da string de entrada. Isso também implica que a conversão não é estável, então, por exemplo, o seguinte pode retornar false:
x.toLocaleLowerCase() === x.toLocaleUpperCase(). toLocaleLowerCase()

Exemplos

Usando toLocaleUpperCase()

'alfabeto'.toLocaleUpperCase(); // 'ALFABETO'

'Gesäß'.toLocaleUpperCase(); // 'GESÄSS'

'i\u0307'.toLocaleUpperCase('lt-LT'); // 'I'

let locales = ['lt', 'LT', 'lt-LT', 'lt-u-co-phonebk', 'lt-x-lietuva'];
'i\u0307'.toLocaleUpperCase(locales); // 'I'

Especificações

Compatibilidade de navegador

BCD tables only load in the browser

Veja também