UNPKG

@uplink-protocol/calendar-controller

Version:

Flexible calendar API supporting both calendar and date-picker integrations for any JavaScript framework or library

129 lines (65 loc) 2.63 kB
[**@uplink-protocol/form-controller v0.2.1**](../README.md) *** [@uplink-protocol/form-controller](../globals.md) / IDateValidationService # Interface: IDateValidationService Defined in: [interfaces/date-validation.service.interfaces.ts:5](https://github.com/jmkcoder/uplink-protocol-calendar/blob/311e0b81efba7399cf1c367c0a2007aa66f3b830/src/interfaces/date-validation.service.interfaces.ts#L5) Date validation service interface Responsible for date validation and constraint checking ## Methods ### isDateDisabled() > **isDateDisabled**(`date`, `minDate`, `maxDate`, `disabledDates`): `boolean` Defined in: [interfaces/date-validation.service.interfaces.ts:9](https://github.com/jmkcoder/uplink-protocol-calendar/blob/311e0b81efba7399cf1c367c0a2007aa66f3b830/src/interfaces/date-validation.service.interfaces.ts#L9) Check if a date is disabled based on constraints #### Parameters ##### date `Date` ##### minDate `null` | `Date` ##### maxDate `null` | `Date` ##### disabledDates `Date`[] #### Returns `boolean` *** ### isSameDay() > **isSameDay**(`date1`, `date2`): `boolean` Defined in: [interfaces/date-validation.service.interfaces.ts:34](https://github.com/jmkcoder/uplink-protocol-calendar/blob/311e0b81efba7399cf1c367c0a2007aa66f3b830/src/interfaces/date-validation.service.interfaces.ts#L34) Check if two dates represent the same day #### Parameters ##### date1 `Date` ##### date2 `Date` #### Returns `boolean` *** ### setDisabledDates() > **setDisabledDates**(`dates`): `Date`[] Defined in: [interfaces/date-validation.service.interfaces.ts:29](https://github.com/jmkcoder/uplink-protocol-calendar/blob/311e0b81efba7399cf1c367c0a2007aa66f3b830/src/interfaces/date-validation.service.interfaces.ts#L29) Set disabled dates #### Parameters ##### dates `Date`[] #### Returns `Date`[] *** ### setMaxDate() > **setMaxDate**(`date`): `null` \| `Date` Defined in: [interfaces/date-validation.service.interfaces.ts:24](https://github.com/jmkcoder/uplink-protocol-calendar/blob/311e0b81efba7399cf1c367c0a2007aa66f3b830/src/interfaces/date-validation.service.interfaces.ts#L24) Set maximum selectable date #### Parameters ##### date `null` | `Date` #### Returns `null` \| `Date` *** ### setMinDate() > **setMinDate**(`date`): `null` \| `Date` Defined in: [interfaces/date-validation.service.interfaces.ts:19](https://github.com/jmkcoder/uplink-protocol-calendar/blob/311e0b81efba7399cf1c367c0a2007aa66f3b830/src/interfaces/date-validation.service.interfaces.ts#L19) Set minimum selectable date #### Parameters ##### date `null` | `Date` #### Returns `null` \| `Date`