@hebcal/core
    Preparing search index...

    Variable gregConst

    greg: {
        abs2greg(abs: number): Date;
        daysInMonth(month: number, year: number): number;
        greg2abs(date: Date): number;
        isDate(obj: unknown): obj is Date;
        isLeapYear(year: number): boolean;
    }

    Gregorian date helper functions.

    These are aliases retained for backwards compatibility. Each member simply forwards to the identically-behaving top-level function, which is the preferred form in new code because it tree-shakes cleanly:

    Namespace Top-level equivalent
    greg.abs2greg abs2greg
    greg.daysInMonth daysInGregMonth
    greg.greg2abs greg2abs
    greg.isDate isDate
    greg.isLeapYear isGregLeapYear

    Type Declaration

    • abs2greg: function

      • Converts from Rata Die (R.D. number) to Gregorian date. Alias for the top-level abs2greg.

        Parameters

        • abs: number

        Returns Date

    • daysInMonth: function

      • Number of days in the Gregorian month for given year. Alias for the top-level daysInGregMonth.

        Parameters

        • month: number

          Gregorian month (1=January, 12=December)

        • year: number

          Gregorian year

        Returns number

    • greg2abs: function

      • Converts Gregorian date to absolute R.D. (Rata Die) days. Alias for the top-level greg2abs.

        Parameters

        • date: Date

        Returns number

    • isDate: function

      • Returns true if the object is a Javascript Date. Alias for the top-level isDate.

        Parameters

        • obj: unknown

        Returns obj is Date

    • isLeapYear: function

      • Returns true if the Gregorian year is a leap year. Alias for the top-level isGregLeapYear.

        Parameters

        • year: number

          Gregorian year

        Returns boolean

    import {greg} from '@hebcal/hdate';
    greg.greg2abs(new Date(2008, 10, 13)); // 733359
    greg.isLeapYear(2024);                 // true

    Settings
    Member Visibility