validator-ec
v1.2.0
Published
Colección de validadores de datos comunes en Ecuador desarrollada en TypeScript.
Downloads
49
Maintainers
Readme
validator-ec
Colección de validadores de datos comunes en Ecuador desarrollada en TypeScript.
Actualmente, cuenta con validadores para cédulas de identidad ecuatorianas, números de RUC (Registro Único de Contribuyentes) y códigos postales.
Características
- Compatibilidad con TypeScript y JavaScript (ES Modules y CommonJS).
- Fácil integración en cualquier proyecto frontend o backend.
- Extensible, permitiendo agregar más validadores en el futuro.
Instalación
Puedes instalar validator-ec utilizando el gestor de paquetes que prefieras.
Bun
bun add validator-ec
Yarn
yarn add validator-ec
NPM
npm install validator-ec
Validadores
| Validador | Descripción | Ejemplo |
| ------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------ |
| isCedula(cedula: string): boolean
| Valida una cédula de identidad ecuatoriana. Devuelve true
si la cédula es válida, de lo contrario false
. | isCedula('1710034065')
|
| isRUC(ruc: string): boolean
| Valida un número de RUC (Registro Único de Contribuyentes). Devuelve true
si el RUC es válido, de lo contrario false
. | isRUC('1790016919001')
|
| isZipCode(zipCode: string): boolean
| Valida un código postal ecuatoriano. Devuelve true
si el código postal es válido, de lo contrario false
. | isZipCode('131401')
|
Uso
TypeScript
import { isCedula } from "validator-ec";
// Validar una cédula
const cedula = "1710034065";
const isValid = isCedula(cedula);
if (isValid) {
console.log("La cédula es válida");
} else {
console.log("La cédula no es válida");
}
JavaScript (CommonJS)
const { isCedula } = require("validator-ec");
// Validar una cédula
const cedula = "1710034065";
const isValid = isCedula(cedula);
if (isValid) {
console.log("La cédula es válida");
} else {
console.log("La cédula no es válida");
}
Contribuir
Todas las contribuciones son bienvenidas. Si deseas contribuir al proyecto, asegúrate de tener instalado Bun antes de seguir los siguientes pasos:
- Crea un fork del proyecto.
- Crea una nueva rama con el nombre de la funcionalidad que deseas agregar.
- Instala las dependencias del proyecto con
bun install
. - Realiza los cambios necesarios.
- Agrega pruebas para la nueva funcionalidad.
- Realiza un pull request a la rama
master
.
Pruebas
Para ejecutar las pruebas del proyecto con Vitest, utiliza el siguiente comando:
bun run test
Construir el proyecto
Para construir el proyecto con tsup, utiliza el siguiente comando:
bun run build
Autores
Licencia
Este proyecto está liberado bajo la licencia Apache 2.0. Para más información, revisa el archivo LICENSE.