O andora-date é um objeto que permite trabalhar com a data e hora na time zone do Brasil independentemente da configuração do idioma ou do time zone da máquina onde o código está rodando. Ele também contempla métodos para manipular a data e para formatar a data e horário no padrão brasileiro. Este objeto reconhece os horários de verão de 1985 até 2018 e pode ser atualizado com novos horários caso o Brasil volte a adotar o horário de verão.

Forma de usar

const data = require('andora-date.js');
hoje = new data.AndoraDate();
console.log(hoje.toDMY());

Construtor

Cria uma representação de data e hora na time zone do horário oficial do Brasil. O construtor permite receber como parâmetro a data e hora que ele deve representar. Este parâmetro pode ser a representação numérica do horário universal ou uma string com a data e hora no formato ISO 8601. Caso o parâmetro seja omitido, o objeto representará a data e hora corrente official do Brasil.

Exemplos

Data e hora corrente:

agora = new data.AndoraDate();

Data e hora do ano novo indicada no formato Unix Epoch:

anoNovo = new data.AndoraDate(1640995200000);

Data e hora do natal indicada através de string no formato ISO 8601:

natal = new data.AndoraDate('2021-12-25T00:00:00.000-03:00');

Somente a data do natal indicada através de string no formato ISO 8601:

natal = new data.AndoraDate('2021-12-25');

Métodos

addDays(days)

Avança o dia, representado pelo objeto, o número de vezes indicado por days. Caso days seja negativo o dia será retroagido.

addMonths(months)

Avança o mês, representado pelo objeto, o número de vezes indicado por months. Caso months seja negativo o mês será retroagido.

addSeconds(seconds)

Avança o número de segundos indicado por seconds. Caso seconds seja negativo a data e a hora serão retroagidos.

getTime()

Obtem o Unix Epoch da data representada pelo objeto.

getTimeZoneOffset()

Obtem o offset, em milissegundos, do time zone da hora representada pelo objeto.

isDST()

Retorna "true" se a data representada pelo objeto estiver dentro do horário de verão.

setFirstDay()

Muda o dia, representado pelo objeto, para o primeiro dia do mês.

setLastDay()

Muda o dia, representado pelo objeto, para o último dia do mês.

setMidNight()

Muda o horário, representado pelo objeto, para zero horas.

setLastDaySecond()

Muda o horário, representado pelo objeto, para o último segundo do dia, ou seja, para 23:59:59.

setTime(date)

Define a nova data que será representada pelo objeto. Permite as mesmas opções do construtor.

toDateISO()

Converte somente a data para string no formato ISO 8601: YYYY-MM-DD

Exemplo: '2022-01-06'

Este formato é ideal para registrar data em bancos que não possuem tipo específico para data, como o DynamoDB da AWS por exemplo.

toDateTimeISO()

Retorna string com a data, horário e time zone offset no formato ISO 8601: YYYY-MM-DDTHH:MM:SS.FFF-HH:MM

Exemplo: '2022-01-06T23:28:08.541-03:00'

Este formato é ideal para registrar data e o horário em bancos que não possuem tipo específico para data, como o DynamoDB da AWS por exemplo.

Esta função aceita um parâmetro de entrada que quando setado para true retorna a data UTC no formato ISO.

toDMY()

Retorna string com a data no formato: DD/MM/YYYY

toDMYHM()

Retorna string com a data e horário no formato: DD/MM/YYYY HH:MM

toDMYHMS()

Retorna string com a data e horário no formato: DD/MM/YYYY HH:MM:SS

toDMYHMZ()

Retorna string com a data, horário e time zone offset no formato: DD/MM/YYYY HH:MM -HH:MM

toDMYHMSZ()

Retorna string com a data, horário e time zone offset no formato: DD/MM/YYYY HH:MM:SS -HH:MM

Funções de acesso direto

Segue abaixo algumas funções que estão disponíveis fora do objeto e que são uma forma mais prática de manipular a data a partir de uma representação no formato ISO 8601.

toDMY(strISO)

Retorna string com a data no formato: DD/MM/YYYY

toDMYHM(strISO)

Retorna string com a data e horário no formato: DD/MM/YYYY HH:MM

toDMYHMS(strISO)

Retorna string com a data e horário no formato: DD/MM/YYYY HH:MM:SS

Funções de acesso direto a partir de uma string

Segue abaixo as funções que estão disponíveis como extensão do objeto string.

string.toDMY()

Retorna string com a data no formato: DD/MM/YYYY

string.toDMYHM()

Retorna string com a data e horário no formato: DD/MM/YYYY HH:MM

string.toDMYHMS()

Retorna string com a data e horário no formato: DD/MM/YYYY HH:MM:SS