Saltar al contenido principal
Ir al Studio
Módulos

DateTime

DateTime

El módulo DateTime es responsable de realizar acciones de manipulación de fechas. Sus métodos pueden accederse conforme al ejemplo a continuación:

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

Métodos​

addDate​

Método responsable de agregar una unidad de tiempo a una fecha.

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

Parámetros obligatorios​

  • unit: String - espera un string con la unidad de tiempo que será sumada. Los valores posibles son:
    • y: año;
    • M: mes;
    • d: día;
    • w: semana;
    • h: hora;
    • m: minuto;
    • s: segundo;
    • ms: milisegundo.

Parámetros opcionales​

  • date: String - espera un string con la fecha que será manipulada. Si no se indica, se utilizará la fecha actual.
  • configuration: Object - espera un objeto con las configuraciones de la fecha. Estas configuraciones deben obtenerse a través del método configurations.
  • inputFormat: String - espera un string con el formato de la fecha que será manipulada. Si no se indica, se utilizará el formato estadounidense predeterminado (YYYY-MM-DD).
  • outputFormat: String - espera un string con el formato de la fecha que será devuelta. Si no se indica, se utilizará el formato estadounidense predeterminado (YYYY-MM-DD).
  • outputLocale: String - espera un string con el idioma de la fecha que será devuelta. Si no se indica, se utilizará el idioma predeterminado. Los idiomas disponibles son: pt-br y en.
  • quantity: Number - espera un número con la cantidad de unidades de tiempo que serán sumadas. Si no se indica, se utilizará el valor 1.

Retorno​

La constante o variable creada, como la date del ejemplo mostrado anteriormente, recibirá un string con la nueva fecha manipulada.

calculateDateDifference​

Método responsable de calcular la diferencia entre dos fechas.

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

Parámetros obligatorios​

  • startDate: String - espera un string con la fecha inicial.
  • endDate: String - espera un string con la fecha final.
  • unit: String - espera un string con la unidad de tiempo que será devuelta. Los valores posibles son:
    • y: año;
    • M: mes;
    • d: día;
    • w: semana;
    • h: hora;
    • m: minuto;
    • s: segundo;
    • ms: milisegundo.

Parámetros opcionales​

  • inputStartDateFormat: String - espera un string con el formato de la fecha inicial que será manipulada. Si no se indica, se utilizará el formato estadounidense predeterminado (YYYY-MM-DD).
  • inputEndDateFormat: String - espera un string con el formato de la fecha final que será manipulada. Si no se indica, se utilizará el formato estadounidense predeterminado (YYYY-MM-DD).

Retorno​

La constante o variable creada, como la date del ejemplo mostrado anteriormente, recibirá un número que representa la diferencia calculada entre las dos fechas en la unidad especificada.

checkHoliday​

Método responsable de verificar si una fecha es feriado.

js
const isHoliday = await DateTime.checkHoliday["v1_0_0"]({
  configurations: configurations,
})

Parámetros obligatorios​

  • configurations: Object - espera un objeto con las configuraciones de feriados. Estas configuraciones deben obtenerse a través del método configurations.

Parámetros opcionales​

  • date: String - espera un string con la fecha que será verificada. Si no se indica, se utilizará la fecha actual.
  • inputFormat: String - espera un string con el formato de la fecha que será manipulada. Si no se indica, se utilizará el formato predeterminado (DD/MM/YYYY).

Retorno​

La constante o variable creada, como la date del ejemplo mostrado anteriormente, recibirá un valor booleano, que será true si la fecha es feriado o false en caso contrario.

configurations​

Método responsable de crear una configuración de feriados para los días del año.

js
const configurations = await DateTime.configurations["v1_0_0"]({
    holidays: {
        holidayPathFile: 'C:/Users/Roberty/Desktop/feriados.csv',
        delimiter: ';',
        format: 'DD/MM/YYYY',
    },
    weekdayHolidays: ['SATURDAY', 'SUNDAY']
})

Parámetros obligatorios​

Este método no tiene parámetros obligatorios.

Parámetros opcionales​

  • holidays: Object - espera un objeto con la información de los feriados. Puede proporcionarse de dos formas:
    • Por archivo: { holidayPathFile: String, delimiter: String, format: String } — carga los feriados desde un archivo CSV.
      • holidayPathFile: String - ruta del archivo CSV con las fechas de los feriados.
      • delimiter: String - delimitador de las columnas del CSV. Valor predeterminado: ;.
      • format: String - formato de las fechas en el archivo. Valor predeterminado: DD/MM/YYYY.
    • Por lista: { holidayList: String[], delimiter: String, format: String } — indica los feriados directamente como un array de strings.
      • holidayList: String[] - array con las fechas de los feriados.
      • delimiter: String - delimitador. Valor predeterminado: ;.
      • format: String - formato de las fechas. Valor predeterminado: DD/MM/YYYY.
  • weekdayHolidays: Array - espera un array con los días de la semana que serán considerados feriados. Los valores posibles son: SATURDAY, SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY.

Retorno​

La constante o variable creada, como la configurations del ejemplo mostrado anteriormente, recibirá un objeto con las configuraciones creadas. Ese objeto dará acceso a las siguientes propiedades:

  • configurations.holidays: Object - devuelve un objeto con las siguientes propiedades:
    • days: Object - devuelve un objeto con las siguientes propiedades:
      • format: String - devuelve un string con el formato de la fecha.
      • list: Array - devuelve un array con los días de la semana que serán considerados feriados.
    • weekDays: Array - devuelve un array con los días de la semana que serán considerados feriados.

formatDate​

Método responsable de formatear una fecha.

js

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

Parámetros obligatorios​

Este método no tiene parámetros obligatorios.

Parámetros opcionales​

  • date: String - espera un string con la fecha que será formateada. Si no se indica, se utilizará la fecha actual.
  • inputFormat: String - espera un string con el formato de la fecha que será manipulada. Si no se indica, se utilizará el formato estadounidense predeterminado (YYYY-MM-DD).
  • outputFormat: String - espera un string con el formato de la fecha que será manipulada. Si no se indica, se utilizará el formato estadounidense predeterminado (YYYY-MM-DD).
  • outputLocale: String - espera un string con el idioma de la fecha que será devuelta. Si no se indica, se utilizará el idioma predeterminado. Los idiomas disponibles son: pt-br y en.

Retorno​

La constante o variable creada, como la formattedDate del ejemplo mostrado anteriormente, recibirá un string con la fecha formateada.

getDateInformation​

Método responsable de obtener información de una fecha.

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

Parámetros obligatorios​

Este método no tiene parámetros obligatorios.

Parámetros opcionales​

  • date: String - espera un string con la fecha que será formateada. Si no se indica, se utilizará la fecha actual.
  • inputFormat: String - espera un string con el formato de la fecha que será manipulada. Si no se indica, se utilizará el formato estadounidense predeterminado (YYYY-MM-DD).
  • locale: String - espera un string con el idioma de la fecha que será devuelta. Si no se indica, se utilizará el idioma predeterminado. Los idiomas disponibles son: pt-br y en.
  • configurations: Object - espera un objeto con las configuraciones de la fecha. Estas configuraciones deben obtenerse a través del método configurations.

Retorno​

La constante o variable creada, como la dateInformation del ejemplo mostrado anteriormente, recibirá un objeto con la información de la fecha. Ese objeto dará acceso a las siguientes propiedades:

  • dateInformation.day: Number - devuelve el número del día de la fecha.
  • dateInformation.dayName: String - devuelve el nombre del día de la semana de la fecha.
  • dateInformation.firstDateOfTheMonth: String - devuelve un string con la fecha del primer día del mes.
  • dateInformation.lastDateOfTheMonth: String - devuelve un string con la fecha del último día del mes.
  • dateInformation.firstDateOfTheWeek: String - devuelve un string con la fecha del primer día de la semana.
  • dateInformation.lastDateOfTheWeek: String - devuelve un string con la fecha del último día de la semana.
  • dateInformation.firstWorkingDayOfTheMonth: Number - devuelve el número del día del primer día hábil del mes.
  • dateInformation.lastWorkingDayOfTheMonth: Number - devuelve el número del día del último día hábil del mes.
  • dateInformation.month: Number - devuelve el número del mes de la fecha.
  • dateInformation.monthName: String - devuelve el nombre del mes de la fecha.
  • dateInformation.year: Number - devuelve el número del año de la fecha.

removeDate​

Método responsable de restar una unidad de tiempo a una fecha.

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

Parámetros obligatorios​

  • unit: String - espera un string con la unidad de tiempo que será restada. Los valores posibles son:
    • y: año;
    • M: mes;
    • d: día;
    • w: semana;
    • h: hora;
    • m: minuto;
    • s: segundo;
    • ms: milisegundo.

Parámetros opcionales​

  • date: String - espera un string con la fecha que será formateada. Si no se indica, se utilizará la fecha actual.
  • inputFormat: String - espera un string con el formato de la fecha que será manipulada. Si no se indica, se utilizará el formato estadounidense predeterminado (YYYY-MM-DD).
  • outputFormat: String - espera un string con el formato de la fecha que será manipulada. Si no se indica, se utilizará el formato estadounidense predeterminado (YYYY-MM-DD).
  • outputLocale: String - espera un string con el idioma de la fecha que será devuelta. Si no se indica, se utilizará el idioma predeterminado. Los idiomas disponibles son: pt-br y en.
  • configurations: Object - espera un objeto con las configuraciones de la fecha. Estas configuraciones deben obtenerse a través del método configurations.
  • quantity: Number - espera un número con la cantidad de unidades de tiempo que será restada.

Retorno​

La constante o variable creada, como la date del ejemplo mostrado anteriormente, recibirá un string con la fecha restada.