UNPKG

@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

github.com/jmkcoder/uplink-protocol-calendar

jmkcoder/uplink-protocol-calendar

187 lines (94 loc) • 4.33 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
[**@uplink-protocol/form-controller v0.3.1**](../README.md) *** [@uplink-protocol/form-controller](../globals.md) / ITimeGeneratorService # Interface: ITimeGeneratorService Defined in: [Time/interfaces/time-generator.service.interfaces.ts:7](https://github.com/jmkcoder/uplink-protocol-calendar/blob/4cde26f472352440ee258db7670fce2e95651862/src/Time/interfaces/time-generator.service.interfaces.ts#L7) Time generator service interface Generates time segments and views ## Methods ### applyStep() > **applyStep**(`segments`, `step`): [`TimeSegment`](TimeSegment.md)[] Defined in: [Time/interfaces/time-generator.service.interfaces.ts:56](https://github.com/jmkcoder/uplink-protocol-calendar/blob/4cde26f472352440ee258db7670fce2e95651862/src/Time/interfaces/time-generator.service.interfaces.ts#L56) Apply time step intervals #### Parameters ##### segments [`TimeSegment`](TimeSegment.md)[] Input segments ##### step `number` Step interval #### Returns [`TimeSegment`](TimeSegment.md)[] Filtered segments based on step *** ### generateHourSegments() > **generateHourSegments**(`options`): [`TimeSegment`](TimeSegment.md)[] Defined in: [Time/interfaces/time-generator.service.interfaces.ts:20](https://github.com/jmkcoder/uplink-protocol-calendar/blob/4cde26f472352440ee258db7670fce2e95651862/src/Time/interfaces/time-generator.service.interfaces.ts#L20) Generate hour segments #### Parameters ##### options [`TimeGenerationOptions`](TimeGenerationOptions.md) Generation options #### Returns [`TimeSegment`](TimeSegment.md)[] Array of hour segments *** ### generateMillisecondSegments() > **generateMillisecondSegments**(`options`): [`TimeSegment`](TimeSegment.md)[] Defined in: [Time/interfaces/time-generator.service.interfaces.ts:41](https://github.com/jmkcoder/uplink-protocol-calendar/blob/4cde26f472352440ee258db7670fce2e95651862/src/Time/interfaces/time-generator.service.interfaces.ts#L41) Generate millisecond segments #### Parameters ##### options [`TimeGenerationOptions`](TimeGenerationOptions.md) Generation options #### Returns [`TimeSegment`](TimeSegment.md)[] Array of millisecond segments *** ### generateMinuteSegments() > **generateMinuteSegments**(`options`): [`TimeSegment`](TimeSegment.md)[] Defined in: [Time/interfaces/time-generator.service.interfaces.ts:27](https://github.com/jmkcoder/uplink-protocol-calendar/blob/4cde26f472352440ee258db7670fce2e95651862/src/Time/interfaces/time-generator.service.interfaces.ts#L27) Generate minute segments #### Parameters ##### options [`TimeGenerationOptions`](TimeGenerationOptions.md) Generation options #### Returns [`TimeSegment`](TimeSegment.md)[] Array of minute segments *** ### generatePeriod() > **generatePeriod**(`options`): [`TimePeriod`](TimePeriod.md) \| `null` Defined in: [Time/interfaces/time-generator.service.interfaces.ts:48](https://github.com/jmkcoder/uplink-protocol-calendar/blob/4cde26f472352440ee258db7670fce2e95651862/src/Time/interfaces/time-generator.service.interfaces.ts#L48) Generate period (AM/PM) for 12-hour format #### Parameters ##### options [`TimeGenerationOptions`](TimeGenerationOptions.md) Generation options #### Returns [`TimePeriod`](TimePeriod.md) \| `null` Period segment *** ### generateSecondSegments() > **generateSecondSegments**(`options`): [`TimeSegment`](TimeSegment.md)[] Defined in: [Time/interfaces/time-generator.service.interfaces.ts:34](https://github.com/jmkcoder/uplink-protocol-calendar/blob/4cde26f472352440ee258db7670fce2e95651862/src/Time/interfaces/time-generator.service.interfaces.ts#L34) Generate second segments #### Parameters ##### options [`TimeGenerationOptions`](TimeGenerationOptions.md) Generation options #### Returns [`TimeSegment`](TimeSegment.md)[] Array of second segments *** ### generateTimeView() > **generateTimeView**(`options`): [`TimeView`](TimeView.md) Defined in: [Time/interfaces/time-generator.service.interfaces.ts:13](https://github.com/jmkcoder/uplink-protocol-calendar/blob/4cde26f472352440ee258db7670fce2e95651862/src/Time/interfaces/time-generator.service.interfaces.ts#L13) Generate time view with all segments #### Parameters ##### options [`TimeGenerationOptions`](TimeGenerationOptions.md) Generation options #### Returns [`TimeView`](TimeView.md) Complete time view