String.raw()

O Método String.raw() estático é uma função tag de modelos literais, similar ao prefixo r no Python ou o prefixo @ no C# para string literais (ainda sim, existe uma diferença: veja explicações nessa discussão). Este é usado para pegar as strings no formato "cru" de modelos literais, isto é, substituições (ex:. ${foo}) são processados, mas "escapes" (ex:. \n) não são.

Syntax

String.raw(callSite, ...sub)

String.raw`templateString`

Parameters

callSite

 modelo bem-formatado de objeto de local de chamada, como { raw: ['foo', 'bar', 'baz'] }.

...substitutions

Contém os valores das substituições.

templateString

Um modelo string, opcionalmente com substituições (${...}).

Return value

A forma crua de uma String de um modelo string dado.

Exceptions

TypeError

Um TypeError é jogado se o primeiro argumento não é um Objeto bem formado.

Description

In most cases, String.raw() is used with template strings. The first syntax mentioned above is only rarely used, because the JavaScript engine will call this with proper arguments for you, just like with other tag functions.

String.raw() is the only built-in tag function of template strings; it works just like the default template function and performs concatenation. You can even re-implement it with normal JavaScript code.

Examples

Using String.raw()

String.raw`Hi\n${2+3}!`;
// 'Hi\n5!', the character after 'Hi'
// is not a newline character,
// '\' and 'n' are two characters.

String.raw`Hi\u000A!`;
// 'Hi\u000A!', same here, this time we will get the
//  \, u, 0, 0, 0, A, 6 characters.
// All kinds of escape characters will be ineffective
// and backslashes will be present in the output string.
// You can confirm this by checking the .length property
// of the string.

let name = 'Bob';
String.raw`Hi\n${name}!`;
// 'Hi\nBob!', substitutions are processed.

// Normally you would not call String.raw() as a function,
// but to simulate `t${0}e${1}s${2}t` you can do:
String.raw({ raw: 'test' }, 0, 1, 2); // 't0e1s2t'
// Note that 'test', a string, is an array-like object
// The following is equivalent to
// `foo${2 + 3}bar${'Java' + 'Script'}baz`
String.raw({
  raw: ['foo', 'bar', 'baz'] 
}, 2 + 3, 'Java' + 'Script'); // 'foo5barJavaScriptbaz'

Specifications

Browser compatibility

The compatibility table in this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.

See also

• Template strings
• String
• Lexical grammar