dates-differences-calculator-lib v1.0.0

Date Difference Caculator

date-difference-calculator é uma biblioteca Node.js para calcular a diferença de tempo entre a data atual e uma data fornecida em dias, horas e minutos. Se a data fornecida estiver no passado, a função retornará uma mensagem de erro.

Intalação

Você pode instalar a biblioteca via npm:

npm install date-difference-calculator

Uso

Aqui está um exemplo de como usar a biblioteca:

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

try {
    const result = calculateTimeDifference('2024-12-25T00:00:00');
    if(result.error) {
        console.error(result.error)
    } else {
        console.log(`Days: ${result.days}, Hours: ${result.hours}, Minutes: ${result.minutes}`)
    }
} catch (error) {
    console.error(error.message);
}

Api

calculateTimeDifference(targetDate)

Calcula a diferencça de tempo entre a data atual e a data fornecida.

Parâmetros

• targetDate (string): A data alvo em um formato reconhecido pelo construtor Date do javaScript.

Retorno

• Um objeto contendo a diferença de tempo em dias, horas e minutos, ou uma mensagem de erro de a data fornecida estiver no passado.

Exemplo de Retorno

Se a data fornecida estiver no furuto:

{
    "days": 10,
    "hours": 5,
    "minutes": 30
}

Se a data fornecida estiver no passado:

{
    "error": "The date provided is in the past"
}

Contribuição

Se você encontrar algum problema ou tiver alguma sugestão de melhoria, sinta-se à vontade para abrir uma issue ou um pull request no repositório do GitHub.

Licença

Este projeto está lecenciado sob a licença MIT. Veja o arquivo LICENSE para mais detalhes.

Autor

Carlos Augusto

Agradecimentos

Obrigado por usar date-difference-calculator! se você tiver alguma dúvida ou precisar de ajuda, entre em contato.

Certifique-se de atualizar as informações de acordo com suas necessidades específicas, incluindo seu nome e quaisquer outros detalhes que sejam relevantes para o seu projeto.