31 lines
956 B
JavaScript
31 lines
956 B
JavaScript
|
import { toDate } from "./toDate.mjs";
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @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 function isBefore(date, dateToCompare) {
|
||
|
|
const _date = toDate(date);
|
||
|
|
const _dateToCompare = toDate(dateToCompare);
|
||
|
|
return +_date < +_dateToCompare;
|
||
|
|
}
|
||
|
|
|
||
|
|
// Fallback for modularized imports:
|
||
|
|
export default isBefore;
|