@uplink-protocol/calendar-controller
Version:
Flexible calendar and time picker API supporting both calendar, date-picker, and time-picker integrations for any JavaScript framework or library
253 lines (127 loc) • 5.22 kB
Markdown
[**@uplink-protocol/form-controller v0.3.1**](../README.md)
***
[@uplink-protocol/form-controller](../globals.md) / IConstraintsService
# Interface: IConstraintsService
Defined in: [Date/interfaces/constraints.service.interfaces.ts:5](https://github.com/jmkcoder/uplink-protocol-calendar/blob/4cde26f472352440ee258db7670fce2e95651862/src/Date/interfaces/constraints.service.interfaces.ts#L5)
Constraints service interface
Responsible for managing date constraints like min/max dates and disabled dates
## Methods
### addDisabledDate()
> **addDisabledDate**(`date`): `Date`[]
Defined in: [Date/interfaces/constraints.service.interfaces.ts:44](https://github.com/jmkcoder/uplink-protocol-calendar/blob/4cde26f472352440ee258db7670fce2e95651862/src/Date/interfaces/constraints.service.interfaces.ts#L44)
Add a date to the disabled dates list
#### Parameters
##### date
`Date`
#### Returns
`Date`[]
***
### addDisabledDayOfWeek()
> **addDisabledDayOfWeek**(`day`): `number`[]
Defined in: [Date/interfaces/constraints.service.interfaces.ts:54](https://github.com/jmkcoder/uplink-protocol-calendar/blob/4cde26f472352440ee258db7670fce2e95651862/src/Date/interfaces/constraints.service.interfaces.ts#L54)
Add a day of the week to the disabled days list
#### Parameters
##### day
`number`
#### Returns
`number`[]
***
### getConstraints()
> **getConstraints**(): `object`
Defined in: [Date/interfaces/constraints.service.interfaces.ts:34](https://github.com/jmkcoder/uplink-protocol-calendar/blob/4cde26f472352440ee258db7670fce2e95651862/src/Date/interfaces/constraints.service.interfaces.ts#L34)
Get current constraints
#### Returns
`object`
##### disabledDates
> **disabledDates**: `Date`[]
##### disabledDaysOfWeek
> **disabledDaysOfWeek**: `number`[]
##### maxDate
> **maxDate**: `Date` \| `null`
##### minDate
> **minDate**: `Date` \| `null`
***
### getDisabledDaysOfWeek()
> **getDisabledDaysOfWeek**(): `number`[]
Defined in: [Date/interfaces/constraints.service.interfaces.ts:64](https://github.com/jmkcoder/uplink-protocol-calendar/blob/4cde26f472352440ee258db7670fce2e95651862/src/Date/interfaces/constraints.service.interfaces.ts#L64)
Get disabled days of the week
#### Returns
`number`[]
***
### isDateDisabled()
> **isDateDisabled**(`date`, `minDate`, `maxDate`, `disabledDates`, `disabledDaysOfWeek?`): `boolean`
Defined in: [Date/interfaces/constraints.service.interfaces.ts:29](https://github.com/jmkcoder/uplink-protocol-calendar/blob/4cde26f472352440ee258db7670fce2e95651862/src/Date/interfaces/constraints.service.interfaces.ts#L29)
Check if a date is disabled
#### Parameters
##### date
`Date`
##### minDate
`Date` | `null`
##### maxDate
`Date` | `null`
##### disabledDates
`Date`[]
##### disabledDaysOfWeek?
`number`[]
#### Returns
`boolean`
***
### removeDisabledDate()
> **removeDisabledDate**(`date`): `Date`[]
Defined in: [Date/interfaces/constraints.service.interfaces.ts:49](https://github.com/jmkcoder/uplink-protocol-calendar/blob/4cde26f472352440ee258db7670fce2e95651862/src/Date/interfaces/constraints.service.interfaces.ts#L49)
Remove a date from the disabled dates list
#### Parameters
##### date
`Date`
#### Returns
`Date`[]
***
### removeDisabledDayOfWeek()
> **removeDisabledDayOfWeek**(`day`): `number`[]
Defined in: [Date/interfaces/constraints.service.interfaces.ts:59](https://github.com/jmkcoder/uplink-protocol-calendar/blob/4cde26f472352440ee258db7670fce2e95651862/src/Date/interfaces/constraints.service.interfaces.ts#L59)
Remove a day of the week from the disabled days list
#### Parameters
##### day
`number`
#### Returns
`number`[]
***
### setDisabledDates()
> **setDisabledDates**(`dates`): `Date`[]
Defined in: [Date/interfaces/constraints.service.interfaces.ts:19](https://github.com/jmkcoder/uplink-protocol-calendar/blob/4cde26f472352440ee258db7670fce2e95651862/src/Date/interfaces/constraints.service.interfaces.ts#L19)
Set disabled dates
#### Parameters
##### dates
`Date`[]
#### Returns
`Date`[]
***
### setDisabledDaysOfWeek()
> **setDisabledDaysOfWeek**(`days`): `number`[]
Defined in: [Date/interfaces/constraints.service.interfaces.ts:24](https://github.com/jmkcoder/uplink-protocol-calendar/blob/4cde26f472352440ee258db7670fce2e95651862/src/Date/interfaces/constraints.service.interfaces.ts#L24)
Set disabled days of the week
#### Parameters
##### days
`number`[]
#### Returns
`number`[]
***
### setMaxDate()
> **setMaxDate**(`date`): `Date` \| `null`
Defined in: [Date/interfaces/constraints.service.interfaces.ts:14](https://github.com/jmkcoder/uplink-protocol-calendar/blob/4cde26f472352440ee258db7670fce2e95651862/src/Date/interfaces/constraints.service.interfaces.ts#L14)
Set maximum date
#### Parameters
##### date
`Date` | `null`
#### Returns
`Date` \| `null`
***
### setMinDate()
> **setMinDate**(`date`): `Date` \| `null`
Defined in: [Date/interfaces/constraints.service.interfaces.ts:9](https://github.com/jmkcoder/uplink-protocol-calendar/blob/4cde26f472352440ee258db7670fce2e95651862/src/Date/interfaces/constraints.service.interfaces.ts#L9)
Set minimum date
#### Parameters
##### date
`Date` | `null`
#### Returns
`Date` \| `null`