| 1234567891011121314151617181920212223242526 |
- import type { Duration, Interval } from "./types.js";
- /**
- * @name intervalToDuration
- * @category Common Helpers
- * @summary Convert interval to duration
- *
- * @description
- * Convert a interval object to a duration object.
- *
- * @typeParam DateType - The `Date` type, the function operates on. Gets inferred from passed arguments. Allows to use extensions like [`UTCDate`](https://github.com/date-fns/utc).
- *
- * @param interval - The interval to convert to duration
- *
- * @returns The duration object
- *
- * @example
- * // Get the duration between January 15, 1929 and April 4, 1968.
- * intervalToDuration({
- * start: new Date(1929, 0, 15, 12, 0, 0),
- * end: new Date(1968, 3, 4, 19, 5, 0)
- * })
- * // => { years: 39, months: 2, days: 20, hours: 7, minutes: 5, seconds: 0 }
- */
- export declare function intervalToDuration<DateType extends Date>(
- interval: Interval<DateType>,
- ): Duration;
|