calculadora-de-data/README.md

Uma bilioteca que calcula a diferença de tempo entre a data atual e a data fornecida

# Calculadra de data

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

## Instalação

Você pode instalar a biblioteca via npm:

```bash
npm install calculadora-de-data
```

## Uso

Aqui está um exemplo de como usar a biblioteca:

```javascript
const {calculadoraDeData} = require('calculadora-de-data');

try{
    const resultado = calculadoraDeData('2024-12-25T00:00:00');
    if (result.error){
        console.error(resultado.error);
    } else {
        console.log(`Dias: ${resultado.dias}, Horas${resultado.horas}, Minutos:${resultado.minutos}`)
    }
}catch{
    console.error(error.message);
}
```

## API

### `calculadoraDeData(data)`

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

### Parâmetros

-`data` (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 se a data fornecida estiver no passado.

### Exemplo de retorno

Se a data fornecida estiver no futuro:

```json
{
    "dias" : 10,
    "horas" : 5,
    "minutos" : 30
}
```

Se a data fornecida estiver no passado:

```json
{
    "error": "A data fornecida está no passado"
}
```

## Contribuição

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

## Licença

Este projeto é licenciado sob a licença MIT. 

## Autor

Lucas Iniesta Simões

## Agradecimentos

Obrigado por usar a `calculadora-de-data`! Se você tiver alguma dúvida ou precisar de ajuda, entre em contato.