datemapper/dist/increment-date.d.ts

A lightweight date utility for format conversion, validation, and date manipulation.

import { TIncrementType } from "./types";
/**
 * Increments a date by a specified time unit (day, month, hour, year, or week).
 * Ensures proper timezone adjustments while maintaining consistency in date calculations.
 *
 * @param date - The initial Date object to be incremented.
 * @param incrementType - The unit of time to increment.
 *                        Accepts one of the following values: "day", "month", "hour", "year", "week".
 * @param timezone - The timezone in which the date should be interpreted and adjusted.
 * @returns A new Date object representing the incremented date.
 * @throws {Error} If an invalid increment type is provided.
 */
declare const incrementDate: (date: Date, incrementType: TIncrementType, timezone: string) => Date;
export default incrementDate;