Class Index | File Index

Classes


Class ngin.router.RoutesValidator


Defined in: routesvalidator.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
Define a estrutura de validação para rotas.
Method Summary
Method Attributes Method Name and Description
 
validateDirectory(directoryKey, opt_product)
Valida todos os arquivos de definição de rotas contidas no diretório informado.
 
Valida um arquivo de definição de rotas.
 
validateSource(content)
Verifica a possibilidade de criação de objetos de rota.
Class Detail
ngin.router.RoutesValidator()
Define a estrutura de validação para rotas.
Method Detail
{{quantity: number|errors: Array}} validateDirectory(directoryKey, opt_product)
Valida todos os arquivos de definição de rotas contidas no diretório informado.
Parameters:
{number} directoryKey
Chave numérica referente ao diretório dentro da VFS.
{number} opt_product
Chave do produto (faixa de chaves) do qual deseja-se validar a definição das rotas. Quando informado, apenas os arquivos de definição de rotas associados a esse produto serão validados.
Returns:
{{quantity: number|errors: Array}} Objeto que contém as propriedades (quantity, errors), onde a propriedade quantity contem a quantidade total rotas por diretório e a propriedade errors possui uma lista de erros pertencentes a todas as rotas contidas no diretório informado.

{{quantity: number|errors: Array}} validateFile(path)
Valida um arquivo de definição de rotas.
Parameters:
{string|number} path
Caminho do arquivo na UFS ou chave da VFS.
Returns:
{{quantity: number|errors: Array}} Objeto que contém as seguintes propriedades (quantity, errors), onde a propriedade quantity contem a quantidade de rotas testadas e a propriedade errors possui uma lista de erros das rotas.

{{quantity: number|errors: Array}} validateSource(content)
Verifica a possibilidade de criação de objetos de rota.
Parameters:
{string} content
Conteúdo da rota a ser validada.
Returns:
{{quantity: number|errors: Array}} Objeto que contém as propriedades (quantity, errors), onde a propriedade quantity contem a quantidade de rotas testadas e a propriedade erros possui uma lista de errors pertencentes as rotas.

Documentation generated by JsDoc Toolkit 2.4.0 on Tue Aug 23 2016 16:18:12 GMT-0300 (GFT)