ts-time-utils/dist/calculate.d.ts

A comprehensive TypeScript utility library for time, dates, durations, and calendar operations with full tree-shaking support

import { TimeUnit } from './constants.js';
/**
 * Calculate difference between two dates in specified unit
 * @param date1 - first date
 * @param date2 - second date
 * @param unit - unit to return the difference in
 * @param precise - if true, returns decimal values; if false, returns integers
 */
export declare function differenceInUnits(date1: Date, date2: Date, unit?: TimeUnit, precise?: boolean): number;
/**
 * Add time to a date
 * @param date - base date
 * @param amount - amount to add
 * @param unit - unit of the amount
 */
export declare function addTime(date: Date, amount: number, unit: TimeUnit): Date;
/**
 * Subtract time from a date
 * @param date - base date
 * @param amount - amount to subtract
 * @param unit - unit of the amount
 */
export declare function subtractTime(date: Date, amount: number, unit: TimeUnit): Date;
/**
 * Get the start of a time period for a given date
 * @param date - input date
 * @param unit - time unit to get the start of
 */
export declare function startOf(date: Date, unit: 'day' | 'week' | 'month' | 'year' | 'hour' | 'minute'): Date;
/**
 * Get the end of a time period for a given date
 * @param date - input date
 * @param unit - time unit to get the end of
 */
export declare function endOf(date: Date, unit: 'day' | 'week' | 'month' | 'year' | 'hour' | 'minute'): Date;
/**
 * Check if a date is between two other dates
 * @param date - date to check
 * @param start - start date (inclusive)
 * @param end - end date (inclusive)
 */
export declare function isBetween(date: Date, start: Date, end: Date): boolean;
/**
 * Get the number of business days between two dates (excludes weekends)
 * @param startDate - start date
 * @param endDate - end date
 */
export declare function businessDaysBetween(startDate: Date, endDate: Date): number;
//# sourceMappingURL=calculate.d.ts.map