Base de conhecimentoCentro de Exames
PT · PTPortuguês (Portugal)
Escolher idioma13

CKTIS / JavaScript

Sintaxe dos literais de modelo com etiqueta

Uma função de etiqueta recebe separadamente os segmentos de texto e os valores de substituição. O valor devolvido pela função é o valor de toda a expressão.

Versão: ECMAScript 2024 and the current web platform; runtime support varies

Sintaxe

tag`prefix ${expression} suffix`
obj.tag`prefix ${expression} suffix`

function tag(strings, ...values) { /* process the parts and return a value */ }

Em tag`prefix ${expression} suffix` , a expressão tag precede um literal delimitado por acentos graves. O JavaScript chama a função de etiqueta sem construir primeiro uma cadeia de caracteres. Já em tag(`prefix ${expression} suffix`), o literal sem etiqueta converte os valores de substituição em cadeias e junta-os ao texto: a função recebe uma única cadeia já construída.

O primeiro argumento da função de etiqueta é o array strings com os segmentos literais. O JavaScript avalia as expressões ${...} da esquerda para a direita antes da chamada e passa os valores como argumentos separados, sem os converter em cadeias. Um parâmetro rest como ...values permite reuni-los. Com n substituições existem n + 1 segmentos, incluindo os vazios. O valor da expressão é o que a função devolve, não necessariamente uma cadeia.

Em strings[i], as sequências de escape são interpretadas (cooked); strings.raw[i] conserva a sua grafia. Uma sequência de escape mal formada faz com que todo o elemento correspondente de strings seja undefined num literal com etiqueta; sem etiqueta, provoca um SyntaxError. Ambos os arrays estão congelados. Avaliações repetidas da mesma ocorrência do literal no mesmo realm ECMAScript reutilizam o mesmo array strings. Outra ocorrência tem o seu próprio array, mesmo que o texto seja idêntico.

Em obj.tag`x` , a chamada passa obj como valor de this, tal como numa chamada normal a um método. Se o valor da etiqueta não puder ser chamado, ocorre um TypeError. O uso direto do encadeamento opcional, como em obj?.tag`x` , provoca um SyntaxError.

Esta sintaxe da linguagem está definida no ECMAScript 2024; não é uma API do navegador. Verifica se é suportada no ambiente de execução de destino. Uma etiqueta não sanitiza os dados por si só: não passes resultados não fiáveis a innerHTML sem uma sanitização de HTML adequada.

Exemplos

function inspect(strings, value) {
  return {
    cookedLength: strings[0].length,
    rawLength: strings.raw[0].length,
    valueType: typeof value,
    tail: strings[1],
  };
}

console.log(JSON.stringify(inspect`\n${7}`));

Resultado

{"cookedLength":1,"rawLength":2,"valueType":"number","tail":""}

`inspect` devolve um objeto que `JSON.stringify` converte numa cadeia para apresentação. `\n` é um único carácter de mudança de linha em `strings[0]`, mas são dois caracteres em `strings.raw[0]`. O valor `7` continua a ser um número e o último segmento está vazio.

Lições relacionadas

  • JavaScript · Lição 28 · Avançado · Versão: 4

Fontes