predictype

predictype v0.8.1

---

predictype / predicates/dates / dateComparison

Function: dateComparison()

dateComparison(source, oper, target): boolean

Defined in: predicates/dates/dateComparison.ts:41

Compares two dates in UTC using the specified comparison operation.

Parameters

source

Date

The first date to compare.

oper

DateComparisonOper

The comparison operation to perform (e.g. ‘after’, ‘before’, ‘equals’).

target

Date

The second date to compare against.

Returns

boolean

True if the comparison is valid according to the operator, otherwise false.

Throws

If the operation is not recognized.

Example

const d1 = new Date('2025-01-01');
const d2 = new Date('2025-01-02');
dateComparison(d1, 'before', d2); // true
dateComparison(d1, 'equals', d1); // true

Remarks

Supported Operators:

• AFTER: Is the first date after the second?
• AFTER_OR_EQUAL: After or equal to the second date?
• BEFORE: Is the first date before the second?
• BEFORE_OR_EQUAL: Before or equal to the second date?
• EQUALS: Are the dates equal?
• NOT_EQUALS: Are the dates not equal?
• SAME_DAY: Are the dates on the same day?
• SAME_MONTH: Are the dates in the same month?
• SAME_YEAR: Are the dates in the same year?

This site is open source. Improve this page.