@atlantjs/arch 13.3.0 → 14.0.1

package/objects/datetime/edges/datetime.edge.d.ts

@@ -5,23 +5,441 @@ export declare class DatetimeEdge {
     private readonly value?;
     protected readonly date: Moment;
     constructor(value?: (Date | string) | undefined);
+    /**
+     * Verifica se esta data é posterior a outra.
+     * @param other - Data para comparação
+     * @returns true se this > other, false caso contrário
+     * @example
+     * new DatetimeEdge(new Date("2026-12-01")).isAfter(new DatetimeEdge(new Date("2026-01-01"))) // true
+     */
     isAfter(other: DatetimeEdge): boolean;
-    diffFromNow(): string;
-    isEquals(other: DatetimeEdge): boolean;
+    /**
+     * Verifica se esta data é anterior a outra.
+     * @param other - Data para comparação
+     * @returns true se this < other, false caso contrário
+     * @example
+     * new DatetimeEdge(new Date("2026-01-01")).isBefore(new DatetimeEdge(new Date("2026-12-01"))) // true
+     */
     isBefore(other: DatetimeEdge): boolean;
+    /**
+     * Verifica se esta data é igual a outra.
+     * @param other - Data para comparação
+     * @returns true se as datas são iguais, false caso contrário
+     * @example
+     * new DatetimeEdge(new Date("2026-01-01")).isEquals(new DatetimeEdge(new Date("2026-01-01"))) // true
+     */
+    isEquals(other: DatetimeEdge): boolean;
+    /**
+     * Verifica se esta data está entre duas outras datas (exclusivo).
+     * @param initialDate - Data inicial do intervalo
+     * @param finalDate - Data final do intervalo
+     * @returns true se this está entre initialDate e finalDate, false caso contrário
+     * @example
+     * new DatetimeEdge(new Date("2026-06-15")).isBetween(
+     *   new DatetimeEdge(new Date("2026-01-01")),
+     *   new DatetimeEdge(new Date("2026-12-31"))
+     * ) // true
+     */
     isBetween(initialDate: DatetimeEdge, finalDate: DatetimeEdge): boolean;
+    /**
+     * Verifica se a data cai em um fim de semana (sábado ou domingo).
+     * @returns true se a data é sábado ou domingo, false caso contrário
+     * @example
+     * new DatetimeEdge(new Date("2026-03-14")).isWeekend() // true (sábado)
+     * new DatetimeEdge(new Date("2026-03-12")).isWeekend() // false (quinta-feira)
+     */
     isWeekend(): boolean;
+    /**
+     * Verifica se a data é um feriado no Brasil.
+     * @returns true se a data é um feriado nacional, false caso contrário
+     * @example
+     * new DatetimeEdge(new Date("2026-12-25")).isHoliday() // true (Natal)
+     * new DatetimeEdge(new Date("2026-03-12")).isHoliday() // false
+     */
     isHoliday(): boolean;
+    /**
+     * Verifica se a data é um dia útil (não é fim de semana nem feriado).
+     * @returns true se a data é um dia útil, false caso contrário
+     * @example
+     * new DatetimeEdge(new Date("2026-03-12")).isBusinessDay() // true (quinta-feira)
+     * new DatetimeEdge(new Date("2026-12-25")).isBusinessDay() // false (Natal)
+     */
     isBusinessDay(): boolean;
+    /**
+     * Verifica se a data corresponde ao dia de hoje.
+     * @returns true se a data é hoje, false caso contrário
+     * @example
+     * new DatetimeEdge(new Date()).isToday() // true
+     * new DatetimeEdge(new Date("2020-01-01")).isToday() // false
+     */
+    isToday(): boolean;
+    /**
+     * Verifica se a data corresponde a ontem.
+     * @returns true se a data é ontem, false caso contrário
+     * @example
+     * new DatetimeEdge(new Date()).isYesterday() // false
+     */
+    isYesterday(): boolean;
+    /**
+     * Verifica se a data corresponde a amanhã.
+     * @returns true se a data é amanhã, false caso contrário
+     * @example
+     * new DatetimeEdge(new Date()).isTomorrow() // false
+     */
+    isTomorrow(): boolean;
+    /**
+     * Verifica se a data está no mesmo dia que outra.
+     * @param other - Data para comparação
+     * @returns true se ambas as datas estão no mesmo dia, false caso contrário
+     * @example
+     * const a = new DatetimeEdge(new Date("2026-03-12T08:00"));
+     * const b = new DatetimeEdge(new Date("2026-03-12T22:00"));
+     * a.isSameDay(b) // true
+     */
+    isSameDay(other: DatetimeEdge): boolean;
+    /**
+     * Verifica se a data está no mesmo mês que outra.
+     * @param other - Data para comparação
+     * @returns true se ambas as datas estão no mesmo mês e ano, false caso contrário
+     * @example
+     * const a = new DatetimeEdge(new Date("2026-03-01"));
+     * const b = new DatetimeEdge(new Date("2026-03-31"));
+     * a.isSameMonth(b) // true
+     */
+    isSameMonth(other: DatetimeEdge): boolean;
+    /**
+     * Verifica se a data está no mesmo ano que outra.
+     * @param other - Data para comparação
+     * @returns true se ambas as datas estão no mesmo ano, false caso contrário
+     * @example
+     * const a = new DatetimeEdge(new Date("2026-01-01"));
+     * const b = new DatetimeEdge(new Date("2026-12-31"));
+     * a.isSameYear(b) // true
+     */
+    isSameYear(other: DatetimeEdge): boolean;
+    /**
+     * Retorna o dia da semana da data.
+     * @returns Enum WeekDayEnum representando o dia da semana
+     * @example
+     * new DatetimeEdge(new Date("2026-03-12")).getDayOfWeek() // WeekDayEnum.thursday
+     */
     getDayOfWeek(): WeekDayEnum;
+    /**
+     * Retorna o nome do mês da data.
+     * @returns Enum MonthNameEnum representando o mês
+     * @example
+     * new DatetimeEdge(new Date("2026-03-12")).getNameOfMonth() // MonthNameEnum.march
+     */
     getNameOfMonth(): MonthNameEnum;
+    /**
+     * Retorna o número do dia no mês.
+     * @returns Número do dia (1-31)
+     * @example
+     * new DatetimeEdge(new Date("2026-03-12")).getDayOfMonth() // 12
+     */
     getDayOfMonth(): number;
+    /**
+     * Retorna o número do mês (base 0).
+     * @returns Número do mês (0=janeiro, 11=dezembro)
+     * @example
+     * new DatetimeEdge(new Date("2026-03-12")).getNumberOfMonth() // 2
+     */
     getNumberOfMonth(): number;
+    /**
+     * Retorna o ano da data.
+     * @returns Número do ano
+     * @example
+     * new DatetimeEdge(new Date("2026-03-12")).getYear() // 2026
+     */
     getYear(): number;
+    /**
+     * Retorna as horas da data.
+     * @returns Número da hora (0-23)
+     * @example
+     * new DatetimeEdge(new Date("2026-03-12T14:30:00")).getHours() // 14
+     */
+    getHours(): number;
+    /**
+     * Retorna os minutos da data.
+     * @returns Número dos minutos (0-59)
+     * @example
+     * new DatetimeEdge(new Date("2026-03-12T14:30:00")).getMinutes() // 30
+     */
+    getMinutes(): number;
+    /**
+     * Retorna os segundos da data.
+     * @returns Número dos segundos (0-59)
+     * @example
+     * new DatetimeEdge(new Date("2026-03-12T14:30:45")).getSeconds() // 45
+     */
+    getSeconds(): number;
+    /**
+     * Adiciona dias à data e retorna uma nova instância.
+     * @param days - Número de dias a adicionar
+     * @returns Nova instância com a data atualizada
+     * @example
+     * new DatetimeEdge(new Date("2026-03-12")).addDays(5) // DatetimeEdge("2026-03-17")
+     */
+    addDays(days: number): DatetimeEdge;
+    /**
+     * Subtrai dias da data e retorna uma nova instância.
+     * @param days - Número de dias a subtrair
+     * @returns Nova instância com a data atualizada
+     * @example
+     * new DatetimeEdge(new Date("2026-03-12")).subtractDays(5) // DatetimeEdge("2026-03-07")
+     */
+    subtractDays(days: number): DatetimeEdge;
+    /**
+     * Adiciona meses à data e retorna uma nova instância.
+     * @param months - Número de meses a adicionar
+     * @returns Nova instância com a data atualizada
+     * @example
+     * new DatetimeEdge(new Date("2026-03-12")).addMonths(2) // DatetimeEdge("2026-05-12")
+     */
+    addMonths(months: number): DatetimeEdge;
+    /**
+     * Subtrai meses da data e retorna uma nova instância.
+     * @param months - Número de meses a subtrair
+     * @returns Nova instância com a data atualizada
+     * @example
+     * new DatetimeEdge(new Date("2026-03-12")).subtractMonths(2) // DatetimeEdge("2026-01-12")
+     */
+    subtractMonths(months: number): DatetimeEdge;
+    /**
+     * Adiciona anos à data e retorna uma nova instância.
+     * @param years - Número de anos a adicionar
+     * @returns Nova instância com a data atualizada
+     * @example
+     * new DatetimeEdge(new Date("2026-03-12")).addYears(1) // DatetimeEdge("2027-03-12")
+     */
+    addYears(years: number): DatetimeEdge;
+    /**
+     * Subtrai anos da data e retorna uma nova instância.
+     * @param years - Número de anos a subtrair
+     * @returns Nova instância com a data atualizada
+     * @example
+     * new DatetimeEdge(new Date("2026-03-12")).subtractYears(1) // DatetimeEdge("2025-03-12")
+     */
+    subtractYears(years: number): DatetimeEdge;
+    /**
+     * Adiciona horas à data e retorna uma nova instância.
+     * @param hours - Número de horas a adicionar
+     * @returns Nova instância com a data atualizada
+     * @example
+     * new DatetimeEdge(new Date("2026-03-12T08:00")).addHours(3) // DatetimeEdge("2026-03-12T11:00")
+     */
+    addHours(hours: number): DatetimeEdge;
+    /**
+     * Adiciona minutos à data e retorna uma nova instância.
+     * @param minutes - Número de minutos a adicionar
+     * @returns Nova instância com a data atualizada
+     * @example
+     * new DatetimeEdge(new Date("2026-03-12T08:00")).addMinutes(30) // DatetimeEdge("2026-03-12T08:30")
+     */
+    addMinutes(minutes: number): DatetimeEdge;
+    /**
+     * Calcula a diferença em dias entre esta data e outra.
+     * @param other - Data para calcular a diferença
+     * @returns Número de dias de diferença (positivo se this > other)
+     * @example
+     * new DatetimeEdge(new Date("2026-03-15")).diffInDays(new DatetimeEdge(new Date("2026-03-10"))) // 5
+     */
+    diffInDays(other: DatetimeEdge): number;
+    /**
+     * Calcula a diferença em meses entre esta data e outra.
+     * @param other - Data para calcular a diferença
+     * @returns Número de meses de diferença (positivo se this > other)
+     * @example
+     * new DatetimeEdge(new Date("2026-05-12")).diffInMonths(new DatetimeEdge(new Date("2026-03-12"))) // 2
+     */
+    diffInMonths(other: DatetimeEdge): number;
+    /**
+     * Calcula a diferença em anos entre esta data e outra.
+     * @param other - Data para calcular a diferença
+     * @returns Número de anos de diferença (positivo se this > other)
+     * @example
+     * new DatetimeEdge(new Date("2028-03-12")).diffInYears(new DatetimeEdge(new Date("2026-03-12"))) // 2
+     */
+    diffInYears(other: DatetimeEdge): number;
+    /**
+     * Calcula a diferença em horas entre esta data e outra.
+     * @param other - Data para calcular a diferença
+     * @returns Número de horas de diferença (positivo se this > other)
+     * @example
+     * new DatetimeEdge(new Date("2026-03-12T14:00")).diffInHours(new DatetimeEdge(new Date("2026-03-12T08:00"))) // 6
+     */
+    diffInHours(other: DatetimeEdge): number;
+    /**
+     * Calcula a diferença em minutos entre esta data e outra.
+     * @param other - Data para calcular a diferença
+     * @returns Número de minutos de diferença (positivo se this > other)
+     * @example
+     * new DatetimeEdge(new Date("2026-03-12T08:45")).diffInMinutes(new DatetimeEdge(new Date("2026-03-12T08:00"))) // 45
+     */
+    diffInMinutes(other: DatetimeEdge): number;
+    /**
+     * Retorna a diferença legível entre esta data e o momento atual.
+     * @returns String descritiva como "Há 3 dias.", "Há 2 horas.", etc.
+     * @example
+     * new DatetimeEdge(new Date("2025-03-12")).diffFromNow() // "Há 1 ano."
+     */
+    diffFromNow(): string;
+    /**
+     * Retorna o início do dia (00:00:00.000) como nova instância.
+     * @returns Nova instância com o horário zerado para o início do dia
+     * @example
+     * new DatetimeEdge(new Date("2026-03-12T14:30")).startOfDay()
+     * // DatetimeEdge("2026-03-12T00:00:00.000")
+     */
+    startOfDay(): DatetimeEdge;
+    /**
+     * Retorna o fim do dia (23:59:59.999) como nova instância.
+     * @returns Nova instância com o horário ajustado para o fim do dia
+     * @example
+     * new DatetimeEdge(new Date("2026-03-12T08:00")).endOfDay()
+     * // DatetimeEdge("2026-03-12T23:59:59.999")
+     */
+    endOfDay(): DatetimeEdge;
+    /**
+     * Retorna o início do mês como nova instância.
+     * @returns Nova instância apontando para o primeiro dia do mês à meia-noite
+     * @example
+     * new DatetimeEdge(new Date("2026-03-12")).startOfMonth()
+     * // DatetimeEdge("2026-03-01T00:00:00.000")
+     */
+    startOfMonth(): DatetimeEdge;
+    /**
+     * Retorna o fim do mês como nova instância.
+     * @returns Nova instância apontando para o último dia do mês ao fim do dia
+     * @example
+     * new DatetimeEdge(new Date("2026-03-12")).endOfMonth()
+     * // DatetimeEdge("2026-03-31T23:59:59.999")
+     */
+    endOfMonth(): DatetimeEdge;
+    /**
+     * Retorna o início do ano como nova instância.
+     * @returns Nova instância apontando para o primeiro dia do ano à meia-noite
+     * @example
+     * new DatetimeEdge(new Date("2026-03-12")).startOfYear()
+     * // DatetimeEdge("2026-01-01T00:00:00.000")
+     */
+    startOfYear(): DatetimeEdge;
+    /**
+     * Retorna o fim do ano como nova instância.
+     * @returns Nova instância apontando para o último dia do ano ao fim do dia
+     * @example
+     * new DatetimeEdge(new Date("2026-03-12")).endOfYear()
+     * // DatetimeEdge("2026-12-31T23:59:59.999")
+     */
+    endOfYear(): DatetimeEdge;
+    /**
+     * Cria uma cópia independente desta instância de DatetimeEdge.
+     * @returns Nova instância com o mesmo valor de data
+     * @example
+     * const dt1 = new DatetimeEdge(new Date("2026-03-12"));
+     * const dt2 = dt1.clone(); // instância independente
+     */
+    clone(): DatetimeEdge;
+    /**
+     * Retorna uma nova instância com a data alterada, mantendo o horário.
+     * @param date - Novo objeto Date
+     * @returns Nova instância com o valor fornecido
+     * @example
+     * new DatetimeEdge(new Date("2026-03-12")).withDate(new Date("2026-12-25"))
+     * // DatetimeEdge("2026-12-25")
+     */
+    withDate(date: Date): DatetimeEdge;
+    /**
+     * Retorna a data no formato ISO 8601.
+     * @returns String no formato "YYYY-MM-DDTHH:mm:ss.sssZ"
+     * @example
+     * new DatetimeEdge(new Date("2026-03-12")).toISOString() // "2026-03-12T00:00:00.000Z"
+     */
     toISOString(): string;
-    timestamp(): number;
-    unix(): number;
+    /**
+     * Retorna a data como objeto Date nativo.
+     * @returns Objeto Date representando esta data
+     * @example
+     * new DatetimeEdge(new Date("2026-03-12")).toDate() // Date object
+     */
     toDate(): Date;
+    /**
+     * Retorna a data no formato YYYY-MM-DD.
+     * @returns String no formato "YYYY-MM-DD"
+     * @example
+     * new DatetimeEdge(new Date("2026-03-12")).toYYYYMMDD() // "2026-03-12"
+     */
     toYYYYMMDD(): string;
+    /**
+     * Retorna a data no formato DD/MM/YYYY (padrão brasileiro).
+     * @returns String no formato "DD/MM/YYYY"
+     * @example
+     * new DatetimeEdge(new Date("2026-03-12")).toDDMMYYYY() // "12/03/2026"
+     */
+    toDDMMYYYY(): string;
+    /**
+     * Retorna a data e hora no formato DD/MM/YYYY HH:mm.
+     * @returns String no formato "DD/MM/YYYY HH:mm"
+     * @example
+     * new DatetimeEdge(new Date("2026-03-12T14:30")).toDDMMYYYYHHmm() // "12/03/2026 14:30"
+     */
+    toDDMMYYYYHHmm(): string;
+    /**
+     * Retorna a data formatada com um padrão customizado do moment.js.
+     * @param format - Padrão de formatação (ex: "YYYY-MM-DD HH:mm:ss")
+     * @returns String formatada conforme o padrão fornecido
+     * @example
+     * new DatetimeEdge(new Date("2026-03-12T14:30")).format("MMMM Do YYYY") // "March 12th 2026"
+     */
+    format(format: string): string;
+    /**
+     * Retorna o timestamp em milissegundos da data.
+     * @returns Número de milissegundos desde 01/01/1970 UTC
+     * @example
+     * new DatetimeEdge(new Date("2026-03-12")).timestamp() // 1773273600000
+     */
+    timestamp(): number;
+    /**
+     * Retorna o timestamp Unix em segundos da data.
+     * @returns Número de segundos desde 01/01/1970 UTC
+     * @example
+     * new DatetimeEdge(new Date("2026-03-12")).unix() // 1773273600
+     */
+    unix(): number;
+    /**
+     * Cria um DatetimeEdge representando o momento atual.
+     * @returns Nova instância com a data e hora atuais
+     * @example
+     * DatetimeEdge.now() // DatetimeEdge com a data e hora do momento da chamada
+     */
+    static now(): DatetimeEdge;
+    /**
+     * Retorna a maior (mais recente) data de uma lista.
+     * @param dates - Array de instâncias de DatetimeEdge para comparação
+     * @returns A instância com a data mais recente
+     * @throws {Error} Se o array estiver vazio
+     * @example
+     * DatetimeEdge.max([
+     *   new DatetimeEdge(new Date("2026-01-01")),
+     *   new DatetimeEdge(new Date("2026-06-15")),
+     * ]) // DatetimeEdge("2026-06-15")
+     */
+    static max(dates: DatetimeEdge[]): DatetimeEdge;
+    /**
+     * Retorna a menor (mais antiga) data de uma lista.
+     * @param dates - Array de instâncias de DatetimeEdge para comparação
+     * @returns A instância com a data mais antiga
+     * @throws {Error} Se o array estiver vazio
+     * @example
+     * DatetimeEdge.min([
+     *   new DatetimeEdge(new Date("2026-01-01")),
+     *   new DatetimeEdge(new Date("2026-06-15")),
+     * ]) // DatetimeEdge("2026-01-01")
+     */
+    static min(dates: DatetimeEdge[]): DatetimeEdge;
+    /**
+     * Valida se a data fornecida no construtor é uma data válida.
+     * @throws {Error} Se a data for inválida
+     */
     protected validate(): void;
 }