@javiertinc/essentials/date.d.ts

Una librería con variedad de funciones útiles que considero esenciales en la mayoría de los desarrollos web.

declare const date: {
    /**
     * Formatea una fecha a un formato específico
     * @param date - La fecha a formatear
     * @param format - El formato deseado (por defecto 'dd/mm/yyyy H:i:s')
     * @returns La fecha formateada como string
     **/
    format(date: Date, format?: string): string;
    /**
     * Convierte una fecha a la zona horaria especificada
     * @param date - La fecha a convertir
     * @param timezone - La zona horaria a la cual convertir (por defecto 'America/Santiago')
     * @returns La fecha convertida a la zona horaria especificada
     **/
    parseTimezone(date: Date, timezone?: string): Date;
    /**
     * Calcula la cantidad de días entre dos fechas
     * @param date1 - Primera fecha
     * @param date2 - Segunda fecha
     * @returns La cantidad de días entre las dos fechas
     **/
    daysBetween(date1: Date, date2: Date): number;
    time: {
        /**
         * Suma tiempo a una fecha
         * @param date - La fecha a la cual se le sumará el tiempo
         * @param time - Un objeto con horas, minutos y segundos a sumar
         * @param time.hours - Horas a sumar
         * @param time.minutes - Minutos a sumar
         * @param time.seconds - Segundos a sumar
         * @returns La nueva fecha con el tiempo sumado
         **/
        add(date: Date, time?: {
            hours: number;
            minutes: number;
            seconds: number;
        }): Date;
        /**
         * Resta tiempo a una fecha
         * @param date - La fecha a la cual se le restará el tiempo
         * @param time - Un objeto con horas, minutos y segundos a restar
         * @param time.hours - Horas a restar
         * @param time.minutes - Minutos a restar
         * @param time.seconds - Segundos a restar
         * @returns La nueva fecha con el tiempo restado
         **/
        sub(date: Date, time?: {
            hours: number;
            minutes: number;
            seconds: number;
        }): Date;
    };
    days: {
        /**
         * Suma días a una fecha
         * @param date - La fecha a la cual se le sumarán los días
         * @param days - La cantidad de días a sumar
         * @returns La nueva fecha con los días sumados
         **/
        add(date: Date, days: number): Date;
        /**
         * Resta días a una fecha
         * @param date - La fecha a la cual se le restarán los días
         * @param days - La cantidad de días a restar
         * @returns La nueva fecha con los días restados
         **/
        sub(date: Date, days: number): Date;
    };
    months: {
        /**
         * Suma meses a una fecha
         * @param date - La fecha a la cual se le sumarán los meses
         * @param months - La cantidad de meses a sumar
         * @returns La nueva fecha con los meses sumados
         **/
        add(date: Date, months: number): Date;
        /**
         * Resta meses a una fecha
         * @param date - La fecha a la cual se le restarán los meses
         * @param months - La cantidad de meses a restar
         * @returns La nueva fecha con los meses restados
         **/
        sub(date: Date, months: number): Date;
    };
    years: {
        /**
         * Suma años a una fecha
         * @param date - La fecha a la cual se le sumarán los años
         * @param years - La cantidad de años a sumar
         * @returns La nueva fecha con los años sumados
         **/
        add(date: Date, years: number): Date;
        /**
         * Resta años a una fecha
         * @param date - La fecha a la cual se le restarán los años
         * @param years - La cantidad de años a restar
         * @returns La nueva fecha con los años restados
         **/
        sub(date: Date, years: number): Date;
    };
    /**
     * Obtiene la edad a partir de una fecha de nacimiento
     * @param birthdate - Fecha de nacimiento en formato 'YYYY-MM-DD'
     * @returns Un objeto con años, meses y días
     **/
    getAge(birthdate: string): {
        years: number;
        months: number;
        days: number;
    };
    /**
     * Obtiene el nombre del día de la semana en el idioma especificado
     * @param date - La fecha de la cual obtener el día de la semana
     * @param locale - El código de idioma (ej: 'es-ES', 'en-US', 'fr-FR')
     * @returns El nombre del día de la semana en el idioma especificado
     **/
    getDayOfWeek(date: Date, locale?: string): string;
    /**
     * Obtiene el nombre del mes en el idioma especificado
     * @param date - La fecha de la cual obtener el mes
     * @param locale - El código de idioma (ej: 'es-ES', 'en-US', 'fr-FR')
     * @returns El nombre del mes en el idioma especificado
     **/
    getMonth(date: Date, locale?: string): string;
};
export default date;