@cesar-jr/datetime

getDateTime

Função para formatar e calcular data e hora para casos simples

Uso

getDateTime([options]) - retorna uma data e/ou hora no formato especificado

• options (object):
  • out(string): formato do retorno (Default: 'ISO')
    • ISO: saída como string no formato ISO
    • msEpoch: saída como Unix timestamp, (única opção na qual o retorno é number)
    • Qualquer outra string será interpretada como um template com os caracteres da tabela abaixo servindo como especiais para indicar onde vai cada dado.
  • utcOut(boolean): definir true para indicar se ao usar um template na saída os dados devem ser em relação a data e hora UTC ao invés da data e hora local. (Default:false)
  • from(string|number): para indicar um ponto de partida de data/hora para a chamada da função.
    • se number é interpretado como Unix timestamp
    • se string:
      • caso esteja nos formatos AAAA-MM-DD ou DD/MM/AAAA será considerado como uma data local, (IMPORTANTE: não vai aceitar o formato MM/DD/AAAA e o formato AAAA-MM-DD não é considerado como UTC que nem o construtor de Date)
      • string em qualquer outro formato vai ser passado para o construtor de Date direto
  • offset(string|object|array): para indicar quais operações devem ser feitas na data/hora antes de retornar
    • se object
      • operation(string): deve ser + ou - para somar ou subtrair respectivamente.
      • qty(number): quantidade a ser somada/subtraída (deve ser número inteiro)
      • unit(string): indica do que é a quantidade. year|month|day|hour|minute|second|week
    • se array deve ser um array de object definido acima
    • se string deve ser uma string contendo a interpolação das propriedades do object definido acima na ordem apresentada.

getDateTime(format[, from]) - retorna uma data e/ou hora no formato especificado

• format(string): Uma string servindo para definir um template de saída e as operações de offset juntas.
• from(string|number): Mesma coisa da propriedade from de options acima.

Written with StackEdit.