Skip to content

Commit f038178

Browse files
committed
chore: add comments in order to not forget why do we even have min/max inside AdminForthResourceColumnCommon
1 parent 93d3b9d commit f038178

File tree

2 files changed

+27
-1
lines changed

2 files changed

+27
-1
lines changed

adminforth/types/Back.ts

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -183,9 +183,23 @@ export interface IAdminForthDataSourceConnector {
183183
* For string fields:
184184
* - {@link AdminForthResourceColumn.maxLength}
185185
* For numbers:
186+
* // min/max are used inside getMinMaxForColumns from base connector
186187
* - {@link AdminForthResourceColumn.min}
187188
* - {@link AdminForthResourceColumn.max}
188-
* - {@link AdminForthResourceColumn.minValue}, {@link AdminForthResourceColumn.maxValue}, {@link AdminForthResourceColumn.enum}, {@link AdminForthResourceColumn.foreignResource}, {@link AdminForthResourceColumn.sortable}, {@link AdminForthResourceColumn.backendOnly}, {@link AdminForthResourceColumn.masked}, {@link AdminForthResourceColumn.virtual}, {@link AdminForthResourceColumn.components}, {@link AdminForthResourceColumn.allowMinMaxQuery}, {@link AdminForthResourceColumn.editingNote}, {@link AdminForthResourceColumn.showIn}, {@link AdminForthResourceColumn.isUnique}, {@link AdminForthResourceColumn.validation})
189+
* - {@link AdminForthResourceColumn.minValue},
190+
* - {@link AdminForthResourceColumn.maxValue},
191+
* - {@link AdminForthResourceColumn.enum},
192+
* - {@link AdminForthResourceColumn.foreignResource},
193+
* - {@link AdminForthResourceColumn.sortable},
194+
* - {@link AdminForthResourceColumn.backendOnly},
195+
* - {@link AdminForthResourceColumn.masked},
196+
* - {@link AdminForthResourceColumn.virtual},
197+
* - {@link AdminForthResourceColumn.components},
198+
* - {@link AdminForthResourceColumn.allowMinMaxQuery},
199+
* - {@link AdminForthResourceColumn.editingNote},
200+
* - {@link AdminForthResourceColumn.showIn},
201+
* - {@link AdminForthResourceColumn.isUnique},
202+
* - {@link AdminForthResourceColumn.validation})
189203
* Also you can additionally save original column type to {@link AdminForthResourceColumn._underlineType}. This might be later used
190204
* in {@link IAdminForthDataSourceConnector.getFieldValue} and {@link IAdminForthDataSourceConnector.setFieldValue} methods.
191205
*

adminforth/types/Common.ts

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -964,6 +964,18 @@ export interface AdminForthResourceColumnCommon extends AdminForthResourceColumn
964964

965965
editingNote?: { create?: string, edit?: string },
966966

967+
/*
968+
______________________________________________
969+
| |
970+
| Min and max values are used |
971+
| in getMinMaxForColumns from base connector |
972+
|_____________________________________________|
973+
|
974+
|
975+
|
976+
|
977+
V
978+
*/
967979
/**
968980
* Minimal value stored in this field.
969981
*/

0 commit comments

Comments
 (0)