Package Exports
- fenextjs-validator
- fenextjs-validator/cjs/index.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (fenextjs-validator) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
fenextjs-validator
Classes
- FenextjsValidatorClass
Clase que proporciona validación de datos en TypeScript/JavaScript.
Functions
- FenextjsValidator(props) ⇒
FenextjsValidatorClass
Función para crear una instancia de la clase FenextjsValidatorClass y obtener un validador.
FenextjsValidatorClass
Clase que proporciona validación de datos en TypeScript/JavaScript.
Kind: global class
- FenextjsValidatorClass
- new FenextjsValidatorClass(props)
- instance
- static
- .FenextjsValidatorClass :
string
|undefined
- .FenextjsValidatorClass :
string
- .FenextjsValidatorClass :
FenextjsValidatorClass
- .FenextjsValidatorClass :
new FenextjsValidatorClass(props)
Constructor de la clase FenextjsValidatorClass.
Param | Type | Description |
---|---|---|
props | FenextjsValidatorClassConstructorProps |
Opcional. Propiedades que se pueden pasar al constructor. Un objeto que contiene las propiedades del constructor. Por ejemplo, puede contener la propiedad "name". |
fenextjsValidatorClass.isEqual(d) ⇒
Método para definir la validación "isEqual". Establece la regla de que los datos deben ser iguales al valor especificado.
Kind: instance method of FenextjsValidatorClass
Returns: Instancia de FenextjsValidatorClass.
Param | Description |
---|---|
d | Valor a comparar con los datos. |
fenextjsValidatorClass.isRequired() ⇒
Método para habilitar la validación "isRequired". Establece la regla de que los datos deben estar presentes y no ser nulos o indefinidos.
Kind: instance method of FenextjsValidatorClass
Returns: Instancia de FenextjsValidatorClass.
fenextjsValidatorClass.isBoolean() ⇒
Método para habilitar la validación "isBoolean". Establece la regla de que los datos deben ser de tipo booleano.
Kind: instance method of FenextjsValidatorClass
Returns: Instancia de FenextjsValidatorClass.
fenextjsValidatorClass.isNumber() ⇒
Método para habilitar la validación "isNumber". Establece la regla de que los datos deben ser de tipo número.
Kind: instance method of FenextjsValidatorClass
Returns: Instancia de FenextjsValidatorClass.
fenextjsValidatorClass.isString() ⇒
Método para habilitar la validación "isString". Establece la regla de que los datos deben ser de tipo cadena (string).
Kind: instance method of FenextjsValidatorClass
Returns: Instancia de FenextjsValidatorClass.
fenextjsValidatorClass.isDate() ⇒
Método para habilitar la validación "isDate". Establece la regla de que los datos deben ser de tipo Date (fecha).
Kind: instance method of FenextjsValidatorClass
Returns: Instancia de FenextjsValidatorClass.
fenextjsValidatorClass.isObject(obj) ⇒
Método para habilitar la validación "isObject". Establece la regla de que los datos deben ser de tipo objeto.
Kind: instance method of FenextjsValidatorClass
Returns: Instancia de FenextjsValidatorClass.
Param | Description |
---|---|
obj | Objeto con las reglas de validación para cada propiedad del objeto. |
fenextjsValidatorClass.isArray(item) ⇒
Método para habilitar la validación "isArray". Establece la regla de que los datos deben ser un array.
Kind: instance method of FenextjsValidatorClass
Returns: Instancia de FenextjsValidatorClass.
Param | Description |
---|---|
item | Instancia de FenextjsValidatorClass que define las reglas de validación para cada elemento del array. |
fenextjsValidatorClass.isMin(min) ⇒
Método para habilitar la validación "isMin". Establece la regla de que los datos deben ser mayores que un valor específico.
Kind: instance method of FenextjsValidatorClass
Returns: Instancia de FenextjsValidatorClass.
Param | Description |
---|---|
min | Valor mínimo que los datos deben superar. |
fenextjsValidatorClass.isMinOrEqual(min) ⇒
Método para habilitar la validación "isMinOrEqual". Establece la regla de que los datos deben ser mayores o iguales que un valor específico.
Kind: instance method of FenextjsValidatorClass
Returns: Instancia de FenextjsValidatorClass.
Param | Description |
---|---|
min | Valor mínimo que los datos deben superar o igualar. |
fenextjsValidatorClass.isMax(max) ⇒
Método para habilitar la validación "isMax". Establece la regla de que los datos deben ser menores que un valor específico.
Kind: instance method of FenextjsValidatorClass
Returns: Instancia de FenextjsValidatorClass.
Param | Description |
---|---|
max | Valor máximo que los datos deben ser menores que él. |
fenextjsValidatorClass.isMaxOrEqual(max) ⇒
Método para habilitar la validación "isMaxOrEqual". Establece la regla de que los datos deben ser menores o iguales que un valor específico.
Kind: instance method of FenextjsValidatorClass
Returns: Instancia de FenextjsValidatorClass.
Param | Description |
---|---|
max | Valor máximo que los datos deben ser menores o igual que él. |
fenextjsValidatorClass.onValidate(d) ⇒
Método para validar los datos proporcionados según las reglas establecidas. Ejecuta todas las reglas de validación habilitadas previamente para los datos.
Kind: instance method of FenextjsValidatorClass
Returns: True si los datos cumplen con todas las reglas de validación; de lo contrario, devuelve el error que indica la regla de validación que falló.
Param | Description |
---|---|
d | Datos que se deben validar. |
FenextjsValidatorClass.FenextjsValidatorClass : string
| undefined
Nombre asociado a la instancia de FenextjsValidatorClass.
Kind: static property of FenextjsValidatorClass
FenextjsValidatorClass.FenextjsValidatorClass : string
Nombre asociado a la instancia de FenextjsValidatorClass.
Kind: static property of FenextjsValidatorClass
FenextjsValidatorClass.FenextjsValidatorClass : FenextjsValidatorClass
El padre de la instancia actual de FenextjsValidatorClass.
Kind: static property of FenextjsValidatorClass
FenextjsValidator(props) ⇒ FenextjsValidatorClass
Función para crear una instancia de la clase FenextjsValidatorClass y obtener un validador.
Kind: global function
Returns: FenextjsValidatorClass
- - Una nueva instancia de la clase FenextjsValidatorClass que se utilizará para definir reglas de validación y validar datos.
Param | Type | Description |
---|---|---|
props | FenextjsValidatorClassConstructorProps |
Opcional. Propiedades que se pueden pasar al constructor de FenextjsValidatorClass. Un objeto que contiene las propiedades del constructor de la clase FenextjsValidatorClass. Por ejemplo, puede contener la propiedad "name". |
Example
// Importar la función FenextjsValidator
import { FenextjsValidator } from "fenextjs-validator";
// Importar la función FenextjsValidator desde el archivo actual ("." representa el archivo actual)
import { FenextjsValidator } from ".";
// Ejemplo 1: Crear un validador y establecer la regla "isRequired"
const r = FenextjsValidator().isRequired().onValidate("a");
console.log(r); // Imprimir el resultado de la validación (true si es válido, ErrorInputRequired si no lo es)
// Ejemplo 2: Crear otro validador y establecer la regla "isBoolean"
const r2 = FenextjsValidator().isBoolean().onValidate(false);
console.log(r2);
// Ejemplo 3: Crear otro validador y establecer la regla "isEqual" con el valor "aaaa"
const r3 = FenextjsValidator().isEqual("aaaa").onValidate("aaaa");
console.log(r3);
// Ejemplo 4: Crear otro validador y establecer la regla "isNumber"
const r4 = FenextjsValidator().isNumber().onValidate(2);
console.log(r4);
// Ejemplo 5: Crear otro validador y establecer la regla "isString"
const r5 = FenextjsValidator().isString().onValidate("");
console.log(r5);
// Ejemplo 6: Crear otro validador y establecer la regla "isObject" con una regla de validación para la propiedad "a"
const r6 = FenextjsValidator({ name: "Obj__" })
.isObject({
a: FenextjsValidator({ name: "test__" }).isString().isEqual("aa"),
})
.onValidate({
a: "aaa",
});
console.log(r6);
//INPUT_INVALID: Invalid Input [Obj__.test__]
// Ejemplo 7: Crear otro validador y establecer la regla "isArray" con una regla de validación para los elementos del array
const r7 = FenextjsValidator()
.isArray(FenextjsValidator().isString().isEqual("aa"))
.onValidate(["aa", "aa"]);
console.log(r7);
// Ejemplo 8: Crear otro validador y establecer la regla "isString" y "isMin" (longitud mínima 3 caracteres)
const r8 = FenextjsValidator().isString().isMin(3).onValidate("aaaaa");
console.log(r8);
// Ejemplo 9: Crear otro validador y establecer la regla "isString" y "isMinOrEqual" (longitud mínima 3 caracteres o igual)
const r9 = FenextjsValidator().isString().isMinOrEqual(3).onValidate("aaa");
console.log(r9);
// Ejemplo 10: Crear otro validador y establecer la regla "isNumber" y "isMax" (valor máximo 3)
const r10 = FenextjsValidator().isNumber().isMax(3).onValidate(2);
console.log(r10);
// Ejemplo 11: Crear otro validador y establecer la regla "isString" y "isMaxOrEqual" (longitud máxima 3 caracteres o igual)
const r11 = FenextjsValidator().isString().isMaxOrEqual(3).onValidate("aaa");
console.log(r11);
// Ejemplo 12: Crear otro validador y establecer la regla "isDate" y "isMax" (fecha máxima: 100)
const r12 = FenextjsValidator({ name: "date" })
.isDate()
.isMax(new Date(100))
.onValidate(new Date(10));
console.log(r12);
Developer
Email blancofrancisco34@gmail.com