@jlhv/date-helper/dist/index.d.ts

A simple date helper utility for different time formats.

/**
 * Formats a date string.
 */
export declare function formatDate(date?: Date | string, formatStr?: string): string;
/** Date Retrieval Functions */
export declare const getISODate: () => string;
export declare const getUTCDate: () => string;
export declare const getCurrentDate: () => Date;
export declare const getCurrentDateString: (formatStr?: string) => string;
/** Get Specific Parts of a Date */
export declare const getDayOfWeek: (date?: Date | string) => string;
export declare const getMonthOfYear: (date?: Date | string) => string;
export declare const getYear: (date?: Date | string) => number;
/** Arithmetic Operations */
export declare const addDays: (date: Date | string, days: number) => Date;
export declare const addWeeks: (date: Date | string, weeks: number) => Date;
export declare const addMonths: (date: Date | string, months: number) => Date;
export declare const addYears: (date: Date | string, years: number) => Date;
/** Subtraction Operations */
export declare const subtractDays: (date: Date | string, days: number) => Date;
export declare const subtractWeeks: (date: Date | string, weeks: number) => Date;
export declare const subtractMonths: (date: Date | string, months: number) => Date;
export declare const subtractYears: (date: Date | string, years: number) => Date;
/** Leap Year Check */
export declare const isLeapYear: (date: Date | string) => boolean;
/** Month Details */
export declare const getDaysInMonth: (date: Date | string) => number;
export declare const getFirstDayOfMonth: (date: Date | string) => Date;
export declare const getLastDayOfMonth: (date: Date | string) => Date;
/** Difference Between Dates */
export declare const getDaysBetweenDates: (date1: Date | string, date2: Date | string) => number;
export declare const getWeeksBetweenDates: (date1: Date | string, date2: Date | string) => number;
export declare const getMonthsBetweenDates: (date1: Date | string, date2: Date | string) => number;
export declare const getYearsBetweenDates: (date1: Date | string, date2: Date | string) => number;
/** Timezone Adjustments */
export declare const getCurrentDateInTimezone: (timezone: string, formatStr?: string) => string;
export declare const getTimezoneOffset: (date: Date | string) => number;
export declare const getTimezoneName: () => string;
export declare const getTimezoneAbbreviation: (date: Date | string) => string;
/** Daylight Saving Time Adjustments */
export declare const isDaylightSavingTime: (date: Date | string) => boolean;
export declare const getDSTStart: (date: Date | string) => Date;
export declare const getDSTEnd: (date: Date | string) => Date;
export declare const getDSTOffset: (date: Date | string) => number;
/** Daylight Saving Time Adjustments in Timezone */
export declare const getDSTStartInTimezone: (timezone: string, formatStr?: string) => string;
export declare const getDSTEndInTimezone: (timezone: string, formatStr?: string) => string;
export declare const getDSTOffsetInTimezone: (timezone: string, date: Date | string) => number;