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

Methods


<inner> validateString(value, typeId [, max] [, min] [, caseType] [, classKey] [, dateFormat])

Valida e retorna um texto convertido no tipo desejado.

Essa função busca apenas dar compatibilidade com a antiga função global validateString e seu uso não é mais recomendado. Observar que as funções de tratamento devem ser incluídas em conjunto com esse módulo, como os arquivos Validators.iejs (-1898144910) e validators.js (-1899925557) das Virtual File System.

Parameters:
Name Type Argument Description
value *

Valor a ser validado.

typeId string

Tipo desejado para o valor informado. Os tipos devem ser registrados por meio da função validateString.registerType. Os seguintes tipos são automaticamente definidos pelo Engine: 'memo', 'blob', 'char(N)', 'string', 'numeric', 'number', 'integer', 'interval', 'date', 'email', 'boolean', 'lookup' e 'color'. Outros tipos podem ser definidos por outras bibliotecas e módulos.

max number | Date <optional>

Valor máximo aceito. Cada tipo poderá dar um significado diferente para esse parâmetro, podendo inclusive ignorá-lo. De uma forma geral, será considerado o valor máximo para tipos numéricos e o tamanho máximo para tipos textuais.

min number | Date <optional>

Valor mínimo aceito. Cada tipo poderá dar um significado diferente para esse parâmetro, podendo inclusive ignorá-lo. De uma forma geral, será considerado o valor mínimo para tipos numéricos e o tamanho mínimo para tipos textuais.

caseType string <optional>

Para tipos textuais, indicará o tipo de case desejado. Valores possíveis: 'upper', 'lower', 'name', 'title' e 'statement'. Ver module:@nginstack/engine/lib/string/adjustCase para mais detalhes.

classKey number <optional>

Para o tipo lookup, indica a classe onde podem ser encontrados os registros indicados por value.

dateFormat DateFormat <optional>

Para o tipo date, indica o formato aceito de datas.

Returns:

Retorna value convertido no tipo desejado.

Type
*