Function: dateMatchModifiers()
dateMatchModifiers(
date,matchers,dateLib):boolean
Returns whether a day matches against at least one of the given Matcher.
const date = new Date(2022, 5, 19);
const matcher1: DateRange = {
from: new Date(2021, 12, 21),
to: new Date(2021, 12, 30)
}
const matcher2: DateRange = {
from: new Date(2022, 5, 1),
to: new Date(2022, 5, 23)
}
const dateMatchModifiers(date, [matcher1, matcher2]); // true, since day is in the matcher1 range.
Parameters​
| Parameter | Type | Default value | Description |
|---|---|---|---|
date | Date | undefined | - |
matchers | Matcher | Matcher[] | undefined | - |
dateLib | object | defaultDateLib | - |
dateLib.addDays | <DateType, ResultDate>(date, amount, options?) => ResultDate | undefined | - |
dateLib.addMonths | <DateType, ResultDate>(date, amount, options?) => ResultDate | undefined | - |
dateLib.addWeeks | <DateType, ResultDate>(date, amount, options?) => ResultDate | undefined | - |
dateLib.addYears | <DateType, ResultDate>(date, amount, options?) => ResultDate | undefined | - |
dateLib.Date | GenericDateConstructor<Date> | ... | The constructor of the date object. |
dateLib.differenceInCalendarDays | (laterDate, earlierDate, options?) => number | undefined | - |
dateLib.differenceInCalendarMonths | (laterDate, earlierDate, options?) => number | undefined | - |
dateLib.endOfISOWeek | <DateType, ResultDate>(date, options?) => ResultDate | undefined | - |
dateLib.endOfMonth | <DateType, ResultDate>(date, options?) => ResultDate | undefined | - |
dateLib.endOfWeek | <DateType, ResultDate>(date, options?) => ResultDate | undefined | - |
dateLib.endOfYear | <DateType, ResultDate>(date, options?) => ResultDate | undefined | - |
dateLib.format | (date, formatStr, options?) => string | undefined | - |
dateLib.getISOWeek | (date, options?) => number | undefined | - |
dateLib.getWeek | (date, options?) => number | undefined | - |
dateLib.isAfter | (date, dateToCompare) => boolean | undefined | - |
dateLib.isBefore | (date, dateToCompare) => boolean | undefined | - |
dateLib.isDate | (value) => value is Date | undefined | - |
dateLib.isSameDay | (laterDate, earlierDate, options?) => boolean | undefined | - |
dateLib.isSameMonth | (laterDate, earlierDate, options?) => boolean | undefined | - |
dateLib.isSameYear | (laterDate, earlierDate, options?) => boolean | undefined | - |
dateLib.max | <DateType, ResultDate>(dates, options?) => ResultDate | undefined | - |
dateLib.min | <DateType, ResultDate>(dates, options?) => ResultDate | undefined | - |
dateLib.setMonth | <DateType, ResultDate>(date, month, options?) => ResultDate | undefined | - |
dateLib.setYear | <DateType, ResultDate>(date, year, options?) => ResultDate | undefined | - |
dateLib.startOfDay | <DateType, ResultDate>(date, options?) => ResultDate | undefined | - |
dateLib.startOfISOWeek | <DateType, ResultDate>(date, options?) => ResultDate | undefined | - |
dateLib.startOfMonth | <DateType, ResultDate>(date, options?) => ResultDate | undefined | - |
dateLib.startOfWeek | <DateType, ResultDate>(date, options?) => ResultDate | undefined | - |
dateLib.startOfYear | <DateType, ResultDate>(date, options?) => ResultDate | undefined | - |
Returns​
boolean