nginstack

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

Methods

<inner> registerType(type, handle)

Registra um tipo de valor a ser suportado pela função validateString.

Parameters:
Name Type Description
type string | Array.<string>

Identificação do tipo.
handle function

Função que irá receber os mesmos parâmetros de validateString e é responsável por validar e retornar o valor no tipo desejado.

<inner> validateString(value, type [, options])

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.

Para fins de compatibilidade, este método também aceita os parâmetros utilizando a seguinte assinatura:

validateString(value, type, max, min, caseType, classKey, displayFormat)
Parameters:
Name Type Argument Description
value *

Valor a ser validado.
type string

Tipo desejado para o valor informado. Os seguintes tipos são suportados: 'string', 'int64', 'int32', 'number', 'interval', 'date', 'time', 'boolean', 'email', 'cep', 'phone', 'lookup', 'color', 'pis', 'cpf', 'cnpj', 'cpfcnpj', 'angle', 'latitude', 'longitude', 'comp', 'banco', 'agencia' e 'cheque'.

Para fins de compatibilidade, os seguintes tipos também são aceitos:

  • 'memo', 'blob' e qualquer tipo que contenha 'char' (ex: 'varchar') são tratados como 'string';
  • 'numeric' é tratado como 'number';
  • 'integer' é tratado como 'int64';
  • 'hora' é tratado como 'time';
  • 'fone' é tratado como 'phone'.
  • 'cgccpf' é tratado como 'cpfcnpj'.
options Object <optional>

Opções de validação.

Properties
Name Type Argument Description
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.
displayFormat DateFormat | LatitudeFormat | LongitudeFormat | AngleFormat <optional>

Indica o formato aceito para o campo.
locale 'pt-br' | 'en-us' <optional>

Localidade a ser utilizada. Por padrão é 'pt-br'.
Returns:

Retorna value convertido no tipo desejado.

Type
*