timepiece/node_modules/date-fns/isBefore.d.ts

25 lines
840 B
TypeScript
Raw Normal View History

2024-05-14 14:54:12 +00:00
/**
* @name isBefore
* @category Common Helpers
* @summary Is the first date before the second one?
*
* @description
* Is the first date before the second one?
*
* @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 date - The date that should be before the other one to return true
* @param dateToCompare - The date to compare with
*
* @returns The first date is before the second date
*
* @example
* // Is 10 July 1989 before 11 February 1987?
* const result = isBefore(new Date(1989, 6, 10), new Date(1987, 1, 11))
* //=> false
*/
export declare function isBefore<DateType extends Date>(
date: DateType | number | string,
dateToCompare: DateType | number | string,
): boolean;