UNPKG

@uplink-protocol/calendar-controller

Version:

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

163 lines (82 loc) 3.68 kB
[**@uplink-protocol/form-controller v0.2.1**](../README.md) *** [@uplink-protocol/form-controller](../globals.md) / IDateFormattingService # Interface: IDateFormattingService Defined in: [interfaces/date-formatting.service.interfaces.ts:5](https://github.com/jmkcoder/uplink-protocol-calendar/blob/311e0b81efba7399cf1c367c0a2007aa66f3b830/src/interfaces/date-formatting.service.interfaces.ts#L5) Date formatting service interface Responsible for formatting dates ## Methods ### formatDate() > **formatDate**(`date`, `format?`): `string` Defined in: [interfaces/date-formatting.service.interfaces.ts:9](https://github.com/jmkcoder/uplink-protocol-calendar/blob/311e0b81efba7399cf1c367c0a2007aa66f3b830/src/interfaces/date-formatting.service.interfaces.ts#L9) Format a date according to the specified format string #### Parameters ##### date `Date` ##### format? `string` #### Returns `string` *** ### getDateFormatOptions() > **getDateFormatOptions**(): `null` \| `DateTimeFormatOptions` Defined in: [interfaces/date-formatting.service.interfaces.ts:44](https://github.com/jmkcoder/uplink-protocol-calendar/blob/311e0b81efba7399cf1c367c0a2007aa66f3b830/src/interfaces/date-formatting.service.interfaces.ts#L44) Get the date format options #### Returns `null` \| `DateTimeFormatOptions` *** ### getDefaultFormat() > **getDefaultFormat**(): `null` \| `string` Defined in: [interfaces/date-formatting.service.interfaces.ts:24](https://github.com/jmkcoder/uplink-protocol-calendar/blob/311e0b81efba7399cf1c367c0a2007aa66f3b830/src/interfaces/date-formatting.service.interfaces.ts#L24) Get the default date format #### Returns `null` \| `string` *** ### getLocalizationService() > **getLocalizationService**(): `any` Defined in: [interfaces/date-formatting.service.interfaces.ts:34](https://github.com/jmkcoder/uplink-protocol-calendar/blob/311e0b81efba7399cf1c367c0a2007aa66f3b830/src/interfaces/date-formatting.service.interfaces.ts#L34) Get the localization service #### Returns `any` *** ### parseDate() > **parseDate**(`dateString`, `format?`): `null` \| `Date` Defined in: [interfaces/date-formatting.service.interfaces.ts:14](https://github.com/jmkcoder/uplink-protocol-calendar/blob/311e0b81efba7399cf1c367c0a2007aa66f3b830/src/interfaces/date-formatting.service.interfaces.ts#L14) Parse a date string according to the specified format #### Parameters ##### dateString `string` ##### format? `string` #### Returns `null` \| `Date` *** ### setDateFormatOptions() > **setDateFormatOptions**(`options`): `void` Defined in: [interfaces/date-formatting.service.interfaces.ts:39](https://github.com/jmkcoder/uplink-protocol-calendar/blob/311e0b81efba7399cf1c367c0a2007aa66f3b830/src/interfaces/date-formatting.service.interfaces.ts#L39) Set the date format options #### Parameters ##### options `DateTimeFormatOptions` #### Returns `void` *** ### setDefaultFormat() > **setDefaultFormat**(`format`): `void` Defined in: [interfaces/date-formatting.service.interfaces.ts:19](https://github.com/jmkcoder/uplink-protocol-calendar/blob/311e0b81efba7399cf1c367c0a2007aa66f3b830/src/interfaces/date-formatting.service.interfaces.ts#L19) Set the default date format #### Parameters ##### format `string` #### Returns `void` *** ### setLocalizationService() > **setLocalizationService**(`service`): `void` Defined in: [interfaces/date-formatting.service.interfaces.ts:29](https://github.com/jmkcoder/uplink-protocol-calendar/blob/311e0b81efba7399cf1c367c0a2007aa66f3b830/src/interfaces/date-formatting.service.interfaces.ts#L29) Set the localization service #### Parameters ##### service `any` #### Returns `void`