date-difference-calculate/readme.md

A library to calcute the times difference between teh current date and a provided date

date-difference-calculate
Uma biblioteca simples e leve para Node.js que calcula a diferença de tempo entre a data atual e uma data futura, retornando o resultado em dias, horas e minutos.

🚀 Instalação
Para usar esta biblioteca em seu projeto, você pode instalá-la via npm:

Bash

npm install date-difference-calculate
📖 Como Usar
A biblioteca exporta uma única função chamada calculateTimeDifference.

Importando a função
JavaScript

const { calculateTimeDifference } = require('date-difference-calculate');
ou, se você estiver usando módulos ES6:

JavaScript

import { calculateTimeDifference } from 'date-difference-calculate';
Exemplo de uso
A função aceita uma string de data válida (no formato 'YYYY-MM-DD') ou um objeto Date como argumento.

JavaScript

const { calculateTimeDifference } = require('date-difference-calculate');

// Exemplo com uma string de data
const targetDateString = '2025-12-25'; // Data de Natal
const difference1 = calculateTimeDifference(targetDateString);

console.log(difference1);
// Exemplo de saída: { days: 120, hours: 5, minutes: 30 }

// Exemplo com um objeto Date
const futureDate = new Date('2025-10-31T10:00:00');
const difference2 = calculateTimeDifference(futureDate);

console.log(difference2);
// Exemplo de saída: { days: 60, hours: 2, minutes: 15 }
⚠️ Tratamento de Erros
A função calculateTimeDifference inclui validações para garantir que a data fornecida seja válida e futura.

Data inválida: Se a data fornecida não puder ser convertida em um formato válido, um erro será lançado.

JavaScript

try {
  calculateTimeDifference('data-invalida');
} catch (error) {
  console.error(error.message); // Saída: "invalid date format"
}
Data no passado: Se a data fornecida for igual ou anterior à data atual, a função retornará um objeto com uma propriedade de erro.

JavaScript

const pastDate = new Date('2023-01-01');
const result = calculateTimeDifference(pastDate);

console.log(result);
// Saída: { error: "the date provide is in the past" }
🔧 Contribuição
Contribuições são bem-vindas! Se você encontrou um bug ou tem uma ideia para uma melhoria, por favor, abra uma issue ou envie um pull request.

📝 Licença
Este projeto está sob a licença ISC.

👨‍💻 Autor
Nicolas Barsoti

Este README oferece uma visão clara e objetiva do seu projeto, o que é essencial para que outros desenvolvedores possam entender e usar sua biblioteca com facilidade. Se você precisar de alguma alteração ou de um README para outro projeto, é só me avisar!