Skip to content

notyel/age-calculator.js

Repository files navigation

age-calculation-library

age-calculation-library es una librería desarrollada en JavaScript y compatible con TypeScript, diseñada específicamente para calcular de manera precisa la edad de una persona o entidad a partir de una fecha de nacimiento proporcionada. Esta herramienta se enfoca en ofrecer una solución eficiente y fácil de implementar para desarrolladores que necesitan realizar cálculos de edad en sus aplicaciones, sin tener que lidiar con la complejidad de las fechas y el manejo de diferentes zonas horarias. Con una interfaz sencilla y bien documentada, la librería permite obtener resultados confiables y exactos, adaptándose a diversas situaciones y formatos de fechas, lo que la convierte en una opción ideal para proyectos que requieran este tipo de funcionalidad en plataformas web, móviles o de escritorio que están construidas con tecnologías web, tales como aplicaciones desarrolladas con frameworks de JavaScript, HTML y CSS.

Instalación

Instala la librería utilizando npm:

npm install age-calculation-library

Uso

Uso con CommonJS (Node.js)

// Importar la función calculateAge desde la biblioteca
const { calculateAge } = require("age-calculation-library");

// Fecha de nacimiento para calcular la edad
const fechaNacimiento = "1990-05-25";

// Calcular la edad basada en la fecha actual
const edad = calculateAge(fechaNacimiento);
console.log(edad); // Debería imprimir la edad basada en la fecha actual

Uso con ES6 Module Syntax

// Importar la función calculateAge desde la biblioteca
import { calculateAge } from "age-calculation-library";

// Fecha de nacimiento para calcular la edad
const fechaNacimiento = "1990-05-25";

// Calcular la edad basada en la fecha actual
const edad = calculateAge(fechaNacimiento);
console.log(edad); // Debería imprimir la edad basada en la fecha actual

Desarrollo

Estructura del Proyecto

El proyecto está organizado de la siguiente manera:

age-calculator.js/
├── dist/               # Archivos compilados
│   ├── browser/
│   │   ├── ageCalculator.js
│   │   └── test/
│   │       └── test.js
│   └── node/
│       ├── ageCalculator.js
│       └── test/
│           └── test.js
├── src/                # Código fuente en TypeScript
│   ├── ageCalculator.ts
│   └── test/
│       └── test.ts
├── test/               # Archivos de prueba en TypeScript
│   └── test.ts
├── .gitignore
├── LICENSE
├── package-lock.json
├── package.json        # Configuración del proyecto y dependencias
├── README.md
├── tsconfig.browser.json  # Configuración de TypeScript para el navegador
├── tsconfig.json        # Configuración de TypeScript general
└── tsconfig.node.json   # Configuración de TypeScript para Node.js

Compilación

Para compilar esta librería, primero descarga el repositorio desde GitHub y luego instala las dependencias usando npm:

git clone https://github.com/notyel/age-calculator.js.git
cd age-calculator.js
npm install

Para compilar el código TypeScript en JavaScript, ejecuta el siguiente comando:

npm run build

El código compilado se guardará en la carpeta dist.

Pruebas

Para ejecutar las pruebas, asegúrate de haber compilado el código y luego ejecuta el archivo de prueba generado en la carpeta dist/test.

npm run test

Scripts de npm

  • build: Compila el código TypeScript a JavaScript.
  • test: Ejecuta el archivo de pruebas compilado.

Contribuciones

Las contribuciones son bienvenidas. Por favor, sigue estos pasos:

  1. Haz un fork del repositorio.
  2. Crea una nueva rama para tu feature (git checkout -b feature/nueva-feature).
  3. Realiza los cambios necesarios y realiza commit (git commit -am 'Añade nueva feature').
  4. Empuja los cambios a la rama (git push origin feature/nueva-feature).
  5. Crea un Pull Request.

Licencia

Este proyecto está bajo la licencia MIT. Ver el archivo LICENSE para más detalles.

Creador