fenextjs-validator
Advanced tools
Clase que proporciona validación de datos en TypeScript/JavaScript.
FenextjsValidatorClassFunción para crear una instancia de la clase FenextjsValidatorClass y obtener un validador.
Clase que proporciona validación de datos en TypeScript/JavaScript.
Kind: global class
FenextjsValidatorClassFenextjsValidatorClassFenextjsValidatorClassstring | undefinedstringFenextjsValidatorClassConstructor 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". |
FenextjsValidatorClassMétodo para establecer el nombre asociado a la instancia de FenextjsValidatorClass.
Kind: instance method of FenextjsValidatorClass
Returns: FenextjsValidatorClass - - La instancia actual de la clase FenextjsValidatorClass, lo que permite el encadenamiento de métodos.
| Param | Type | Description |
|---|---|---|
| name | string | El nombre a establecer para la instancia actual de FenextjsValidatorClass. |
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. |
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.
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.
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.
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.
FenextjsValidatorClassMétodo para habilitar la validación de longitud. Establece la regla de que los datos deben tener una longitud específica.
Kind: instance method of FenextjsValidatorClass
Returns: FenextjsValidatorClass - - La instancia actual de la clase FenextjsValidatorClass, lo que permite el encadenamiento de métodos.
| Param | Type | Description |
|---|---|---|
| length | number | La longitud que deben tener los datos para que la validación sea válida. |
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.
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. |
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. |
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. |
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. |
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. |
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. |
FenextjsValidatorClassMétodo para habilitar la comparación de valores de referencia. Establece la regla de que los datos deben ser iguales a otro valor de referencia almacenado en la instancia.
Kind: instance method of FenextjsValidatorClass
Returns: FenextjsValidatorClass - - La instancia actual de la clase FenextjsValidatorClass, lo que permite el encadenamiento de métodos.
| Param | Type | Description |
|---|---|---|
| refKey | string | La clave que identifica el valor de referencia almacenado en la instancia para la comparación. |
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. |
string | undefinedNombre asociado a la instancia de FenextjsValidatorClass.
Kind: static property of FenextjsValidatorClass
stringNombre asociado a la instancia de FenextjsValidatorClass.
Kind: static property of FenextjsValidatorClass
FenextjsValidatorClassEl padre de la instancia actual de FenextjsValidatorClass.
Kind: static property of FenextjsValidatorClass
FenextjsValidatorClassFunció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". |
// Importar la función FenextjsValidator
import { FenextjsValidator } from "fenextjs-validator";
const ValidateIsRequired = FenextjsValidator()
.setName("ValidateIsRequired") // Establecer un nombre para esta instancia de validador (opcional)
.isRequired() // Establecer la regla "isRequired", que verifica si el valor es requerido (no puede estar vacío o ser nulo).
.onValidate(""); // Realizar la validación con el valor "" (cadena vacía)
console.log(ValidateIsRequired);
// En este caso, el resultado de la validación será un objeto de tipo ErrorInputRequired.
// El mensaje de este objeto puede ser algo como "Input Required [ValidateIsRequired]".
// Esto indica que el valor proporcionado para la validación está vacío, lo que no cumple con la regla de "isRequired".
// Nota: Si el valor proporcionado en "onValidate()" hubiera sido diferente de una cadena vacía,
// la validación habría sido exitosa, y el resultado habría sido "true" (indicando que el valor es válido).
const ValidateIsBoolean = FenextjsValidator()
.setName("ValidateIsBoolean") // Establecer un nombre para esta instancia de validador (opcional)
.isBoolean() // Establecer la regla "isBoolean", que verifica si el valor es un booleano.
.onValidate("false"); // Realizar la validación con el valor "false" (cadena)
console.log(ValidateIsBoolean);
// En este caso, el resultado de la validación será un objeto de tipo ErrorInputInvalid.
// El mensaje de este objeto puede ser algo como "Invalid Input [ValidateIsBoolean]".
// Esto indica que el valor proporcionado para la validación ("false" en este caso) no es un booleano válido.
// Nota: Si el valor proporcionado en "onValidate()" hubiera sido "true" (valor booleano válido),
// la validación habría sido exitosa, y el resultado habría sido "true" (indicando que el valor es válido).
const ValidateIsEqual = FenextjsValidator()
.setName("ValidateIsEqual") // Establecer un nombre para esta instancia de validador (opcional)
.isEqual("aaaa") // Establecer la regla "isEqual", que verifica si el valor es igual al valor "aaaa".
.onValidate("bbbb"); // Realizar la validación con el valor "bbbb" (cadena)
console.log(ValidateIsEqual);
// En este caso, el resultado de la validación será un objeto de tipo ErrorInputNotEqual.
// El mensaje de este objeto puede ser algo como "Not Equal Input [ValidateIsEqual]".
// Esto indica que el valor proporcionado para la validación ("bbbb" en este caso) no es igual al valor esperado "aaaa".
// Nota: Si el valor proporcionado en "onValidate()" hubiera sido "aaaa" (valor igual al valor esperado),
// la validación habría sido exitosa, y el resultado habría sido "true" (indicando que el valor es válido).
const ValidateIsNumber = FenextjsValidator()
.setName("ValidateIsNumber") // Establecer un nombre para esta instancia de validador (opcional)
.isNumber() // Establecer la regla "isNumber", que verifica si el valor es un número.
.onValidate("not Number"); // Realizar la validación con el valor "not Number" (cadena)
console.log(ValidateIsNumber);
// En este caso, el resultado de la validación será un objeto de tipo ErrorInputInvalid.
// El mensaje de este objeto puede ser algo como "Invalid Input [FenextjsValidator]".
// Esto indica que el valor proporcionado para la validación ("not Number" en este caso) no es un número válido.
// Nota: Si el valor proporcionado en "onValidate()" hubiera sido un número, la validación habría sido exitosa,
// y el resultado habría sido "true" (indicando que el valor es válido).
const ValidateIsString = FenextjsValidator()
.setName("ValidateIsString") // Establecer un nombre para esta instancia de validador (opcional)
.isString() // Establecer la regla "isString", que verifica si el valor es una cadena de texto.
.onValidate({}); // Realizar la validación con el valor {} (objeto)
console.log(ValidateIsString);
// En este caso, el resultado de la validación será un objeto de tipo ErrorInputInvalid.
// El mensaje de este objeto puede ser algo como "Invalid Input [FenextjsValidator]".
// Esto indica que el valor proporcionado para la validación ({}, un objeto) no es una cadena de texto válida.
// Nota: Si el valor proporcionado en "onValidate()" hubiera sido una cadena de texto, la validación habría sido exitosa,
// y el resultado habría sido "true" (indicando que el valor es válido).
const ValidateIsObject = FenextjsValidator()
.setName("ValidateIsString") // Establecer un nombre para esta instancia de validador (opcional)
.isObject({
key1: FenextjsValidator() // Establecer la regla "isString" y "isEqual" para la propiedad "key1"
.setName("ValidateIsString.key1") // Establecer un nombre para esta subinstancia de validador (opcional)
.isString() // Establecer la regla "isString", que verifica si el valor es una cadena de texto.
.isEqual("aa"), // Establecer la regla "isEqual", que verifica si el valor es igual a "aa".
})
.onValidate({
key1: "not Equal", // Realizar la validación con el objeto { key1: "not Equal" }
// Nota: Si el valor de la propiedad "key1" hubiera sido "aa" (una cadena de texto igual a "aa"),
// la validación habría sido exitosa, y el resultado habría sido "true" (indicando que el valor es válido).
});
console.log(ValidateIsObject);
// En este caso, el resultado de la validación será un objeto de tipo ErrorInputNotEqual.
// El mensaje de este objeto puede ser algo como "Not Equal Input [ValidateIsString.key1]".
// Esto indica que el valor proporcionado para la validación de la propiedad "key1" ("not Equal" en este caso)
// no es igual al valor esperado "aa" definido en la regla "isEqual".
// Además, el mensaje también incluye el nombre del validador asociado ("ValidateIsString.key1")
// para indicar que la propiedad "key1" del objeto no cumple con la regla de validación "isString" e "isEqual".
const ValidateIsArray = FenextjsValidator()
.setName("ValidateIsArray") // Establecer un nombre para esta instancia de validador (opcional)
.isArray(
// Establecer la regla "isArray", que verifica si el valor es un array.
FenextjsValidator().isString().isEqual("aa"), // Establecer la regla "isString" y "isEqual" para los elementos del array
)
.onValidate(["aa", "not equal"]); // Realizar la validación con el array ["aa", "not equal"]
console.log(ValidateIsArray);
// En este caso, el resultado de la validación será un objeto de tipo ErrorInputNotEqual.
// El mensaje de este objeto puede ser algo como "Not Equal Input [ValidateIsArray.1]".
// Esto indica que el valor proporcionado para la validación del segundo elemento del array ("not equal" en este caso)
// no es igual al valor esperado "aa" definido en la regla "isEqual".
// Además, el mensaje también incluye el nombre del validador asociado ("ValidateIsArray.1")
// para indicar que el segundo elemento del array no cumple con la regla de validación "isString" e "isEqual".
const ValidateIsMin = FenextjsValidator()
.setName("ValidateIsMin") // Establecer un nombre para esta instancia de validador (opcional)
.isString() // Establecer la regla "isString", que verifica si el valor es una cadena de texto.
.isMin(3) // Establecer la regla "isMin", que verifica si la longitud de la cadena es mayor o igual a 3 caracteres.
.onValidate("NO"); // Realizar la validación con la cadena "NO"
console.log(ValidateIsMin);
// En este caso, el resultado de la validación será un objeto de tipo ErrorInputInvalid.
// El mensaje de este objeto puede ser algo como "Invalid Input [ValidateIsMin]".
// Esto indica que el valor proporcionado para la validación ("NO" en este caso) no cumple con la regla de longitud mínima.
// Nota: Si el valor proporcionado en "onValidate()" hubiera sido una cadena con al menos 3 caracteres (por ejemplo, "YES"),
// la validación habría sido exitosa, y el resultado habría sido "true" (indicando que el valor es válido).
const ValidateIsMinOrEqual = FenextjsValidator()
.setName("ValidateIsMinOrEqual") // Establecer un nombre para esta instancia de validador (opcional)
.isString() // Establecer la regla "isString", que verifica si el valor es una cadena de texto.
.isMinOrEqual(3) // Establecer la regla "isMinOrEqual", que verifica si la longitud de la cadena es mayor o igual a 3 caracteres.
.onValidate("aaa"); // Realizar la validación con la cadena "aaa"
console.log(ValidateIsMinOrEqual);
// En este caso, el resultado de la validación será "true".
// Esto indica que el valor proporcionado para la validación ("aaa" en este caso) cumple con la regla de longitud mínima (3 caracteres).
// Nota: Si el valor proporcionado en "onValidate()" hubiera sido una cadena con menos de 3 caracteres (por ejemplo, "aa"),
// la validación habría sido exitosa, y el resultado también habría sido "true" (indicando que el valor es válido).
const ValidateIsMax = FenextjsValidator()
.setName("ValidateIsMax") // Establecer un nombre para esta instancia de validador (opcional)
.isNumber() // Establecer la regla "isNumber", que verifica si el valor es un número.
.isMax(3) // Establecer la regla "isMax", que verifica si el valor numérico es menor o igual a 3.
.onValidate(20); // Realizar la validación con el valor numérico 20
console.log(ValidateIsMax);
// En este caso, el resultado de la validación será un objeto de tipo ErrorInputValueTooHigh.
// El mensaje de este objeto puede ser algo como "Value Too High [ValidateIsMax]".
// Esto indica que el valor proporcionado para la validación (20 en este caso) es mayor que el valor máximo permitido (3).
// Nota: Si el valor proporcionado en "onValidate()" hubiera sido un número menor o igual a 3 (por ejemplo, 2),
// la validación habría sido exitosa, y el resultado habría sido "true" (indicando que el valor es válido).
const ValidateIsMaxOrEqual = FenextjsValidator()
.setName("ValidateIsMaxOrEqual") // Establecer un nombre para esta instancia de validador (opcional)
.isString() // Establecer la regla "isString", que verifica si el valor es una cadena de texto.
.isMaxOrEqual(3) // Establecer la regla "isMaxOrEqual", que verifica si la longitud de la cadena es menor o igual a 3 caracteres.
.onValidate("aaa"); // Realizar la validación con la cadena "aaa"
console.log(ValidateIsMaxOrEqual);
// En este caso, el resultado de la validación será "true".
// Esto indica que el valor proporcionado para la validación ("aaa" en este caso) cumple con la regla de longitud máxima o es igual a 3 caracteres.
// Nota: Si el valor proporcionado en "onValidate()" hubiera sido una cadena con más de 3 caracteres (por ejemplo, "aaaa"),
// la validación habría sido exitosa, y el resultado también habría sido "true" (indicando que el valor es válido).
const ValidateIsDate = FenextjsValidator()
.setName("ValidateIsDate") // Establecer un nombre para esta instancia de validador (opcional)
.isDate() // Establecer la regla "isDate", que verifica si el valor es una fecha válida.
.isMax(new Date(100)) // Establecer la regla "isMax", que verifica si la fecha es anterior o igual a la fecha máxima (100).
.onValidate(new Date(10)); // Realizar la validación con la fecha new Date(10)
console.log(ValidateIsDate);
// En este caso, el resultado de la validación será un objeto de tipo ErrorInputValueTooHigh.
// El mensaje de este objeto puede ser algo como "Value Too High [ValidateIsDate]".
// Esto indica que la fecha proporcionada para la validación (new Date(10) en este caso) es posterior a la fecha máxima permitida (new Date(100)).
// Nota: Si la fecha proporcionada en "onValidate()" hubiera sido una fecha anterior o igual a new Date(100),
// la validación habría sido exitosa, y el resultado habría sido "true" (indicando que el valor es válido).
const ValidateIsLength = FenextjsValidator()
.setName("ValidateIsLength") // Establecer un nombre para esta instancia de validador (opcional)
.isLength(4) // Establecer la regla "isLength", que verifica si la longitud de la cadena es igual a 4 caracteres.
.onValidate("tesing"); // Realizar la validación con la cadena "tesing"
console.log(ValidateIsLength);
// En este caso, el resultado de la validación será un objeto de tipo ErrorInputInvalid.
// El mensaje de este objeto puede ser algo como "Invalid Input [ValidateIsLength]".
// Esto indica que la cadena proporcionada para la validación ("tesing" en este caso) no cumple con la regla de longitud (4 caracteres).
// Nota: Si la cadena proporcionada en "onValidate()" hubiera sido una cadena de 4 caracteres (por ejemplo, "test"),
// la validación habría sido exitosa, y el resultado habría sido "true" (indicando que el valor es válido).
// Definir la interfaz que describe la estructura de datos para la validación
interface ValidateIsCompareRefInteface {
keyA: string;
keyB: string;
}
const ValidateIsCompareRef = FenextjsValidator<ValidateIsCompareRefInteface>()
.setName("ValidateIsCompareRef") // Establecer un nombre para esta instancia de validador (opcional)
.isObject({
keyA: FenextjsValidator()
.setName("ValidateIsCompareRef.keyA") // Establecer un nombre para esta instancia de validador (opcional)
.isString() // Establecer la regla "isString", que verifica si el valor es una cadena de texto.
.isCompareRef("keyB"), // Establecer la regla "isCompareRef", que compara el valor de "keyA" con el valor de "keyB".
keyB: FenextjsValidator()
.setName("ValidateIsCompareRef.keyB") // Establecer un nombre para esta instancia de validador (opcional)
.isString(), // Establecer la regla "isString", que verifica si el valor es una cadena de texto.
})
.onValidate({
keyA: "aaa",
keyB: "bbb",
}); // Realizar la validación con el objeto { keyA: "aaa", keyB: "bbb" }
console.log(ValidateIsCompareRef);
// En este caso, el resultado de la validación será "true".
// Esto indica que el objeto proporcionado para la validación cumple con todas las reglas definidas en la estructura de datos ValidateIsCompareRefInteface.
// Nota: Si el valor proporcionado en "onValidate()" hubiera sido un objeto con valores diferentes para "keyA" y "keyB",
// la validación habría sido fallida, y el resultado habría sido un objeto de tipo ErrorInputNotEqual,
// que indica que los valores de "keyA" y "keyB" no son iguales.
Email blancofrancisco34@gmail.com
FAQs
## Import
The npm package fenextjs-validator receives a total of 206 weekly downloads. As such, fenextjs-validator popularity was classified as not popular.
We found that fenextjs-validator demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Fluent Assertions is facing backlash after dropping the Apache license for a commercial model, leaving users blindsided and questioning contributor rights.
Research
Security News
Socket researchers uncover the risks of a malicious Python package targeting Discord developers.
Security News
The UK is proposing a bold ban on ransomware payments by public entities to disrupt cybercrime, protect critical services, and lead global cybersecurity efforts.