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

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

import { TimeUnit } from './constants.js';
import type { AgeResult } from './types.js';
/**
 * Calculate detailed age from birth date
 * @param birthDate - date of birth
 * @param referenceDate - date to calculate age from (defaults to now)
 */
export declare function calculateAge(birthDate: Date, referenceDate?: Date): AgeResult;
/**
 * Get age in specific units
 * @param birthDate - date of birth
 * @param unit - unit to return age in
 * @param referenceDate - date to calculate from (defaults to now)
 */
export declare function getAgeInUnits(birthDate: Date, unit: TimeUnit, referenceDate?: Date): number;
/**
 * Determine life stage based on age
 * @param birthDate - date of birth
 * @param referenceDate - date to calculate from (defaults to now)
 */
export declare function getLifeStage(birthDate: Date, referenceDate?: Date): 'infant' | 'child' | 'teen' | 'adult' | 'senior';
/**
 * Get the next birthday date
 * @param birthDate - date of birth
 * @param referenceDate - date to calculate from (defaults to now)
 */
export declare function getNextBirthday(birthDate: Date, referenceDate?: Date): Date;
/**
 * Get days until next birthday
 * @param birthDate - date of birth
 * @param referenceDate - date to calculate from (defaults to now)
 */
export declare function getDaysUntilBirthday(birthDate: Date, referenceDate?: Date): number;
/**
 * Check if today is someone's birthday
 * @param birthDate - date of birth
 * @param referenceDate - date to check (defaults to now)
 */
export declare function isBirthday(birthDate: Date, referenceDate?: Date): boolean;
//# sourceMappingURL=age.d.ts.map