Skip to main content

DateTime

O módulo DateTime é responsável por realizar ações de manipulação de datas. Seus métodos podem ser acessados conforme o exemplo abaixo:

const date = await DateTime.addDate["v1_0_0"]({
  unit: 'd',
})

Métodos​

addDate​

Método responsável por adicionar uma unidade de tempo a uma data.

const date = await DateTime.addDate["v1_0_0"]({
  unit: 'd',
})

Parâmetros obrigatórios​

  • unit: String - espera uma string com a unidade de tempo que será adicionada. Os valores possíveis são:
    • y: ano;
    • M: mês;
    • d: dia;
    • w: semana;
    • h: hora;
    • m: minuto;
    • s: segundo;
    • ms: milissegundo.

Parâmetros opcionais​

  • date: String - espera uma string com a data que será manipulada. Se não for informado, será utilizada a data atual.
  • configuration: Object - espera um objeto com as configurações da data. Essas configurações devem ser obtidas através do método configurations.
  • inputFormat: String - espera uma string com o formato da data que será manipulada. Se não for informado, será utilizado o formato padrão americano (YYYY-MM-DD).
  • outputFormat: String - espera uma string com o formato da data que será retornada. Se não for informado, será utilizado o formato padrão americano (YYYY-MM-DD).
  • outputLocale: String - espera uma string com o idioma da data que será retornada. Se não for informado, será utilizado o idioma padrão. Os idiomas disponíveis são: pt-br e en.
  • quantity: Number - espera um número com a quantidade de unidades de tempo que serão adicionadas. Se não for informado, será utilizado o valor 1.

Retorno​

A constante ou variável criada, como a date do exemplo mostrado anteriormente, receberá uma string com a nova data manipulada.

calculateDateDifference​

Método responsável por calcular a diferença entre duas datas.

const date = await DateTime.calculateDateDifference["v1_0_0"]({
  startDate: '2020-01-01',
  endDate: '2020-01-02',
  unit: 'd',
})

Parâmetros obrigatórios​

  • startDate: String - espera uma string com a data inicial.
  • endDate: String - espera uma string com a data final.
  • unit: String - espera uma string com a unidade de tempo que será retornada. Os valores possíveis são:
    • y: ano;
    • M: mês;
    • d: dia;
    • w: semana;
    • h: hora;
    • m: minuto;
    • s: segundo;
    • ms: milissegundo.

Parâmetros opcionais​

  • inputStartDateFormat: String - espera uma string com o formato da data inicial que será manipulada. Se não for informado, será utilizado o formato padrão americano (YYYY-MM-DD).
  • inputEndDateFormat: String - espera uma string com o formato da data final que será manipulada. Se não for informado, será utilizado o formato padrão americano (YYYY-MM-DD).

Retorno​

A constante ou variável criada, como a date do exemplo mostrado anteriormente, receberá uma string com a nova data manipulada.

checkHoliday​

Método responsável por verificar se uma data é feriado.

const date = await DateTime.checkHoliday["v1_0_0"]({})

Parâmetros obrigatórios​

Este método não possui parâmetros obrigatórios.

Parâmetros opcionais​

  • date: String - espera uma string com a data que será verificada. Se não for informado, será utilizada a data atual.
  • configuration: Object - espera um objeto com as configurações da data. Essas configurações devem ser obtidas através do método configurations.
  • inputFormat: String - espera uma string com o formato da data que será manipulada. Se não for informado, será utilizado o formato padrão americano (YYYY-MM-DD).

Retorno​

A constante ou variável criada, como a date do exemplo mostrado anteriormente, receberá um valor booleano, que será true se a data for feriado ou false caso contrário.

configurations​

Método responsável por criar uma configuração de feriados para os dias do ano. 

const configurations = await DateTime.configurations["v1_0_0"]({
    holidaysFile:{
        path: 'C:/Users/Roberty/Destkop/holidays.csv',
        format: 'csv',
        delimiter: ';',
    }
    weekdayHolidays: ['SATURDAY', 'SUNDAY']
})

Parâmetros obrigatórios​

  • holidaysFile: Object - espera um objeto com as informações do arquivo que possui os feridos do ano. Essas informações são:
    • path: String - espera uma string com o caminho do arquivo.
    • format: String - espera uma string com o formato do arquivo. Os valores possíveis são: csv.
    • delimiter: String - espera uma string com o delimitador que separa os dias dentro do arquivo csv.
  • weekdayHolidays: Array - espera um array com os dias da semana que serão considerados feriados. Os valores possíveis são: SATURDAY, SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY.

Parâmetros opcionais​

Este método não possui parâmetros opcionais.

Retorno​

A constante ou variável criada, como a configurations do exemplo mostrado anteriormente, receberá um objeto com as configurações criadas. Esse objeto dará acesso as seguintes propriedades:

  • configurations.holidays: Object - retorna um objeto com as seguintes propriedades:
    • days: Object - retorna um objeto com as seguintes propriedades:
      • format: String - retorna uma string com o formato da data.
      • list: Array - retorna um array com os dias da semana que serão considerados feriados.
    • weekDays: Array - retorna um array com os dias da semana que serão considerados feriados.

formatDate​

Método responsável por formatar uma data.


const formattedDate = await DateTime.formatDate["v1_0_0"]({
  date: "2020-01-01",
  inputFormat: "yyyy-mm-dd",
  outputFormat: "yyyy-mm-dd"
})

Parâmetros obrigatórios​

Este método não possui parâmetros obrigatórios.

Parâmetros opcionais​

  • date: String - espera uma string com a data que será formatada. Se não for informado, será utilizada a data atual.
  • inputFormat: String - espera uma string com o formato da data que será manipulada. Se não for informado, será utilizado o formato padrão americano (YYYY-MM-DD).
  • outputFormat: String - espera uma string com o formato da data que será manipulada. Se não for informado, será utilizado o formato padrão americano (YYYY-MM-DD).
  • outputLocale: String - espera uma string com o idioma da data que será retornada. Se não for informado, será utilizado o idioma padrão. Os idiomas disponíveis são: pt-br e en.

Retorno​

A constante ou variável criada, como a formattedDate do exemplo mostrado anteriormente, receberá uma string com a data formatada.

getDateInformation​

Método responsável por obter informações de uma data.

const dateInformation = await DateTime.getDateInformation["v1_0_0"]({
  date: "2020-01-01",
  inputFormat: "yyyy-mm-dd",
})

Parâmetros obrigatórios​

Este método não possui parâmetros obrigatórios.

Parâmetros opcionais​

  • date: String - espera uma string com a data que será formatada. Se não for informado, será utilizada a data atual.
  • inputFormat: String - espera uma string com o formato da data que será manipulada. Se não for informado, será utilizado o formato padrão americano (YYYY-MM-DD).
  • locale: String - espera uma string com o idioma da data que será retornada. Se não for informado, será utilizado o idioma padrão. Os idiomas disponíveis são: pt-br e en.
  • configurations: Object - espera um objeto com as configurações da data. Essas configurações devem ser obtidas através do método configurations.

Retorno​

A constante ou variável criada, como a dateInformation do exemplo mostrado anteriormente, receberá um objeto com as informações da data. Esse objeto dará acesso as seguintes propriedades:

  • dateInformation.day: String - retorna uma string com o dia da data.
  • dateInformation.dayName: String - retorna uma string com o dia da semana da data.
  • dateInformation.firstDateOfTheMonth: String - retorna uma string com a data do primeiro dia do mês.
  • dateInformation.lastDateOfTheMonth: String - retorna uma string com a data do último dia do mês.
  • dateInformation.firstDayOfTheWeek: String - retorna uma string com a data do primeiro dia da semana.
  • dateInformation.lastDayOfTheWeek: String - retorna uma string com a data do último dia da semana.
  • dateInformation.firstWorkingDayOfTheMonth: String - retorna uma string com a data do primeiro dia útil do mês.
  • dateInformation.lastWorkingDayOfTheMonth: String - retorna uma string com a data do último dia útil do mês.
  • dateInformation.month: String - retorna uma string com o mês da data.
  • dateInformation.monthName: String - retorna uma string com o nome do mês da data.
  • dateInformation.year: String - retorna uma string com o ano da data.

removeDate​

Método responsável por remover uma unidade de tempo a uma data.

const date = await DateTime.removeDate["v1_0_0"]({
  date: "2020-01-01",
  inputFormat: "yyyy-mm-dd",
  unit: "day",
  value: 1
})

Parâmetros obrigatórios​

  • unit: String - espera uma string com a unidade de tempo que será removida. Os valores possíveis são:
    • y: ano;
    • M: mês;
    • d: dia;
    • w: semana;
    • h: hora;
    • m: minuto;
    • s: segundo;
    • ms: milissegundo.

Parâmetros opcionais​

  • date: String - espera uma string com a data que será formatada. Se não for informado, será utilizada a data atual.
  • inputFormat: String - espera uma string com o formato da data que será manipulada. Se não for informado, será utilizado o formato padrão americano (YYYY-MM-DD).
  • outputFormat: String - espera uma string com o formato da data que será manipulada. Se não for informado, será utilizado o formato padrão americano (YYYY-MM-DD).
  • outputLocale: String - espera uma string com o idioma da data que será retornada. Se não for informado, será utilizado o idioma padrão. Os idiomas disponíveis são: pt-br e en.
  • configurations: Object - espera um objeto com as configurações da data. Essas configurações devem ser obtidas através do método configurations.
  • quantity: Number - espera um número com a quantidade de unidades de tempo que será removida.

Retorno​

A constante ou variável criada, como a date do exemplo mostrado anteriormente, receberá uma string com a data subtraída.