nginstack

Module: @nginstack/engine/lib/string/toHtmlString

(require("@nginstack/engine/lib/string/toHtmlString"))(value [, format] [, maxWordLength] [, crlfToBr])

Converte um valor textual, numérico ou uma data em uma string que pode ser inserida em um HTML de forma opaca.

Ela substitui os caracteres acentuados e símbolos por entidades HTML, evitando que eles sejam interpretados como tags ou outros caracteres de controle. A exceção é a sequência de caracteres CR (13) LF (10), que são substituídos por \<br\> por padrão, comportamento esse que pode ser desativado pelo parâmetro crlfToBr. Opcionalmente pode ser aplicada uma máscara de formatação para os valores numéricos.

Este método implementa o mesmo comportamento do método toHtmlString() do runtime JavaScript Ije, método esse uma extensão implementada apenas nesse runtime que não faz parte da especificação do ECMAScript. O comportamento dos parâmetros opcionais format, maxWordLength e crlfToBr varia de acordo com o tipo de value e devem ser evitados em códigos novos. Eles são mantidos apenas para garantir a compatibilidade desta função com o método Object.prototype.toHtmlString().

Ao formatar os valores, serão adotadas as configurações regionais do sistema operacional para determinar os separadores decimal e de milhares, além dos formatos de data e hora. Atualmente essas configurações são fixas no padrão "pt-br", mas esse comportamento poderá ser modificado no futuro.

Esta função também é publicada como ngin.text.toHtmlString() no escopo global, sendo preferível essa forma de uso em scripts da Virtual File System que não são módulos JavaScript.

Parameters:
Name Type Argument Default Description
value *

Valor a ser convertido em uma string HTML.
format string <optional>
 ''

Formato opcional a ser aplicado caso value seja um número ou um DBKey. Este parâmetro é ignorado para os demais tipos. Veja module:@nginstack/engine/lib/string/toFormattedString para os formatos suportados.
maxWordLength number <optional>
 1000000000

Tamanho máximo das palavras. Será inserido um espaço quando palavra ultrapassar esse tamanho, garantindo que haja assim uma quebra de linha forçada.
crlfToBr boolean <optional>
 true
Returns:

Valor convertido em uma string que pode ser inserida em um HTML.

Type
string
Example
const toHtmlString = require('@nginstack/engine/lib/string/toHtmlString');
toHtmlString('10 <> 20'); // => '10 &#60;&#62; 20'
toHtmlString('Ação'); // => 'A&#231;&#227;o'
toHtmlString(10.578, '%.3n'); // => '10,578'
toHtmlString(true); // => 'true'
toHtmlString(null); // => ''