@igleite/tsutils
Version:
Uma coleção de utilitários em TypeScript para facilitar o desenvolvimento no dia a dia.
105 lines (104 loc) • 4.05 kB
TypeScript
/**
* Classe utilitária para manipulação de datas.
*/
export declare class DateUtils {
/**
* Converte uma data UTC para a data local do usuário.
*
* @param {Date} date - A data UTC a ser convertida.
* @returns {Date} - A data convertida para o horário local.
*
* @example
* const utcDate = new Date('2023-09-21T10:00:00Z');
* const localDate = DateUtils.convertUTCDateToLocalDate(utcDate);
* console.log(localDate); // Exibe a data convertida para o horário local
*/
static convertUTCDateToLocalDate(date: Date): Date;
/**
* Converte uma string representando uma data em um objeto Date.
*
* @param {string} date - A string a ser convertida para uma data.
* @returns {Date} - O objeto Date correspondente à string fornecida.
*
* @example
* const dateString = "2023-09-21";
* const dateObject = DateUtils.convertStrinToDate(dateString);
* console.log(dateObject); // Exibe a data como um objeto Date
*/
static convertStrinToDate(date: string): Date;
/**
* Formata uma data para ser utilizada em um componente de seletor de data.
*
* @param {Date} myDate - A data a ser formatada.
* @returns {Object} - Um objeto contendo a data formatada.
*
* @example
* const myDate = new Date('2023-09-21');
* const pickerDate = DateUtils.setMyDatePickerDate(myDate);
* console.log(pickerDate); // { date: { year: 2023, month: 9, day: 21 } }
*/
static setMyDatePickerDate(myDate: Date): {
date: {
year: number;
month: number;
day: number;
};
};
/**
* Converte uma data formatada de um seletor de data para um objeto Date.
*
* @param {Object} myDate - O objeto contendo a data formatada.
* @returns {Date} - O objeto Date correspondente à data formatada.
*
* @example
* const pickerDate = { date: { year: 2023, month: 9, day: 21 } };
* const dateObject = DateUtils.getMyDatePickerDate(pickerDate);
* console.log(dateObject); // Exibe a data como um objeto Date
*/
static getMyDatePickerDate(myDate: any): Date;
/**
* Define o final do dia para uma data fornecida, configurando horas, minutos, segundos e milissegundos.
*
* @param {Date} myDate - A data para a qual o final do dia deve ser definido.
* @returns {Date} - A data ajustada para o final do dia.
*
* @example
* const myDate = new Date('2023-09-21');
* const endOfDay = DateUtils.toEndOfDay(myDate);
* console.log(endOfDay); // Exibe a data com hora ajustada para 23:59:59.999
*/
static toEndOfDay(myDate: Date): Date;
/**
* Verifica se o objeto fornecido é uma data válida.
*
* @param {any} obj - O objeto a ser verificado.
* @returns {boolean} - Verdadeiro se o objeto for uma data válida; caso contrário, falso.
*/
static isDate(obj: any): boolean;
/**
* Analisa um objeto e o converte em uma string de data no formato "YYYY-MM-DD".
*
* @param {any} obj - O objeto a ser analisado.
* @returns {string} - A string de data formatada.
*/
static parseDate(obj: any): string;
/**
* Formata o dia ou mês para adicionar um zero à esquerda se for menor que 10.
*
* @param {number} month - O número a ser formatado.
* @returns {string | number} - O número formatado com ou sem zero à esquerda.
*/
private static _formatDayOrMonth;
/**
* Formata uma data para o padrão "yyyy-MM".
*
* @param {Date} date - A data a ser formatada.
* @returns {string} - A data formatada no padrão "yyyy-MM".
*
* @example
* const date = new Date('2023-09-21');
* const formatted = DateUtils.getYearMonthString(date);
* console.log(formatted); // "2023-09"
*/
static getYearMonthString(date: Date): string;
}