-
Notifications
You must be signed in to change notification settings - Fork 0
/
DOCUMENTATION.txt
290 lines (153 loc) · 5.81 KB
/
DOCUMENTATION.txt
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
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
DOCUMENTATION
global/countries/actions
Functions
countriesError
▸ countriesError(error: string): CountriesErrorAction
The action dispatched when the countries are failed to be fetched from API
Parameters:
Name Type Description
------- ---------- -------------------------------------------
error string The error occured while fetching from API
RETURNS: CountriesErrorAction
Returns the CountriesErrorAction
Defined in: global/countries/actions.ts:32
------------------------------------------------------------------------
countriesLoaded
▸ countriesLoaded(countries: Country[]): CountriesLoadedAction
The action dispatched when the countries are fetched from API
Parameters:
Name Type Description
----------- ------------- ----------------------------------------
countries Country[] The list of countries fetched from API
RETURNS: CountriesLoadedAction
Returns the CountriesLoadedAction
Defined in: global/countries/actions.ts:16
global/countries/reducers
Functions
countriesReducer
▸ countriesReducer(state?: CountriesState, action: CountriesActionType): CountriesState
Parameters:
Name Type Description
-------- ----------------------- -------------------------------------------------
state CountriesState The initial state provided to countries reducer
action CountriesActionType The actions this reducer will react to
RETURNS: CountriesState
Returns the countries state
Defined in: global/countries/reducers.ts:23
hooks/useCountriesTable
Functions
default
▸ default(query: RouteQuery): CountriesTableValues
A custom React hook for building rows and columns for the Countries Table
Parameters:
Name Type Description
------- -------------- -----------------------------------------------------
query RouteQuery The route query with the URL for filtering the rows
RETURNS: CountriesTableValues
The values to be used in the Countries table
Defined in: hooks/useCountriesTable.ts:40
utils/deserializeState
Functions
default
▸ default(state: SerializedRootState): RootState
Deserializes a serialized redux state for client-side
Parameters:
Name Type Description
------- ----------------------- ----------------------------
state SerializedRootState The serialized redux state
RETURNS: RootState
Returns a deserialized redux state
Defined in: utils/deserializeState.ts:10
utils/fetchCountries
Functions
default
▸ default(): Promise<Country[]>
Fetches the countries list from API endpoint.
RETURNS: Promise<Country[]>
Returns an array of Country object in a promise
Defined in: utils/fetchCountries.ts:10
utils/getColumns
Functions
default
▸ default(): ColDef[]
Prepares the columns for the countries table
RETURNS: ColDef[]
Returns an array of column definitions
Defined in: utils/getColumns.tsx:10
utils/getRows
Functions
default
▸ default(countries: Country[], query: SearchQuery): ICountry[]
Prepares, and filters if search query provided, the rows for the countries table
Parameters:
Name Type Description
----------- --------------- --------------------------------
countries Country[] The list of countries
query SearchQuery The search query for filtering
RETURNS: ICountry[]
Returns the list of countries as rows
Defined in: utils/getRows.ts:12
utils/mergeSearchQuery
Functions
default
▸ default(input: string, query: ParsedUrlQuery): string
Merges the search input with the existing url query
Parameters:
Name Type Description
------- ------------------ ----------------------------------------------------------
input string the input value to be merged with the existing url query
query ParsedUrlQuery the existing url query
RETURNS: string
Returns the merged query as string
Defined in: utils/mergeSearchQuery.ts:11
utils/mergeSortingQuery
Functions
default
▸ default(sortingQuery: SortingQuery, query: ParsedUrlQuery): string
Merges the sorting query with the existing url query
Parameters:
----------------------------------------------------------------------------------------------
Name Type Description
-------------- ------------------ ------------------------------------------------------------
sortingQuery SortingQuery the sorting query to be merged with the existing url query
query ParsedUrlQuery the existing url query
----------------------------------------------------------------------------------------------
RETURNS: string
Returns the merged query as string
Defined in: utils/mergeSortingQuery.ts:12
utils/serializeState
Functions
default
▸ default(state: RootState: SerializedRootState)
Serializes the redux state for server-side
Parameters:
Name Type Description
------- ------------- -------------------------------
state RootState The un-serialized redux state
RETURNS: SerializedRootState
Returns a serialized redux state
Defined in: utils/serializeState.ts:9
utils/sortModelToSortQuery
Functions
default
▸ default(model: SortModel): SortingQuery
Converts a sort model into a sorting query
Parameters:
Name Type Description
------- ----------- --------------------------------
model SortModel The sort model to be converted
RETURNS: SortingQuery
Returns the converted sorting query
Defined in: utils/sortModelToSortQuery.ts:11
utils/sortQueryToSortModel
Functions
default
▸ default(query: SortingQuery): SortModel
Converts a sorting query into a sort model
Parameters:
Name Type Description
------- ---------------- -----------------------------------
query SortingQuery The sorting query to be converted
RETURNS: SortModel
Returns the converted sort model
Defined in: utils/sortQueryToSortModel.ts:11