@openmrs/esm-framework 3.4.1-pre.98 → 4.0.1-pre.204
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.turbo/turbo-build.log +16 -138
- package/dist/openmrs-esm-framework.js +1 -1
- package/dist/openmrs-esm-framework.js.LICENSE.txt +9 -21
- package/dist/openmrs-esm-framework.js.map +1 -1
- package/docs/API.md +588 -756
- package/docs/classes/OpenmrsFetchError.md +4 -10
- package/docs/enums/Type.md +20 -20
- package/docs/enums/VisitMode.md +8 -8
- package/docs/enums/VisitStatus.md +6 -6
- package/docs/interfaces/AssignedExtension.md +7 -9
- package/docs/interfaces/BreadcrumbRegistration.md +2 -2
- package/docs/interfaces/BreadcrumbSettings.md +4 -22
- package/docs/interfaces/CancelLoading.md +1 -1
- package/docs/interfaces/ClearDynamicRoutesMessage.md +1 -1
- package/docs/interfaces/ComponentDefinition.md +7 -19
- package/docs/interfaces/Config.md +3 -17
- package/docs/interfaces/ConfigObject.md +14 -17
- package/docs/interfaces/ConfigSchema.md +3 -3
- package/docs/interfaces/ConfigurableLinkProps.md +12 -1
- package/docs/interfaces/ConnectedExtension.md +4 -6
- package/docs/interfaces/ConnectivityChangedEvent.md +1 -1
- package/docs/interfaces/CurrentPatientOptions.md +1 -1
- package/docs/interfaces/DisplayConditionsConfigObject.md +19 -0
- package/docs/interfaces/DynamicOfflineData.md +63 -0
- package/docs/interfaces/DynamicOfflineDataHandler.md +88 -0
- package/docs/interfaces/DynamicOfflineDataSyncState.md +63 -0
- package/docs/interfaces/ErrorStateProps.md +30 -0
- package/docs/interfaces/ExtensionData.md +3 -3
- package/docs/interfaces/ExtensionDefinition.md +13 -37
- package/docs/interfaces/ExtensionProps.md +2 -2
- package/docs/interfaces/ExtensionRegistration.md +18 -7
- package/docs/interfaces/ExtensionSlotBaseProps.md +15 -4
- package/docs/interfaces/ExtensionSlotConfig.md +4 -4
- package/docs/interfaces/ExtensionSlotConfigObject.md +3 -9
- package/docs/interfaces/ExtensionSlotState.md +2 -2
- package/docs/interfaces/ExtensionStore.md +1 -1
- package/docs/interfaces/FHIRCode.md +13 -2
- package/docs/interfaces/FHIRRequestObj.md +3 -3
- package/docs/interfaces/FHIRRequestOptions.md +41 -0
- package/docs/interfaces/FHIRResource.md +4 -1
- package/docs/interfaces/FetchResponse.md +1 -1
- package/docs/interfaces/FetchResponseJson.md +7 -0
- package/docs/interfaces/ImportMap.md +1 -1
- package/docs/interfaces/Lifecycle.md +4 -4
- package/docs/interfaces/Location.md +3 -3
- package/docs/interfaces/LoggedInUser.md +11 -11
- package/docs/interfaces/LoggedInUserFetchResponse.md +1 -1
- package/docs/interfaces/MessageServiceWorkerResult.md +3 -3
- package/docs/interfaces/NavigateOptions.md +12 -1
- package/docs/interfaces/NewVisitPayload.md +6 -6
- package/docs/interfaces/NotificationDescriptor.md +6 -6
- package/docs/interfaces/OfflineModeResult.md +3 -3
- package/docs/interfaces/OfflinePatientArgs.md +2 -6
- package/docs/interfaces/OfflinePatientDataSyncHandler.md +5 -14
- package/docs/interfaces/OfflinePatientDataSyncState.md +6 -24
- package/docs/interfaces/OfflinePatientDataSyncStore.md +2 -9
- package/docs/interfaces/OldExtensionSlotBaseProps.md +65 -0
- package/docs/interfaces/OmrsServiceWorkerMessage.md +1 -1
- package/docs/interfaces/OnImportMapChangedMessage.md +2 -2
- package/docs/interfaces/OnlyThePatient.md +1 -1
- package/docs/interfaces/OpenmrsResource.md +2 -2
- package/docs/interfaces/PageDefinition.md +9 -25
- package/docs/interfaces/PatientWithFullResponse.md +1 -1
- package/docs/interfaces/Person.md +3 -3
- package/docs/interfaces/Privilege.md +3 -3
- package/docs/interfaces/QueueItemDescriptor.md +4 -9
- package/docs/interfaces/RegisterDynamicRouteMessage.md +4 -4
- package/docs/interfaces/ResourceLoader.md +1 -1
- package/docs/interfaces/RetryOptions.md +7 -18
- package/docs/interfaces/Role.md +3 -3
- package/docs/interfaces/Session.md +7 -7
- package/docs/interfaces/SessionLocation.md +3 -3
- package/docs/interfaces/ShowNotificationEvent.md +5 -5
- package/docs/interfaces/ShowToastEvent.md +4 -4
- package/docs/interfaces/SpaConfig.md +5 -19
- package/docs/interfaces/SyncItem.md +7 -11
- package/docs/interfaces/SyncProcessOptions.md +5 -7
- package/docs/interfaces/ToastDescriptor.md +5 -5
- package/docs/interfaces/ToastNotificationMeta.md +6 -6
- package/docs/interfaces/UserHasAccessProps.md +24 -2
- package/docs/interfaces/Visit.md +9 -9
- package/docs/interfaces/VisitItem.md +4 -4
- package/docs/interfaces/VisitType.md +3 -3
- package/jest.config.js +8 -0
- package/mock.tsx +4 -7
- package/package.json +13 -13
- package/src/integration-tests/extension-config.test.tsx +218 -21
- package/typedoc.json +1 -1
package/docs/API.md
CHANGED
|
@@ -30,7 +30,7 @@
|
|
|
30
30
|
- [useSession](API.md#usesession)
|
|
31
31
|
- [useVisit](API.md#usevisit)
|
|
32
32
|
- [useVisitTypes](API.md#usevisittypes)
|
|
33
|
-
- [userHasAccess](API.md#userhasaccess)
|
|
33
|
+
- [userHasAccess](API.md#userhasaccess-1)
|
|
34
34
|
|
|
35
35
|
### Breadcrumb Functions
|
|
36
36
|
|
|
@@ -54,7 +54,7 @@
|
|
|
54
54
|
- [isUrl](API.md#isurl)
|
|
55
55
|
- [isUrlWithTemplateParameters](API.md#isurlwithtemplateparameters)
|
|
56
56
|
- [oneOf](API.md#oneof)
|
|
57
|
-
- [validator](API.md#validator)
|
|
57
|
+
- [validator](API.md#validator-1)
|
|
58
58
|
|
|
59
59
|
### Date and Time Functions
|
|
60
60
|
|
|
@@ -102,6 +102,7 @@
|
|
|
102
102
|
|
|
103
103
|
### Navigation Functions
|
|
104
104
|
|
|
105
|
+
- [ConfigurableLink](API.md#configurablelink)
|
|
105
106
|
- [interpolateString](API.md#interpolatestring)
|
|
106
107
|
- [interpolateUrl](API.md#interpolateurl)
|
|
107
108
|
- [navigate](API.md#navigate)
|
|
@@ -113,23 +114,36 @@
|
|
|
113
114
|
- [deleteSynchronizationItem](API.md#deletesynchronizationitem)
|
|
114
115
|
- [generateOfflineUuid](API.md#generateofflineuuid)
|
|
115
116
|
- [getCurrentOfflineMode](API.md#getcurrentofflinemode)
|
|
117
|
+
- [getDynamicOfflineDataEntries](API.md#getdynamicofflinedataentries)
|
|
118
|
+
- [getDynamicOfflineDataEntriesFor](API.md#getdynamicofflinedataentriesfor)
|
|
119
|
+
- [getDynamicOfflineDataHandlers](API.md#getdynamicofflinedatahandlers)
|
|
116
120
|
- [getFullSynchronizationItems](API.md#getfullsynchronizationitems)
|
|
117
121
|
- [getFullSynchronizationItemsFor](API.md#getfullsynchronizationitemsfor)
|
|
118
122
|
- [getOfflinePatientDataStore](API.md#getofflinepatientdatastore)
|
|
119
123
|
- [getSynchronizationItem](API.md#getsynchronizationitem)
|
|
120
124
|
- [getSynchronizationItems](API.md#getsynchronizationitems)
|
|
121
125
|
- [isOfflineUuid](API.md#isofflineuuid)
|
|
122
|
-
- [loadPersistedPatientDataSyncState](API.md#loadpersistedpatientdatasyncstate)
|
|
123
126
|
- [messageOmrsServiceWorker](API.md#messageomrsserviceworker)
|
|
127
|
+
- [putDynamicOfflineData](API.md#putdynamicofflinedata)
|
|
128
|
+
- [putDynamicOfflineDataFor](API.md#putdynamicofflinedatafor)
|
|
124
129
|
- [queueSynchronizationItem](API.md#queuesynchronizationitem)
|
|
125
130
|
- [registerOfflinePatientHandler](API.md#registerofflinepatienthandler)
|
|
131
|
+
- [removeDynamicOfflineData](API.md#removedynamicofflinedata)
|
|
132
|
+
- [removeDynamicOfflineDataFor](API.md#removedynamicofflinedatafor)
|
|
133
|
+
- [setupDynamicOfflineDataHandler](API.md#setupdynamicofflinedatahandler)
|
|
126
134
|
- [setupOfflineSync](API.md#setupofflinesync)
|
|
127
135
|
- [subscribeConnectivity](API.md#subscribeconnectivity)
|
|
128
136
|
- [subscribeConnectivityChanged](API.md#subscribeconnectivitychanged)
|
|
129
137
|
- [subscribePrecacheStaticDependencies](API.md#subscribeprecachestaticdependencies)
|
|
138
|
+
- [syncAllDynamicOfflineData](API.md#syncalldynamicofflinedata)
|
|
139
|
+
- [syncDynamicOfflineData](API.md#syncdynamicofflinedata)
|
|
130
140
|
- [syncOfflinePatientData](API.md#syncofflinepatientdata)
|
|
131
141
|
- [useConnectivity](API.md#useconnectivity)
|
|
132
142
|
|
|
143
|
+
### Other Functions
|
|
144
|
+
|
|
145
|
+
- [ExtensionSlot](API.md#extensionslot)
|
|
146
|
+
|
|
133
147
|
### Store Functions
|
|
134
148
|
|
|
135
149
|
- [createGlobalStore](API.md#createglobalstore)
|
|
@@ -142,6 +156,7 @@
|
|
|
142
156
|
|
|
143
157
|
### UI Functions
|
|
144
158
|
|
|
159
|
+
- [isDesktop](API.md#isdesktop)
|
|
145
160
|
- [setLeftNav](API.md#setleftnav)
|
|
146
161
|
- [showModal](API.md#showmodal)
|
|
147
162
|
- [showNotification](API.md#shownotification)
|
|
@@ -163,7 +178,7 @@
|
|
|
163
178
|
- [retry](API.md#retry)
|
|
164
179
|
- [translateFrom](API.md#translatefrom)
|
|
165
180
|
|
|
166
|
-
## API Type
|
|
181
|
+
## API Type Aliases
|
|
167
182
|
|
|
168
183
|
### CurrentPatient
|
|
169
184
|
|
|
@@ -171,7 +186,7 @@
|
|
|
171
186
|
|
|
172
187
|
#### Defined in
|
|
173
188
|
|
|
174
|
-
[packages/framework/esm-api/src/shared-api-objects/current-patient.ts:5](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
189
|
+
[packages/framework/esm-api/src/shared-api-objects/current-patient.ts:5](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/shared-api-objects/current-patient.ts#L5)
|
|
175
190
|
|
|
176
191
|
___
|
|
177
192
|
|
|
@@ -188,7 +203,7 @@ ___
|
|
|
188
203
|
|
|
189
204
|
#### Defined in
|
|
190
205
|
|
|
191
|
-
[packages/framework/esm-api/src/shared-api-objects/current-user.ts:
|
|
206
|
+
[packages/framework/esm-api/src/shared-api-objects/current-user.ts:17](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/shared-api-objects/current-user.ts#L17)
|
|
192
207
|
|
|
193
208
|
___
|
|
194
209
|
|
|
@@ -198,7 +213,7 @@ ___
|
|
|
198
213
|
|
|
199
214
|
#### Defined in
|
|
200
215
|
|
|
201
|
-
[packages/framework/esm-react-utils/src/usePatient.ts:5](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
216
|
+
[packages/framework/esm-react-utils/src/usePatient.ts:5](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/usePatient.ts#L5)
|
|
202
217
|
|
|
203
218
|
___
|
|
204
219
|
|
|
@@ -208,7 +223,7 @@ ___
|
|
|
208
223
|
|
|
209
224
|
#### Defined in
|
|
210
225
|
|
|
211
|
-
[packages/framework/esm-api/src/shared-api-objects/current-patient.ts:19](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
226
|
+
[packages/framework/esm-api/src/shared-api-objects/current-patient.ts:19](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/shared-api-objects/current-patient.ts#L19)
|
|
212
227
|
|
|
213
228
|
___
|
|
214
229
|
|
|
@@ -218,7 +233,7 @@ ___
|
|
|
218
233
|
|
|
219
234
|
#### Defined in
|
|
220
235
|
|
|
221
|
-
[packages/framework/esm-api/src/shared-api-objects/current-user.ts:
|
|
236
|
+
[packages/framework/esm-api/src/shared-api-objects/current-user.ts:15](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/shared-api-objects/current-user.ts#L15)
|
|
222
237
|
|
|
223
238
|
___
|
|
224
239
|
|
|
@@ -235,11 +250,11 @@ ___
|
|
|
235
250
|
|
|
236
251
|
#### Defined in
|
|
237
252
|
|
|
238
|
-
[packages/framework/esm-api/src/shared-api-objects/current-user.ts:
|
|
253
|
+
[packages/framework/esm-api/src/shared-api-objects/current-user.ts:22](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/shared-api-objects/current-user.ts#L22)
|
|
239
254
|
|
|
240
255
|
___
|
|
241
256
|
|
|
242
|
-
## Date and Time Type
|
|
257
|
+
## Date and Time Type Aliases
|
|
243
258
|
|
|
244
259
|
### DateInput
|
|
245
260
|
|
|
@@ -247,7 +262,7 @@ ___
|
|
|
247
262
|
|
|
248
263
|
#### Defined in
|
|
249
264
|
|
|
250
|
-
[packages/framework/esm-utils/src/omrs-dates.ts:19](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
265
|
+
[packages/framework/esm-utils/src/omrs-dates.ts:19](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/omrs-dates.ts#L19)
|
|
251
266
|
|
|
252
267
|
___
|
|
253
268
|
|
|
@@ -257,7 +272,7 @@ ___
|
|
|
257
272
|
|
|
258
273
|
#### Defined in
|
|
259
274
|
|
|
260
|
-
[packages/framework/esm-utils/src/omrs-dates.ts:140](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
275
|
+
[packages/framework/esm-utils/src/omrs-dates.ts:140](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/omrs-dates.ts#L140)
|
|
261
276
|
|
|
262
277
|
___
|
|
263
278
|
|
|
@@ -269,18 +284,34 @@ ___
|
|
|
269
284
|
|
|
270
285
|
| Name | Type | Description |
|
|
271
286
|
| :------ | :------ | :------ |
|
|
272
|
-
| `day` | `boolean` |
|
|
273
|
-
| `mode` | [`FormatDateMode`](API.md#formatdatemode) |
|
|
274
|
-
| `time` | `boolean` \| ``"for today"`` |
|
|
275
|
-
| `year` | `boolean` |
|
|
287
|
+
| `day` | `boolean` | |
|
|
288
|
+
| `mode` | [`FormatDateMode`](API.md#formatdatemode) | |
|
|
289
|
+
| `time` | `boolean` \| ``"for today"`` | |
|
|
290
|
+
| `year` | `boolean` | |
|
|
276
291
|
|
|
277
292
|
#### Defined in
|
|
278
293
|
|
|
279
|
-
[packages/framework/esm-utils/src/omrs-dates.ts:142](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
294
|
+
[packages/framework/esm-utils/src/omrs-dates.ts:142](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/omrs-dates.ts#L142)
|
|
280
295
|
|
|
281
296
|
___
|
|
282
297
|
|
|
283
|
-
##
|
|
298
|
+
## Navigation Type Aliases
|
|
299
|
+
|
|
300
|
+
### TemplateParams
|
|
301
|
+
|
|
302
|
+
Ƭ **TemplateParams**: `Object`
|
|
303
|
+
|
|
304
|
+
#### Index signature
|
|
305
|
+
|
|
306
|
+
▪ [key: `string`]: `string`
|
|
307
|
+
|
|
308
|
+
#### Defined in
|
|
309
|
+
|
|
310
|
+
[packages/framework/esm-config/src/navigation/navigate.ts:10](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/navigation/navigate.ts#L10)
|
|
311
|
+
|
|
312
|
+
___
|
|
313
|
+
|
|
314
|
+
## Offline Type Aliases
|
|
284
315
|
|
|
285
316
|
### KnownOmrsServiceWorkerMessages
|
|
286
317
|
|
|
@@ -288,7 +319,7 @@ ___
|
|
|
288
319
|
|
|
289
320
|
#### Defined in
|
|
290
321
|
|
|
291
|
-
[packages/framework/esm-offline/src/service-worker-messaging.ts:46](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
322
|
+
[packages/framework/esm-offline/src/service-worker-messaging.ts:46](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/service-worker-messaging.ts#L46)
|
|
292
323
|
|
|
293
324
|
___
|
|
294
325
|
|
|
@@ -298,7 +329,7 @@ ___
|
|
|
298
329
|
|
|
299
330
|
#### Defined in
|
|
300
331
|
|
|
301
|
-
[packages/framework/esm-offline/src/mode.ts:38](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
332
|
+
[packages/framework/esm-offline/src/mode.ts:38](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/mode.ts#L38)
|
|
302
333
|
|
|
303
334
|
___
|
|
304
335
|
|
|
@@ -306,14 +337,9 @@ ___
|
|
|
306
337
|
|
|
307
338
|
Ƭ **OmrsOfflineCachingStrategy**: ``"network-only-or-cache-only"`` \| ``"network-first"``
|
|
308
339
|
|
|
309
|
-
* `cache-or-network`: The default strategy, equal to the absence of this header.
|
|
310
|
-
The SW attempts to resolve the request via the network, but falls back to the cache if required.
|
|
311
|
-
The service worker decides the strategy to be used.
|
|
312
|
-
* `network-first`: See https://developers.google.com/web/tools/workbox/modules/workbox-strategies#network_first_network_falling_back_to_cache.
|
|
313
|
-
|
|
314
340
|
#### Defined in
|
|
315
341
|
|
|
316
|
-
[packages/framework/esm-offline/src/service-worker-http-headers.ts:18](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
342
|
+
[packages/framework/esm-offline/src/service-worker-http-headers.ts:18](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/service-worker-http-headers.ts#L18)
|
|
317
343
|
|
|
318
344
|
___
|
|
319
345
|
|
|
@@ -323,7 +349,7 @@ ___
|
|
|
323
349
|
|
|
324
350
|
#### Defined in
|
|
325
351
|
|
|
326
|
-
[packages/framework/esm-offline/src/service-worker-http-headers.ts:45](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
352
|
+
[packages/framework/esm-offline/src/service-worker-http-headers.ts:45](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/service-worker-http-headers.ts#L45)
|
|
327
353
|
|
|
328
354
|
___
|
|
329
355
|
|
|
@@ -331,24 +357,21 @@ ___
|
|
|
331
357
|
|
|
332
358
|
Ƭ **OmrsOfflineHttpHeaders**: `Object`
|
|
333
359
|
|
|
334
|
-
Defines the keys of the custom headers which can be appended to an HTTP request.
|
|
335
|
-
HTTP requests with these headers are handled in a special way by the SPA's service worker.
|
|
336
|
-
|
|
337
360
|
#### Type declaration
|
|
338
361
|
|
|
339
362
|
| Name | Type | Description |
|
|
340
363
|
| :------ | :------ | :------ |
|
|
341
|
-
| `x-omrs-offline-caching-strategy?` | [`OmrsOfflineCachingStrategy`](API.md#omrsofflinecachingstrategy) |
|
|
342
|
-
| `x-omrs-offline-response-body?` | `string` |
|
|
343
|
-
| `x-omrs-offline-response-status?` | \`${number}\` |
|
|
364
|
+
| `x-omrs-offline-caching-strategy?` | [`OmrsOfflineCachingStrategy`](API.md#omrsofflinecachingstrategy) | |
|
|
365
|
+
| `x-omrs-offline-response-body?` | `string` | |
|
|
366
|
+
| `x-omrs-offline-response-status?` | \`${number}\` | |
|
|
344
367
|
|
|
345
368
|
#### Defined in
|
|
346
369
|
|
|
347
|
-
[packages/framework/esm-offline/src/service-worker-http-headers.ts:26](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
370
|
+
[packages/framework/esm-offline/src/service-worker-http-headers.ts:26](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/service-worker-http-headers.ts#L26)
|
|
348
371
|
|
|
349
372
|
___
|
|
350
373
|
|
|
351
|
-
## Other Type
|
|
374
|
+
## Other Type Aliases
|
|
352
375
|
|
|
353
376
|
### ConfigValue
|
|
354
377
|
|
|
@@ -356,17 +379,17 @@ ___
|
|
|
356
379
|
|
|
357
380
|
#### Defined in
|
|
358
381
|
|
|
359
|
-
[packages/framework/esm-config/src/types.ts:
|
|
382
|
+
[packages/framework/esm-config/src/types.ts:37](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L37)
|
|
360
383
|
|
|
361
384
|
___
|
|
362
385
|
|
|
363
386
|
### ExtensionSlotProps
|
|
364
387
|
|
|
365
|
-
Ƭ **ExtensionSlotProps**: [`ExtensionSlotBaseProps`](interfaces/ExtensionSlotBaseProps.md) & `React.HTMLAttributes`<`HTMLDivElement
|
|
388
|
+
Ƭ **ExtensionSlotProps**: [`OldExtensionSlotBaseProps`](interfaces/OldExtensionSlotBaseProps.md) \| [`ExtensionSlotBaseProps`](interfaces/ExtensionSlotBaseProps.md) & `Omit`<`React.HTMLAttributes`<`HTMLDivElement`\>, ``"children"``\> & { `children?`: `React.ReactNode` \| (`extension`: [`ConnectedExtension`](interfaces/ConnectedExtension.md)) => `React.ReactNode` }
|
|
366
389
|
|
|
367
390
|
#### Defined in
|
|
368
391
|
|
|
369
|
-
[packages/framework/esm-react-utils/src/ExtensionSlot.tsx:
|
|
392
|
+
[packages/framework/esm-react-utils/src/ExtensionSlot.tsx:23](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/ExtensionSlot.tsx#L23)
|
|
370
393
|
|
|
371
394
|
___
|
|
372
395
|
|
|
@@ -383,7 +406,7 @@ ___
|
|
|
383
406
|
|
|
384
407
|
#### Defined in
|
|
385
408
|
|
|
386
|
-
[packages/framework/esm-config/src/types.ts:
|
|
409
|
+
[packages/framework/esm-config/src/types.ts:65](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L65)
|
|
387
410
|
|
|
388
411
|
___
|
|
389
412
|
|
|
@@ -393,7 +416,7 @@ ___
|
|
|
393
416
|
|
|
394
417
|
#### Defined in
|
|
395
418
|
|
|
396
|
-
[packages/framework/esm-globals/src/types.ts:53](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
419
|
+
[packages/framework/esm-globals/src/types.ts:53](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L53)
|
|
397
420
|
|
|
398
421
|
___
|
|
399
422
|
|
|
@@ -403,7 +426,7 @@ ___
|
|
|
403
426
|
|
|
404
427
|
#### Defined in
|
|
405
428
|
|
|
406
|
-
[packages/framework/esm-api/src/types/visit-resource.ts:12](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
429
|
+
[packages/framework/esm-api/src/types/visit-resource.ts:12](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/visit-resource.ts#L12)
|
|
407
430
|
|
|
408
431
|
___
|
|
409
432
|
|
|
@@ -427,7 +450,7 @@ ___
|
|
|
427
450
|
|
|
428
451
|
#### Defined in
|
|
429
452
|
|
|
430
|
-
[packages/framework/esm-config/src/types.ts:
|
|
453
|
+
[packages/framework/esm-config/src/types.ts:72](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L72)
|
|
431
454
|
|
|
432
455
|
___
|
|
433
456
|
|
|
@@ -451,11 +474,11 @@ ___
|
|
|
451
474
|
|
|
452
475
|
#### Defined in
|
|
453
476
|
|
|
454
|
-
[packages/framework/esm-config/src/types.ts:
|
|
477
|
+
[packages/framework/esm-config/src/types.ts:70](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L70)
|
|
455
478
|
|
|
456
479
|
___
|
|
457
480
|
|
|
458
|
-
## Store Type
|
|
481
|
+
## Store Type Aliases
|
|
459
482
|
|
|
460
483
|
### Actions
|
|
461
484
|
|
|
@@ -463,7 +486,7 @@ ___
|
|
|
463
486
|
|
|
464
487
|
#### Defined in
|
|
465
488
|
|
|
466
|
-
[packages/framework/esm-react-utils/src/createUseStore.ts:5](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
489
|
+
[packages/framework/esm-react-utils/src/createUseStore.ts:5](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/createUseStore.ts#L5)
|
|
467
490
|
|
|
468
491
|
___
|
|
469
492
|
|
|
@@ -477,11 +500,11 @@ ___
|
|
|
477
500
|
|
|
478
501
|
#### Defined in
|
|
479
502
|
|
|
480
|
-
[packages/framework/esm-react-utils/src/createUseStore.ts:6](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
503
|
+
[packages/framework/esm-react-utils/src/createUseStore.ts:6](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/createUseStore.ts#L6)
|
|
481
504
|
|
|
482
505
|
___
|
|
483
506
|
|
|
484
|
-
## UI Type
|
|
507
|
+
## UI Type Aliases
|
|
485
508
|
|
|
486
509
|
### InlineNotificationType
|
|
487
510
|
|
|
@@ -489,17 +512,17 @@ ___
|
|
|
489
512
|
|
|
490
513
|
#### Defined in
|
|
491
514
|
|
|
492
|
-
[packages/framework/esm-styleguide/src/notifications/notification.component.tsx:22](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
515
|
+
[packages/framework/esm-styleguide/src/notifications/notification.component.tsx:22](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/notifications/notification.component.tsx#L22)
|
|
493
516
|
|
|
494
517
|
___
|
|
495
518
|
|
|
496
519
|
### LayoutType
|
|
497
520
|
|
|
498
|
-
Ƭ **LayoutType**: ``"tablet"`` \| ``"
|
|
521
|
+
Ƭ **LayoutType**: ``"phone"`` \| ``"tablet"`` \| ``"small-desktop"`` \| ``"large-desktop"``
|
|
499
522
|
|
|
500
523
|
#### Defined in
|
|
501
524
|
|
|
502
|
-
[packages/framework/esm-react-utils/src/useLayoutType.ts:4](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
525
|
+
[packages/framework/esm-react-utils/src/useLayoutType.ts:4](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useLayoutType.ts#L4)
|
|
503
526
|
|
|
504
527
|
___
|
|
505
528
|
|
|
@@ -509,72 +532,73 @@ ___
|
|
|
509
532
|
|
|
510
533
|
#### Defined in
|
|
511
534
|
|
|
512
|
-
[packages/framework/esm-styleguide/src/toasts/toast.component.tsx:26](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
535
|
+
[packages/framework/esm-styleguide/src/toasts/toast.component.tsx:26](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/toasts/toast.component.tsx#L26)
|
|
513
536
|
|
|
514
537
|
## API Variables
|
|
515
538
|
|
|
516
539
|
### UserHasAccess
|
|
517
540
|
|
|
518
|
-
• **UserHasAccess**: `React.FC`<[`UserHasAccessProps`](interfaces/UserHasAccessProps.md)\>
|
|
541
|
+
• `Const` **UserHasAccess**: `React.FC`<[`UserHasAccessProps`](interfaces/UserHasAccessProps.md)\>
|
|
519
542
|
|
|
520
543
|
#### Defined in
|
|
521
544
|
|
|
522
|
-
[packages/framework/esm-react-utils/src/UserHasAccess.tsx:
|
|
545
|
+
[packages/framework/esm-react-utils/src/UserHasAccess.tsx:11](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/UserHasAccess.tsx#L11)
|
|
523
546
|
|
|
524
547
|
___
|
|
525
548
|
|
|
526
549
|
### defaultVisitCustomRepresentation
|
|
527
550
|
|
|
528
|
-
• **defaultVisitCustomRepresentation**: `string`
|
|
551
|
+
• `Const` **defaultVisitCustomRepresentation**: `string`
|
|
529
552
|
|
|
530
553
|
#### Defined in
|
|
531
554
|
|
|
532
|
-
[packages/framework/esm-api/src/shared-api-objects/visit-utils.ts:12](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
555
|
+
[packages/framework/esm-api/src/shared-api-objects/visit-utils.ts:12](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/shared-api-objects/visit-utils.ts#L12)
|
|
533
556
|
|
|
534
557
|
___
|
|
535
558
|
|
|
536
559
|
### fhir
|
|
537
560
|
|
|
538
|
-
• **fhir**: `
|
|
561
|
+
• `Const` **fhir**: `Object`
|
|
539
562
|
|
|
540
|
-
|
|
541
|
-
|
|
542
|
-
|
|
543
|
-
|
|
563
|
+
#### Type declaration
|
|
564
|
+
|
|
565
|
+
| Name | Type |
|
|
566
|
+
| :------ | :------ |
|
|
567
|
+
| `read` | <T\>(`options`: [`FHIRRequestOptions`](interfaces/FHIRRequestOptions.md)) => `Promise`<{ `config`: [`FHIRRequestObj`](interfaces/FHIRRequestObj.md) ; `data`: `T` ; `headers`: `Headers` ; `status`: `number` }\> |
|
|
544
568
|
|
|
545
569
|
#### Defined in
|
|
546
570
|
|
|
547
|
-
[packages/framework/esm-api/src/fhir.ts:
|
|
571
|
+
[packages/framework/esm-api/src/fhir.ts:45](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/fhir.ts#L45)
|
|
548
572
|
|
|
549
573
|
___
|
|
550
574
|
|
|
551
575
|
### fhirBaseUrl
|
|
552
576
|
|
|
553
|
-
• **fhirBaseUrl**: ``"/ws/fhir2/R4"``
|
|
577
|
+
• `Const` **fhirBaseUrl**: ``"/ws/fhir2/R4"``
|
|
554
578
|
|
|
555
579
|
#### Defined in
|
|
556
580
|
|
|
557
|
-
[packages/framework/esm-api/src/fhir.ts:5](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
581
|
+
[packages/framework/esm-api/src/fhir.ts:5](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/fhir.ts#L5)
|
|
558
582
|
|
|
559
583
|
___
|
|
560
584
|
|
|
561
585
|
### getStartedVisit
|
|
562
586
|
|
|
563
|
-
• **getStartedVisit**: `BehaviorSubject`<``null`` \| [`VisitItem`](interfaces/VisitItem.md)\>
|
|
587
|
+
• `Const` **getStartedVisit**: `BehaviorSubject`<``null`` \| [`VisitItem`](interfaces/VisitItem.md)\>
|
|
564
588
|
|
|
565
589
|
#### Defined in
|
|
566
590
|
|
|
567
|
-
[packages/framework/esm-api/src/shared-api-objects/visit-utils.ts:74](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
591
|
+
[packages/framework/esm-api/src/shared-api-objects/visit-utils.ts:74](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/shared-api-objects/visit-utils.ts#L74)
|
|
568
592
|
|
|
569
593
|
___
|
|
570
594
|
|
|
571
595
|
### sessionEndpoint
|
|
572
596
|
|
|
573
|
-
• **sessionEndpoint**: ``"/ws/rest/v1/session"``
|
|
597
|
+
• `Const` **sessionEndpoint**: ``"/ws/rest/v1/session"``
|
|
574
598
|
|
|
575
599
|
#### Defined in
|
|
576
600
|
|
|
577
|
-
[packages/framework/esm-api/src/openmrs-fetch.ts:
|
|
601
|
+
[packages/framework/esm-api/src/openmrs-fetch.ts:7](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/openmrs-fetch.ts#L7)
|
|
578
602
|
|
|
579
603
|
___
|
|
580
604
|
|
|
@@ -582,7 +606,7 @@ ___
|
|
|
582
606
|
|
|
583
607
|
### validators
|
|
584
608
|
|
|
585
|
-
• **validators**: `Object`
|
|
609
|
+
• `Const` **validators**: `Object`
|
|
586
610
|
|
|
587
611
|
#### Type declaration
|
|
588
612
|
|
|
@@ -595,27 +619,7 @@ ___
|
|
|
595
619
|
|
|
596
620
|
#### Defined in
|
|
597
621
|
|
|
598
|
-
[packages/framework/esm-config/src/validators/validators.ts:69](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
599
|
-
|
|
600
|
-
___
|
|
601
|
-
|
|
602
|
-
## Navigation Variables
|
|
603
|
-
|
|
604
|
-
### ConfigurableLink
|
|
605
|
-
|
|
606
|
-
• **ConfigurableLink**: `React.FC`<[`ConfigurableLinkProps`](interfaces/ConfigurableLinkProps.md)\>
|
|
607
|
-
|
|
608
|
-
A React link component which calls [navigate](API.md#navigate) when clicked
|
|
609
|
-
|
|
610
|
-
**`param`** The target path or URL. Supports interpolation. See [navigate](API.md#navigate)
|
|
611
|
-
|
|
612
|
-
**`param`** Inline elements within the link
|
|
613
|
-
|
|
614
|
-
**`param`** Any other valid props for an <a> tag except `href` and `onClick`
|
|
615
|
-
|
|
616
|
-
#### Defined in
|
|
617
|
-
|
|
618
|
-
[packages/framework/esm-react-utils/src/ConfigurableLink.tsx:32](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/ConfigurableLink.tsx#L32)
|
|
622
|
+
[packages/framework/esm-config/src/validators/validators.ts:69](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/validators/validators.ts#L69)
|
|
619
623
|
|
|
620
624
|
___
|
|
621
625
|
|
|
@@ -623,77 +627,69 @@ ___
|
|
|
623
627
|
|
|
624
628
|
### offlineUuidPrefix
|
|
625
629
|
|
|
626
|
-
• **offlineUuidPrefix**: ``"OFFLINE+"``
|
|
630
|
+
• `Const` **offlineUuidPrefix**: ``"OFFLINE+"``
|
|
627
631
|
|
|
628
632
|
#### Defined in
|
|
629
633
|
|
|
630
|
-
[packages/framework/esm-offline/src/uuid.ts:4](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
634
|
+
[packages/framework/esm-offline/src/uuid.ts:4](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/uuid.ts#L4)
|
|
631
635
|
|
|
632
636
|
___
|
|
633
637
|
|
|
634
638
|
### omrsOfflineCachingStrategyHttpHeaderName
|
|
635
639
|
|
|
636
|
-
• **omrsOfflineCachingStrategyHttpHeaderName**: ``"x-omrs-offline-caching-strategy"``
|
|
640
|
+
• `Const` **omrsOfflineCachingStrategyHttpHeaderName**: ``"x-omrs-offline-caching-strategy"``
|
|
637
641
|
|
|
638
642
|
#### Defined in
|
|
639
643
|
|
|
640
|
-
[packages/framework/esm-offline/src/service-worker-http-headers.ts:7](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
644
|
+
[packages/framework/esm-offline/src/service-worker-http-headers.ts:7](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/service-worker-http-headers.ts#L7)
|
|
641
645
|
|
|
642
646
|
___
|
|
643
647
|
|
|
644
648
|
### omrsOfflineResponseBodyHttpHeaderName
|
|
645
649
|
|
|
646
|
-
• **omrsOfflineResponseBodyHttpHeaderName**: ``"x-omrs-offline-response-body"``
|
|
650
|
+
• `Const` **omrsOfflineResponseBodyHttpHeaderName**: ``"x-omrs-offline-response-body"``
|
|
647
651
|
|
|
648
652
|
#### Defined in
|
|
649
653
|
|
|
650
|
-
[packages/framework/esm-offline/src/service-worker-http-headers.ts:3](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
654
|
+
[packages/framework/esm-offline/src/service-worker-http-headers.ts:3](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/service-worker-http-headers.ts#L3)
|
|
651
655
|
|
|
652
656
|
___
|
|
653
657
|
|
|
654
658
|
### omrsOfflineResponseStatusHttpHeaderName
|
|
655
659
|
|
|
656
|
-
• **omrsOfflineResponseStatusHttpHeaderName**: ``"x-omrs-offline-response-status"``
|
|
660
|
+
• `Const` **omrsOfflineResponseStatusHttpHeaderName**: ``"x-omrs-offline-response-status"``
|
|
657
661
|
|
|
658
662
|
#### Defined in
|
|
659
663
|
|
|
660
|
-
[packages/framework/esm-offline/src/service-worker-http-headers.ts:5](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
664
|
+
[packages/framework/esm-offline/src/service-worker-http-headers.ts:5](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/service-worker-http-headers.ts#L5)
|
|
661
665
|
|
|
662
666
|
___
|
|
663
667
|
|
|
664
668
|
## Other Variables
|
|
665
669
|
|
|
666
|
-
###
|
|
667
|
-
|
|
668
|
-
• **Extension**: `React.FC`<[`ExtensionProps`](interfaces/ExtensionProps.md)\>
|
|
669
|
-
|
|
670
|
-
Represents the position in the DOM where each extension within
|
|
671
|
-
an extension slot is rendered.
|
|
670
|
+
### ErrorState
|
|
672
671
|
|
|
673
|
-
|
|
674
|
-
|
|
675
|
-
Usage of this component *must* have an ancestor `<ExtensionSlot>`,
|
|
676
|
-
and *must* only be used once within that `<ExtensionSlot>`.
|
|
672
|
+
• `Const` **ErrorState**: `React.FC`<[`ErrorStateProps`](interfaces/ErrorStateProps.md)\>
|
|
677
673
|
|
|
678
674
|
#### Defined in
|
|
679
675
|
|
|
680
|
-
[packages/framework/esm-
|
|
676
|
+
[packages/framework/esm-styleguide/src/error-state/error-state.component.tsx:12](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/error-state/error-state.component.tsx#L12)
|
|
681
677
|
|
|
682
678
|
___
|
|
683
679
|
|
|
684
|
-
###
|
|
680
|
+
### Extension
|
|
685
681
|
|
|
686
|
-
• **
|
|
682
|
+
• `Const` **Extension**: `React.FC`<[`ExtensionProps`](interfaces/ExtensionProps.md)\>
|
|
687
683
|
|
|
688
684
|
#### Defined in
|
|
689
685
|
|
|
690
|
-
[packages/framework/esm-react-utils/src/
|
|
686
|
+
[packages/framework/esm-react-utils/src/Extension.tsx:31](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/Extension.tsx#L31)
|
|
691
687
|
|
|
692
688
|
___
|
|
693
689
|
|
|
694
690
|
### backendDependencies
|
|
695
691
|
|
|
696
|
-
• **backendDependencies**: `Object`
|
|
692
|
+
• `Const` **backendDependencies**: `Object`
|
|
697
693
|
|
|
698
694
|
#### Type declaration
|
|
699
695
|
|
|
@@ -704,7 +700,7 @@ ___
|
|
|
704
700
|
|
|
705
701
|
#### Defined in
|
|
706
702
|
|
|
707
|
-
[packages/framework/esm-api/src/openmrs-backend-dependencies.ts:1](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
703
|
+
[packages/framework/esm-api/src/openmrs-backend-dependencies.ts:1](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/openmrs-backend-dependencies.ts#L1)
|
|
708
704
|
|
|
709
705
|
___
|
|
710
706
|
|
|
@@ -712,11 +708,11 @@ ___
|
|
|
712
708
|
|
|
713
709
|
### LeftNavMenu
|
|
714
710
|
|
|
715
|
-
• **LeftNavMenu**: `ForwardRefExoticComponent`<`SideNavProps` & `RefAttributes`<`HTMLElement`\>\>
|
|
711
|
+
• `Const` **LeftNavMenu**: `ForwardRefExoticComponent`<`Pick`<`SideNavProps`, `string` \| `number` \| `symbol`\> & `RefAttributes`<`HTMLElement`\>\>
|
|
716
712
|
|
|
717
713
|
#### Defined in
|
|
718
714
|
|
|
719
|
-
[packages/framework/esm-styleguide/src/left-nav/index.tsx:30](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
715
|
+
[packages/framework/esm-styleguide/src/left-nav/index.tsx:30](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/left-nav/index.tsx#L30)
|
|
720
716
|
|
|
721
717
|
## API Functions
|
|
722
718
|
|
|
@@ -730,28 +726,28 @@ ___
|
|
|
730
726
|
|
|
731
727
|
#### Defined in
|
|
732
728
|
|
|
733
|
-
[packages/framework/esm-api/src/shared-api-objects/current-user.ts:
|
|
729
|
+
[packages/framework/esm-api/src/shared-api-objects/current-user.ts:188](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/shared-api-objects/current-user.ts#L188)
|
|
734
730
|
|
|
735
731
|
___
|
|
736
732
|
|
|
737
733
|
### fetchCurrentPatient
|
|
738
734
|
|
|
739
|
-
▸ **fetchCurrentPatient**(`patientUuid`, `contentOverrides?`): `Promise`<{ `data`: `Patient` }\> \| `Promise`<``null``\>
|
|
735
|
+
▸ **fetchCurrentPatient**(`patientUuid`, `contentOverrides?`): `Promise`<{ `config`: [`FHIRRequestObj`](interfaces/FHIRRequestObj.md) ; `data`: `Patient` ; `headers`: `Headers` ; `status`: `number` }\> \| `Promise`<``null``\>
|
|
740
736
|
|
|
741
737
|
#### Parameters
|
|
742
738
|
|
|
743
739
|
| Name | Type |
|
|
744
740
|
| :------ | :------ |
|
|
745
741
|
| `patientUuid` | [`PatientUuid`](API.md#patientuuid) |
|
|
746
|
-
| `contentOverrides?` | `Partial`<
|
|
742
|
+
| `contentOverrides?` | `Partial`<[`FHIRRequestOptions`](interfaces/FHIRRequestOptions.md)\> |
|
|
747
743
|
|
|
748
744
|
#### Returns
|
|
749
745
|
|
|
750
|
-
`Promise`<{ `data`: `Patient` }\> \| `Promise`<``null``\>
|
|
746
|
+
`Promise`<{ `config`: [`FHIRRequestObj`](interfaces/FHIRRequestObj.md) ; `data`: `Patient` ; `headers`: `Headers` ; `status`: `number` }\> \| `Promise`<``null``\>
|
|
751
747
|
|
|
752
748
|
#### Defined in
|
|
753
749
|
|
|
754
|
-
[packages/framework/esm-api/src/shared-api-objects/current-patient.ts:21](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
750
|
+
[packages/framework/esm-api/src/shared-api-objects/current-patient.ts:21](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/shared-api-objects/current-patient.ts#L21)
|
|
755
751
|
|
|
756
752
|
___
|
|
757
753
|
|
|
@@ -759,44 +755,13 @@ ___
|
|
|
759
755
|
|
|
760
756
|
▸ **getCurrentUser**(): `Observable`<[`Session`](interfaces/Session.md)\>
|
|
761
757
|
|
|
762
|
-
The getCurrentUser function returns an observable that produces
|
|
763
|
-
**zero or more values, over time**. It will produce zero values
|
|
764
|
-
by default if the user is not logged in. And it will provide a
|
|
765
|
-
first value when the logged in user is fetched from the server.
|
|
766
|
-
Subsequent values will be produced whenever the user object is
|
|
767
|
-
updated.
|
|
768
|
-
|
|
769
758
|
#### Returns
|
|
770
759
|
|
|
771
760
|
`Observable`<[`Session`](interfaces/Session.md)\>
|
|
772
761
|
|
|
773
|
-
An Observable that produces zero or more values (as
|
|
774
|
-
described above). The values produced will be a user object (if
|
|
775
|
-
`includeAuthStatus` is set to `false`) or an object with a session
|
|
776
|
-
and authenticated property (if `includeAuthStatus` is set to `true`).
|
|
777
|
-
|
|
778
|
-
#### Example
|
|
779
|
-
|
|
780
|
-
```js
|
|
781
|
-
import { getCurrentUser } from '@openmrs/esm-api'
|
|
782
|
-
const subscription = getCurrentUser().subscribe(
|
|
783
|
-
user => console.log(user)
|
|
784
|
-
)
|
|
785
|
-
subscription.unsubscribe()
|
|
786
|
-
getCurrentUser({includeAuthStatus: true}).subscribe(
|
|
787
|
-
data => console.log(data.authenticated)
|
|
788
|
-
)
|
|
789
|
-
```
|
|
790
|
-
|
|
791
|
-
#### Be sure to unsubscribe when your component unmounts
|
|
792
|
-
|
|
793
|
-
Otherwise your code will continue getting updates to the user object
|
|
794
|
-
even after the UI component is gone from the screen. This is a memory
|
|
795
|
-
leak and source of bugs.
|
|
796
|
-
|
|
797
762
|
#### Defined in
|
|
798
763
|
|
|
799
|
-
[packages/framework/esm-api/src/shared-api-objects/current-user.ts:
|
|
764
|
+
[packages/framework/esm-api/src/shared-api-objects/current-user.ts:71](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/shared-api-objects/current-user.ts#L71)
|
|
800
765
|
|
|
801
766
|
▸ **getCurrentUser**(`opts`): `Observable`<[`Session`](interfaces/Session.md)\>
|
|
802
767
|
|
|
@@ -813,7 +778,7 @@ leak and source of bugs.
|
|
|
813
778
|
|
|
814
779
|
#### Defined in
|
|
815
780
|
|
|
816
|
-
[packages/framework/esm-api/src/shared-api-objects/current-user.ts:
|
|
781
|
+
[packages/framework/esm-api/src/shared-api-objects/current-user.ts:72](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/shared-api-objects/current-user.ts#L72)
|
|
817
782
|
|
|
818
783
|
▸ **getCurrentUser**(`opts`): `Observable`<[`LoggedInUser`](interfaces/LoggedInUser.md)\>
|
|
819
784
|
|
|
@@ -830,7 +795,7 @@ leak and source of bugs.
|
|
|
830
795
|
|
|
831
796
|
#### Defined in
|
|
832
797
|
|
|
833
|
-
[packages/framework/esm-api/src/shared-api-objects/current-user.ts:
|
|
798
|
+
[packages/framework/esm-api/src/shared-api-objects/current-user.ts:73](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/shared-api-objects/current-user.ts#L73)
|
|
834
799
|
|
|
835
800
|
___
|
|
836
801
|
|
|
@@ -844,7 +809,7 @@ ___
|
|
|
844
809
|
|
|
845
810
|
#### Defined in
|
|
846
811
|
|
|
847
|
-
[packages/framework/esm-api/src/shared-api-objects/location.ts:14](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
812
|
+
[packages/framework/esm-api/src/shared-api-objects/location.ts:14](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/shared-api-objects/location.ts#L14)
|
|
848
813
|
|
|
849
814
|
___
|
|
850
815
|
|
|
@@ -858,7 +823,7 @@ ___
|
|
|
858
823
|
|
|
859
824
|
#### Defined in
|
|
860
825
|
|
|
861
|
-
[packages/framework/esm-api/src/shared-api-objects/current-user.ts:
|
|
826
|
+
[packages/framework/esm-api/src/shared-api-objects/current-user.ts:202](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/shared-api-objects/current-user.ts#L202)
|
|
862
827
|
|
|
863
828
|
___
|
|
864
829
|
|
|
@@ -872,7 +837,7 @@ ___
|
|
|
872
837
|
|
|
873
838
|
#### Defined in
|
|
874
839
|
|
|
875
|
-
[packages/framework/esm-api/src/shared-api-objects/current-user.ts:
|
|
840
|
+
[packages/framework/esm-api/src/shared-api-objects/current-user.ts:220](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/shared-api-objects/current-user.ts#L220)
|
|
876
841
|
|
|
877
842
|
___
|
|
878
843
|
|
|
@@ -886,7 +851,7 @@ ___
|
|
|
886
851
|
|
|
887
852
|
#### Defined in
|
|
888
853
|
|
|
889
|
-
[packages/framework/esm-api/src/shared-api-objects/current-user.ts:
|
|
854
|
+
[packages/framework/esm-api/src/shared-api-objects/current-user.ts:105](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/shared-api-objects/current-user.ts#L105)
|
|
890
855
|
|
|
891
856
|
___
|
|
892
857
|
|
|
@@ -900,7 +865,7 @@ ___
|
|
|
900
865
|
|
|
901
866
|
#### Defined in
|
|
902
867
|
|
|
903
|
-
[packages/framework/esm-api/src/shared-api-objects/visit-type.ts:15](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
868
|
+
[packages/framework/esm-api/src/shared-api-objects/visit-type.ts:15](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/shared-api-objects/visit-type.ts#L15)
|
|
904
869
|
|
|
905
870
|
___
|
|
906
871
|
|
|
@@ -922,7 +887,7 @@ ___
|
|
|
922
887
|
|
|
923
888
|
#### Defined in
|
|
924
889
|
|
|
925
|
-
[packages/framework/esm-api/src/shared-api-objects/visit-utils.ts:20](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
890
|
+
[packages/framework/esm-api/src/shared-api-objects/visit-utils.ts:20](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/shared-api-objects/visit-utils.ts#L20)
|
|
926
891
|
|
|
927
892
|
___
|
|
928
893
|
|
|
@@ -930,15 +895,6 @@ ___
|
|
|
930
895
|
|
|
931
896
|
▸ **makeUrl**(`path`): `string`
|
|
932
897
|
|
|
933
|
-
Append `path` to the OpenMRS SPA base.
|
|
934
|
-
|
|
935
|
-
#### Example
|
|
936
|
-
|
|
937
|
-
```ts
|
|
938
|
-
makeUrl('/foo/bar');
|
|
939
|
-
// => '/openmrs/foo/bar'
|
|
940
|
-
```
|
|
941
|
-
|
|
942
898
|
#### Parameters
|
|
943
899
|
|
|
944
900
|
| Name | Type |
|
|
@@ -951,7 +907,7 @@ makeUrl('/foo/bar');
|
|
|
951
907
|
|
|
952
908
|
#### Defined in
|
|
953
909
|
|
|
954
|
-
[packages/framework/esm-api/src/openmrs-fetch.ts:
|
|
910
|
+
[packages/framework/esm-api/src/openmrs-fetch.ts:19](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/openmrs-fetch.ts#L19)
|
|
955
911
|
|
|
956
912
|
___
|
|
957
913
|
|
|
@@ -959,11 +915,6 @@ ___
|
|
|
959
915
|
|
|
960
916
|
▸ **openmrsFetch**<`T`\>(`path`, `fetchInit?`): `Promise`<[`FetchResponse`](interfaces/FetchResponse.md)<`T`\>\>
|
|
961
917
|
|
|
962
|
-
The openmrsFetch function is a wrapper around the
|
|
963
|
-
[browser's built-in fetch function](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API/Using_Fetch),
|
|
964
|
-
with extra handling for OpenMRS-specific API behaviors, such as
|
|
965
|
-
request headers, authentication, authorization, and the API urls.
|
|
966
|
-
|
|
967
918
|
#### Type parameters
|
|
968
919
|
|
|
969
920
|
| Name | Type |
|
|
@@ -974,51 +925,16 @@ request headers, authentication, authorization, and the API urls.
|
|
|
974
925
|
|
|
975
926
|
| Name | Type | Description |
|
|
976
927
|
| :------ | :------ | :------ |
|
|
977
|
-
| `path` | `string` |
|
|
978
|
-
| `fetchInit` | `FetchConfig` |
|
|
928
|
+
| `path` | `string` | |
|
|
929
|
+
| `fetchInit` | `FetchConfig` | |
|
|
979
930
|
|
|
980
931
|
#### Returns
|
|
981
932
|
|
|
982
933
|
`Promise`<[`FetchResponse`](interfaces/FetchResponse.md)<`T`\>\>
|
|
983
934
|
|
|
984
|
-
A [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)
|
|
985
|
-
that resolves with a [Response object](https://developer.mozilla.org/en-US/docs/Web/API/Response).
|
|
986
|
-
Note that the openmrs version of the Response object has already
|
|
987
|
-
downloaded the HTTP response body as json, and has an additional
|
|
988
|
-
`data` property with the HTTP response json as a javascript object.
|
|
989
|
-
|
|
990
|
-
#### Example
|
|
991
|
-
```js
|
|
992
|
-
import { openmrsFetch } from '@openmrs/esm-api'
|
|
993
|
-
const abortController = new AbortController();
|
|
994
|
-
openmrsFetch('/ws/rest/v1/session', {signal: abortController.signal})
|
|
995
|
-
.then(response => {
|
|
996
|
-
console.log(response.data.authenticated)
|
|
997
|
-
})
|
|
998
|
-
.catch(err => {
|
|
999
|
-
console.error(err.status);
|
|
1000
|
-
})
|
|
1001
|
-
abortController.abort();
|
|
1002
|
-
openmrsFetch('/ws/rest/v1/session', {
|
|
1003
|
-
method: 'POST',
|
|
1004
|
-
body: {
|
|
1005
|
-
username: 'hi',
|
|
1006
|
-
password: 'there',
|
|
1007
|
-
}
|
|
1008
|
-
})
|
|
1009
|
-
```
|
|
1010
|
-
|
|
1011
|
-
#### Cancellation
|
|
1012
|
-
|
|
1013
|
-
To cancel a network request, use an
|
|
1014
|
-
[AbortController](https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort).
|
|
1015
|
-
It is best practice to cancel your network requests when the user
|
|
1016
|
-
navigates away from a page while the request is pending request, to
|
|
1017
|
-
free up memory and network resources and to prevent race conditions.
|
|
1018
|
-
|
|
1019
935
|
#### Defined in
|
|
1020
936
|
|
|
1021
|
-
[packages/framework/esm-api/src/openmrs-fetch.ts:
|
|
937
|
+
[packages/framework/esm-api/src/openmrs-fetch.ts:72](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/openmrs-fetch.ts#L72)
|
|
1022
938
|
|
|
1023
939
|
___
|
|
1024
940
|
|
|
@@ -1026,11 +942,6 @@ ___
|
|
|
1026
942
|
|
|
1027
943
|
▸ **openmrsObservableFetch**<`T`\>(`url`, `fetchInit?`): `Observable`<[`FetchResponse`](interfaces/FetchResponse.md)<`T`\>\>
|
|
1028
944
|
|
|
1029
|
-
The openmrsObservableFetch function is a wrapper around openmrsFetch
|
|
1030
|
-
that returns an [Observable](https://rxjs-dev.firebaseapp.com/guide/observable)
|
|
1031
|
-
instead of a promise. It exists in case using an Observable is
|
|
1032
|
-
preferred or more convenient than a promise.
|
|
1033
|
-
|
|
1034
945
|
#### Type parameters
|
|
1035
946
|
|
|
1036
947
|
| Name |
|
|
@@ -1041,35 +952,16 @@ preferred or more convenient than a promise.
|
|
|
1041
952
|
|
|
1042
953
|
| Name | Type | Description |
|
|
1043
954
|
| :------ | :------ | :------ |
|
|
1044
|
-
| `url` | `string` |
|
|
1045
|
-
| `fetchInit` | `FetchConfig` |
|
|
955
|
+
| `url` | `string` | |
|
|
956
|
+
| `fetchInit` | `FetchConfig` | |
|
|
1046
957
|
|
|
1047
958
|
#### Returns
|
|
1048
959
|
|
|
1049
960
|
`Observable`<[`FetchResponse`](interfaces/FetchResponse.md)<`T`\>\>
|
|
1050
961
|
|
|
1051
|
-
An Observable that produces exactly one Response object.
|
|
1052
|
-
The response object is exactly the same as for [openmrsFetch](API.md#openmrsfetch).
|
|
1053
|
-
|
|
1054
|
-
#### Example
|
|
1055
|
-
|
|
1056
|
-
```js
|
|
1057
|
-
import { openmrsObservableFetch } from '@openmrs/esm-api'
|
|
1058
|
-
const subscription = openmrsObservableFetch('/ws/rest/v1/session').subscribe(
|
|
1059
|
-
response => console.log(response.data),
|
|
1060
|
-
err => {throw err},
|
|
1061
|
-
() => console.log('finished')
|
|
1062
|
-
)
|
|
1063
|
-
subscription.unsubscribe()
|
|
1064
|
-
```
|
|
1065
|
-
|
|
1066
|
-
#### Cancellation
|
|
1067
|
-
|
|
1068
|
-
To cancel the network request, simply call `subscription.unsubscribe();`
|
|
1069
|
-
|
|
1070
962
|
#### Defined in
|
|
1071
963
|
|
|
1072
|
-
[packages/framework/esm-api/src/openmrs-fetch.ts:
|
|
964
|
+
[packages/framework/esm-api/src/openmrs-fetch.ts:243](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/openmrs-fetch.ts#L243)
|
|
1073
965
|
|
|
1074
966
|
___
|
|
1075
967
|
|
|
@@ -1077,25 +969,13 @@ ___
|
|
|
1077
969
|
|
|
1078
970
|
▸ **refetchCurrentUser**(): `Promise`<`unknown`\>
|
|
1079
971
|
|
|
1080
|
-
The `refetchCurrentUser` function causes a network request to redownload
|
|
1081
|
-
the user. All subscribers to the current user will be notified of the
|
|
1082
|
-
new users once the new version of the user object is downloaded.
|
|
1083
|
-
|
|
1084
972
|
#### Returns
|
|
1085
973
|
|
|
1086
974
|
`Promise`<`unknown`\>
|
|
1087
975
|
|
|
1088
|
-
The same observable as returned by [getCurrentUser](API.md#getcurrentuser).
|
|
1089
|
-
|
|
1090
|
-
#### Example
|
|
1091
|
-
```js
|
|
1092
|
-
import { refetchCurrentUser } from '@openmrs/esm-api'
|
|
1093
|
-
refetchCurrentUser()
|
|
1094
|
-
```
|
|
1095
|
-
|
|
1096
976
|
#### Defined in
|
|
1097
977
|
|
|
1098
|
-
[packages/framework/esm-api/src/shared-api-objects/current-user.ts:
|
|
978
|
+
[packages/framework/esm-api/src/shared-api-objects/current-user.ts:163](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/shared-api-objects/current-user.ts#L163)
|
|
1099
979
|
|
|
1100
980
|
___
|
|
1101
981
|
|
|
@@ -1116,7 +996,7 @@ ___
|
|
|
1116
996
|
|
|
1117
997
|
#### Defined in
|
|
1118
998
|
|
|
1119
|
-
[packages/framework/esm-api/src/shared-api-objects/visit-utils.ts:45](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
999
|
+
[packages/framework/esm-api/src/shared-api-objects/visit-utils.ts:45](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/shared-api-objects/visit-utils.ts#L45)
|
|
1120
1000
|
|
|
1121
1001
|
___
|
|
1122
1002
|
|
|
@@ -1137,7 +1017,7 @@ ___
|
|
|
1137
1017
|
|
|
1138
1018
|
#### Defined in
|
|
1139
1019
|
|
|
1140
|
-
[packages/framework/esm-api/src/shared-api-objects/current-user.ts:
|
|
1020
|
+
[packages/framework/esm-api/src/shared-api-objects/current-user.ts:229](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/shared-api-objects/current-user.ts#L229)
|
|
1141
1021
|
|
|
1142
1022
|
___
|
|
1143
1023
|
|
|
@@ -1157,7 +1037,7 @@ ___
|
|
|
1157
1037
|
|
|
1158
1038
|
#### Defined in
|
|
1159
1039
|
|
|
1160
|
-
[packages/framework/esm-api/src/shared-api-objects/location.ts:7](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
1040
|
+
[packages/framework/esm-api/src/shared-api-objects/location.ts:7](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/shared-api-objects/location.ts#L7)
|
|
1161
1041
|
|
|
1162
1042
|
___
|
|
1163
1043
|
|
|
@@ -1177,7 +1057,7 @@ ___
|
|
|
1177
1057
|
|
|
1178
1058
|
#### Defined in
|
|
1179
1059
|
|
|
1180
|
-
[packages/framework/esm-api/src/shared-api-objects/visit-type.ts:7](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
1060
|
+
[packages/framework/esm-api/src/shared-api-objects/visit-type.ts:7](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/shared-api-objects/visit-type.ts#L7)
|
|
1181
1061
|
|
|
1182
1062
|
___
|
|
1183
1063
|
|
|
@@ -1199,7 +1079,7 @@ ___
|
|
|
1199
1079
|
|
|
1200
1080
|
#### Defined in
|
|
1201
1081
|
|
|
1202
|
-
[packages/framework/esm-api/src/shared-api-objects/visit-utils.ts:59](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
1082
|
+
[packages/framework/esm-api/src/shared-api-objects/visit-utils.ts:59](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/shared-api-objects/visit-utils.ts#L59)
|
|
1203
1083
|
|
|
1204
1084
|
___
|
|
1205
1085
|
|
|
@@ -1207,11 +1087,6 @@ ___
|
|
|
1207
1087
|
|
|
1208
1088
|
▸ **useCurrentPatient**(`patientUuid?`): [`boolean`, `NullablePatient`, [`PatientUuid`](API.md#patientuuid), `Error` \| ``null``]
|
|
1209
1089
|
|
|
1210
|
-
This React hook returns the current patient, as specified by the current route. It returns
|
|
1211
|
-
all the information needed to render a loading state, error state, and normal/success state.
|
|
1212
|
-
|
|
1213
|
-
**`deprecated`** Use [usePatient](API.md#usepatient) instead.
|
|
1214
|
-
|
|
1215
1090
|
#### Parameters
|
|
1216
1091
|
|
|
1217
1092
|
| Name | Type |
|
|
@@ -1224,7 +1099,7 @@ all the information needed to render a loading state, error state, and normal/su
|
|
|
1224
1099
|
|
|
1225
1100
|
#### Defined in
|
|
1226
1101
|
|
|
1227
|
-
[packages/framework/esm-react-utils/src/useCurrentPatient.ts:83](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
1102
|
+
[packages/framework/esm-react-utils/src/useCurrentPatient.ts:83](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useCurrentPatient.ts#L83)
|
|
1228
1103
|
|
|
1229
1104
|
___
|
|
1230
1105
|
|
|
@@ -1238,7 +1113,7 @@ ___
|
|
|
1238
1113
|
|
|
1239
1114
|
#### Defined in
|
|
1240
1115
|
|
|
1241
|
-
[packages/framework/esm-react-utils/src/useLocations.tsx:5](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
1116
|
+
[packages/framework/esm-react-utils/src/useLocations.tsx:5](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useLocations.tsx#L5)
|
|
1242
1117
|
|
|
1243
1118
|
___
|
|
1244
1119
|
|
|
@@ -1246,11 +1121,6 @@ ___
|
|
|
1246
1121
|
|
|
1247
1122
|
▸ **usePatient**(`patientUuid?`): `Object`
|
|
1248
1123
|
|
|
1249
|
-
This React hook returns a patient object. If the `patientUuid` is provided
|
|
1250
|
-
as a parameter, then the patient for that UUID is returned. If the parameter
|
|
1251
|
-
is not provided, the patient UUID is obtained from the current route, and
|
|
1252
|
-
a route listener is set up to update the patient whenever the route changes.
|
|
1253
|
-
|
|
1254
1124
|
#### Parameters
|
|
1255
1125
|
|
|
1256
1126
|
| Name | Type |
|
|
@@ -1270,7 +1140,7 @@ a route listener is set up to update the patient whenever the route changes.
|
|
|
1270
1140
|
|
|
1271
1141
|
#### Defined in
|
|
1272
1142
|
|
|
1273
|
-
[packages/framework/esm-react-utils/src/usePatient.ts:92](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
1143
|
+
[packages/framework/esm-react-utils/src/usePatient.ts:92](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/usePatient.ts#L92)
|
|
1274
1144
|
|
|
1275
1145
|
___
|
|
1276
1146
|
|
|
@@ -1278,21 +1148,13 @@ ___
|
|
|
1278
1148
|
|
|
1279
1149
|
▸ **useSession**(): [`Session`](interfaces/Session.md)
|
|
1280
1150
|
|
|
1281
|
-
Gets the current user session information. Returns an object with
|
|
1282
|
-
property `authenticated` == `false` if the user is not logged in.
|
|
1283
|
-
|
|
1284
|
-
Uses Suspense. This hook will always either return a Session object
|
|
1285
|
-
or throw for Suspense. It will never return `null`/`undefined`.
|
|
1286
|
-
|
|
1287
1151
|
#### Returns
|
|
1288
1152
|
|
|
1289
1153
|
[`Session`](interfaces/Session.md)
|
|
1290
1154
|
|
|
1291
|
-
Current user session information
|
|
1292
|
-
|
|
1293
1155
|
#### Defined in
|
|
1294
1156
|
|
|
1295
|
-
[packages/framework/esm-react-utils/src/useSession.tsx:17](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
1157
|
+
[packages/framework/esm-react-utils/src/useSession.tsx:17](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useSession.tsx#L17)
|
|
1296
1158
|
|
|
1297
1159
|
___
|
|
1298
1160
|
|
|
@@ -1300,25 +1162,19 @@ ___
|
|
|
1300
1162
|
|
|
1301
1163
|
▸ **useVisit**(`patientUuid`): `VisitReturnType`
|
|
1302
1164
|
|
|
1303
|
-
This React hook returns a visit object. If the `patientUuid` is provided
|
|
1304
|
-
as a parameter, then the currentVisit, error and mutate function
|
|
1305
|
-
for that patient visit is returned.
|
|
1306
|
-
|
|
1307
1165
|
#### Parameters
|
|
1308
1166
|
|
|
1309
1167
|
| Name | Type | Description |
|
|
1310
1168
|
| :------ | :------ | :------ |
|
|
1311
|
-
| `patientUuid` | `string` |
|
|
1169
|
+
| `patientUuid` | `string` | |
|
|
1312
1170
|
|
|
1313
1171
|
#### Returns
|
|
1314
1172
|
|
|
1315
1173
|
`VisitReturnType`
|
|
1316
1174
|
|
|
1317
|
-
Object {`error` `isValidating`, `currentVisit`, `mutate`}
|
|
1318
|
-
|
|
1319
1175
|
#### Defined in
|
|
1320
1176
|
|
|
1321
|
-
[packages/framework/esm-react-utils/src/useVisit.ts:29](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
1177
|
+
[packages/framework/esm-react-utils/src/useVisit.ts:29](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useVisit.ts#L29)
|
|
1322
1178
|
|
|
1323
1179
|
___
|
|
1324
1180
|
|
|
@@ -1332,30 +1188,30 @@ ___
|
|
|
1332
1188
|
|
|
1333
1189
|
#### Defined in
|
|
1334
1190
|
|
|
1335
|
-
[packages/framework/esm-react-utils/src/useVisitTypes.ts:5](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
1191
|
+
[packages/framework/esm-react-utils/src/useVisitTypes.ts:5](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useVisitTypes.ts#L5)
|
|
1336
1192
|
|
|
1337
1193
|
___
|
|
1338
1194
|
|
|
1339
1195
|
### userHasAccess
|
|
1340
1196
|
|
|
1341
|
-
▸ **userHasAccess**(`requiredPrivilege`, `user`): `
|
|
1197
|
+
▸ **userHasAccess**(`requiredPrivilege`, `user`): `boolean`
|
|
1342
1198
|
|
|
1343
1199
|
#### Parameters
|
|
1344
1200
|
|
|
1345
1201
|
| Name | Type |
|
|
1346
1202
|
| :------ | :------ |
|
|
1347
|
-
| `requiredPrivilege` | `string` |
|
|
1203
|
+
| `requiredPrivilege` | `string` \| `string`[] |
|
|
1348
1204
|
| `user` | `Object` |
|
|
1349
1205
|
| `user.privileges` | [`Privilege`](interfaces/Privilege.md)[] |
|
|
1350
1206
|
| `user.roles` | [`Role`](interfaces/Role.md)[] |
|
|
1351
1207
|
|
|
1352
1208
|
#### Returns
|
|
1353
1209
|
|
|
1354
|
-
`
|
|
1210
|
+
`boolean`
|
|
1355
1211
|
|
|
1356
1212
|
#### Defined in
|
|
1357
1213
|
|
|
1358
|
-
[packages/framework/esm-api/src/shared-api-objects/current-user.ts:
|
|
1214
|
+
[packages/framework/esm-api/src/shared-api-objects/current-user.ts:195](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/shared-api-objects/current-user.ts#L195)
|
|
1359
1215
|
|
|
1360
1216
|
___
|
|
1361
1217
|
|
|
@@ -1378,7 +1234,7 @@ ___
|
|
|
1378
1234
|
|
|
1379
1235
|
#### Defined in
|
|
1380
1236
|
|
|
1381
|
-
[packages/framework/esm-breadcrumbs/src/filter.ts:43](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
1237
|
+
[packages/framework/esm-breadcrumbs/src/filter.ts:43](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-breadcrumbs/src/filter.ts#L43)
|
|
1382
1238
|
|
|
1383
1239
|
___
|
|
1384
1240
|
|
|
@@ -1392,7 +1248,7 @@ ___
|
|
|
1392
1248
|
|
|
1393
1249
|
#### Defined in
|
|
1394
1250
|
|
|
1395
|
-
[packages/framework/esm-breadcrumbs/src/db.ts:35](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
1251
|
+
[packages/framework/esm-breadcrumbs/src/db.ts:35](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-breadcrumbs/src/db.ts#L35)
|
|
1396
1252
|
|
|
1397
1253
|
___
|
|
1398
1254
|
|
|
@@ -1412,7 +1268,7 @@ ___
|
|
|
1412
1268
|
|
|
1413
1269
|
#### Defined in
|
|
1414
1270
|
|
|
1415
|
-
[packages/framework/esm-breadcrumbs/src/filter.ts:66](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
1271
|
+
[packages/framework/esm-breadcrumbs/src/filter.ts:66](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-breadcrumbs/src/filter.ts#L66)
|
|
1416
1272
|
|
|
1417
1273
|
___
|
|
1418
1274
|
|
|
@@ -1432,7 +1288,7 @@ ___
|
|
|
1432
1288
|
|
|
1433
1289
|
#### Defined in
|
|
1434
1290
|
|
|
1435
|
-
[packages/framework/esm-breadcrumbs/src/db.ts:21](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
1291
|
+
[packages/framework/esm-breadcrumbs/src/db.ts:21](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-breadcrumbs/src/db.ts#L21)
|
|
1436
1292
|
|
|
1437
1293
|
___
|
|
1438
1294
|
|
|
@@ -1452,7 +1308,7 @@ ___
|
|
|
1452
1308
|
|
|
1453
1309
|
#### Defined in
|
|
1454
1310
|
|
|
1455
|
-
[packages/framework/esm-breadcrumbs/src/db.ts:25](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
1311
|
+
[packages/framework/esm-breadcrumbs/src/db.ts:25](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-breadcrumbs/src/db.ts#L25)
|
|
1456
1312
|
|
|
1457
1313
|
___
|
|
1458
1314
|
|
|
@@ -1462,19 +1318,12 @@ ___
|
|
|
1462
1318
|
|
|
1463
1319
|
▸ **defineConfigSchema**(`moduleName`, `schema`): `void`
|
|
1464
1320
|
|
|
1465
|
-
This defines a configuration schema for a module. The schema tells the
|
|
1466
|
-
configuration system how the module can be configured. It specifies
|
|
1467
|
-
what makes configuration valid or invalid.
|
|
1468
|
-
|
|
1469
|
-
See [Configuration System](http://o3-dev.docs.openmrs.org/#/main/config)
|
|
1470
|
-
for more information about defining a config schema.
|
|
1471
|
-
|
|
1472
1321
|
#### Parameters
|
|
1473
1322
|
|
|
1474
1323
|
| Name | Type | Description |
|
|
1475
1324
|
| :------ | :------ | :------ |
|
|
1476
|
-
| `moduleName` | `string` |
|
|
1477
|
-
| `schema` | [`ConfigSchema`](interfaces/ConfigSchema.md) |
|
|
1325
|
+
| `moduleName` | `string` | |
|
|
1326
|
+
| `schema` | [`ConfigSchema`](interfaces/ConfigSchema.md) | |
|
|
1478
1327
|
|
|
1479
1328
|
#### Returns
|
|
1480
1329
|
|
|
@@ -1482,7 +1331,7 @@ for more information about defining a config schema.
|
|
|
1482
1331
|
|
|
1483
1332
|
#### Defined in
|
|
1484
1333
|
|
|
1485
|
-
[packages/framework/esm-config/src/module-config/module-config.ts:
|
|
1334
|
+
[packages/framework/esm-config/src/module-config/module-config.ts:192](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/module-config/module-config.ts#L192)
|
|
1486
1335
|
|
|
1487
1336
|
___
|
|
1488
1337
|
|
|
@@ -1490,23 +1339,12 @@ ___
|
|
|
1490
1339
|
|
|
1491
1340
|
▸ **defineExtensionConfigSchema**(`extensionName`, `schema`): `void`
|
|
1492
1341
|
|
|
1493
|
-
This defines a configuration schema for an extension. When a schema is defined
|
|
1494
|
-
for an extension, that extension will receive the configuration corresponding
|
|
1495
|
-
to that schema, rather than the configuration corresponding to the module
|
|
1496
|
-
in which it is defined.
|
|
1497
|
-
|
|
1498
|
-
The schema tells the configuration system how the module can be configured.
|
|
1499
|
-
It specifies what makes configuration valid or invalid.
|
|
1500
|
-
|
|
1501
|
-
See [Configuration System](http://o3-dev.docs.openmrs.org/#/main/config)
|
|
1502
|
-
for more information about defining a config schema.
|
|
1503
|
-
|
|
1504
1342
|
#### Parameters
|
|
1505
1343
|
|
|
1506
1344
|
| Name | Type | Description |
|
|
1507
1345
|
| :------ | :------ | :------ |
|
|
1508
|
-
| `extensionName` | `string` |
|
|
1509
|
-
| `schema` | [`ConfigSchema`](interfaces/ConfigSchema.md) |
|
|
1346
|
+
| `extensionName` | `string` | |
|
|
1347
|
+
| `schema` | [`ConfigSchema`](interfaces/ConfigSchema.md) | |
|
|
1510
1348
|
|
|
1511
1349
|
#### Returns
|
|
1512
1350
|
|
|
@@ -1514,7 +1352,7 @@ for more information about defining a config schema.
|
|
|
1514
1352
|
|
|
1515
1353
|
#### Defined in
|
|
1516
1354
|
|
|
1517
|
-
[packages/framework/esm-config/src/module-config/module-config.ts:
|
|
1355
|
+
[packages/framework/esm-config/src/module-config/module-config.ts:222](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/module-config/module-config.ts#L222)
|
|
1518
1356
|
|
|
1519
1357
|
___
|
|
1520
1358
|
|
|
@@ -1522,21 +1360,11 @@ ___
|
|
|
1522
1360
|
|
|
1523
1361
|
▸ **getConfig**(`moduleName`): `Promise`<[`Config`](interfaces/Config.md)\>
|
|
1524
1362
|
|
|
1525
|
-
A promise-based way to access the config as soon as it is fully loaded.
|
|
1526
|
-
If it is already loaded, resolves the config in its present state.
|
|
1527
|
-
|
|
1528
|
-
In general you should use the Unistore-based API provided by
|
|
1529
|
-
`getConfigStore`, which allows creating a subscription so that you always
|
|
1530
|
-
have the latest config. If using React, just use `useConfig`.
|
|
1531
|
-
|
|
1532
|
-
This is a useful function if you need to get the config in the course
|
|
1533
|
-
of the execution of a function.
|
|
1534
|
-
|
|
1535
1363
|
#### Parameters
|
|
1536
1364
|
|
|
1537
1365
|
| Name | Type | Description |
|
|
1538
1366
|
| :------ | :------ | :------ |
|
|
1539
|
-
| `moduleName` | `string` |
|
|
1367
|
+
| `moduleName` | `string` | |
|
|
1540
1368
|
|
|
1541
1369
|
#### Returns
|
|
1542
1370
|
|
|
@@ -1544,7 +1372,7 @@ of the execution of a function.
|
|
|
1544
1372
|
|
|
1545
1373
|
#### Defined in
|
|
1546
1374
|
|
|
1547
|
-
[packages/framework/esm-config/src/module-config/module-config.ts:
|
|
1375
|
+
[packages/framework/esm-config/src/module-config/module-config.ts:264](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/module-config/module-config.ts#L264)
|
|
1548
1376
|
|
|
1549
1377
|
___
|
|
1550
1378
|
|
|
@@ -1565,7 +1393,7 @@ ___
|
|
|
1565
1393
|
|
|
1566
1394
|
#### Defined in
|
|
1567
1395
|
|
|
1568
|
-
[packages/framework/esm-config/src/module-config/module-config.ts:
|
|
1396
|
+
[packages/framework/esm-config/src/module-config/module-config.ts:244](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/module-config/module-config.ts#L244)
|
|
1569
1397
|
|
|
1570
1398
|
___
|
|
1571
1399
|
|
|
@@ -1573,25 +1401,24 @@ ___
|
|
|
1573
1401
|
|
|
1574
1402
|
▸ **useConfig**(): `Object`
|
|
1575
1403
|
|
|
1576
|
-
Use this React Hook to obtain your module's configuration.
|
|
1577
|
-
|
|
1578
1404
|
#### Returns
|
|
1579
1405
|
|
|
1580
1406
|
`Object`
|
|
1581
1407
|
|
|
1582
1408
|
| Name | Type | Description |
|
|
1583
1409
|
| :------ | :------ | :------ |
|
|
1584
|
-
| `
|
|
1585
|
-
| `
|
|
1586
|
-
| `
|
|
1587
|
-
| `
|
|
1588
|
-
| `
|
|
1589
|
-
| `
|
|
1590
|
-
| `
|
|
1410
|
+
| `Display conditions?` | [`DisplayConditionsConfigObject`](interfaces/DisplayConditionsConfigObject.md) | - |
|
|
1411
|
+
| `constructor` | `Function` | |
|
|
1412
|
+
| `hasOwnProperty` | (`v`: `PropertyKey`) => `boolean` | |
|
|
1413
|
+
| `isPrototypeOf` | (`v`: `Object`) => `boolean` | |
|
|
1414
|
+
| `propertyIsEnumerable` | (`v`: `PropertyKey`) => `boolean` | |
|
|
1415
|
+
| `toLocaleString` | () => `string` | |
|
|
1416
|
+
| `toString` | () => `string` | |
|
|
1417
|
+
| `valueOf` | () => `Object` | |
|
|
1591
1418
|
|
|
1592
1419
|
#### Defined in
|
|
1593
1420
|
|
|
1594
|
-
[packages/framework/esm-react-utils/src/useConfig.ts:163](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
1421
|
+
[packages/framework/esm-react-utils/src/useConfig.ts:163](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useConfig.ts#L163)
|
|
1595
1422
|
|
|
1596
1423
|
___
|
|
1597
1424
|
|
|
@@ -1599,16 +1426,14 @@ ___
|
|
|
1599
1426
|
|
|
1600
1427
|
### inRange
|
|
1601
1428
|
|
|
1602
|
-
▸
|
|
1603
|
-
|
|
1604
|
-
Verifies that the value is between the provided minimum and maximum
|
|
1429
|
+
▸ **inRange**(`min`, `max`): [`Validator`](API.md#validator)
|
|
1605
1430
|
|
|
1606
1431
|
#### Parameters
|
|
1607
1432
|
|
|
1608
1433
|
| Name | Type | Description |
|
|
1609
1434
|
| :------ | :------ | :------ |
|
|
1610
|
-
| `min` | `number` |
|
|
1611
|
-
| `max` | `number` |
|
|
1435
|
+
| `min` | `number` | |
|
|
1436
|
+
| `max` | `number` | |
|
|
1612
1437
|
|
|
1613
1438
|
#### Returns
|
|
1614
1439
|
|
|
@@ -1616,17 +1441,13 @@ Verifies that the value is between the provided minimum and maximum
|
|
|
1616
1441
|
|
|
1617
1442
|
#### Defined in
|
|
1618
1443
|
|
|
1619
|
-
[packages/framework/esm-config/src/validators/validators.ts:10](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
1444
|
+
[packages/framework/esm-config/src/validators/validators.ts:10](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/validators/validators.ts#L10)
|
|
1620
1445
|
|
|
1621
1446
|
___
|
|
1622
1447
|
|
|
1623
1448
|
### isUrl
|
|
1624
1449
|
|
|
1625
|
-
▸
|
|
1626
|
-
|
|
1627
|
-
Verifies that a string contains only the default URL template parameters.
|
|
1628
|
-
|
|
1629
|
-
**`category`** Navigation
|
|
1450
|
+
▸ **isUrl**(`value`): `string` \| `void`
|
|
1630
1451
|
|
|
1631
1452
|
#### Parameters
|
|
1632
1453
|
|
|
@@ -1640,24 +1461,19 @@ Verifies that a string contains only the default URL template parameters.
|
|
|
1640
1461
|
|
|
1641
1462
|
#### Defined in
|
|
1642
1463
|
|
|
1643
|
-
[packages/framework/esm-config/src/validators/validators.ts:56](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
1464
|
+
[packages/framework/esm-config/src/validators/validators.ts:56](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/validators/validators.ts#L56)
|
|
1644
1465
|
|
|
1645
1466
|
___
|
|
1646
1467
|
|
|
1647
1468
|
### isUrlWithTemplateParameters
|
|
1648
1469
|
|
|
1649
|
-
▸
|
|
1650
|
-
|
|
1651
|
-
Verifies that a string contains only the default URL template
|
|
1652
|
-
parameters, plus any specified in `allowedTemplateParameters`.
|
|
1653
|
-
|
|
1654
|
-
**`category`** Navigation
|
|
1470
|
+
▸ **isUrlWithTemplateParameters**(`allowedTemplateParameters`): [`Validator`](API.md#validator)
|
|
1655
1471
|
|
|
1656
1472
|
#### Parameters
|
|
1657
1473
|
|
|
1658
1474
|
| Name | Type | Description |
|
|
1659
1475
|
| :------ | :------ | :------ |
|
|
1660
|
-
| `allowedTemplateParameters` | `string`[] |
|
|
1476
|
+
| `allowedTemplateParameters` | `string`[] | |
|
|
1661
1477
|
|
|
1662
1478
|
#### Returns
|
|
1663
1479
|
|
|
@@ -1665,21 +1481,19 @@ parameters, plus any specified in `allowedTemplateParameters`.
|
|
|
1665
1481
|
|
|
1666
1482
|
#### Defined in
|
|
1667
1483
|
|
|
1668
|
-
[packages/framework/esm-config/src/validators/validators.ts:24](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
1484
|
+
[packages/framework/esm-config/src/validators/validators.ts:24](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/validators/validators.ts#L24)
|
|
1669
1485
|
|
|
1670
1486
|
___
|
|
1671
1487
|
|
|
1672
1488
|
### oneOf
|
|
1673
1489
|
|
|
1674
|
-
▸
|
|
1675
|
-
|
|
1676
|
-
Verifies that the value is one of the allowed options.
|
|
1490
|
+
▸ **oneOf**(`allowedValues`): [`Validator`](API.md#validator)
|
|
1677
1491
|
|
|
1678
1492
|
#### Parameters
|
|
1679
1493
|
|
|
1680
1494
|
| Name | Type | Description |
|
|
1681
1495
|
| :------ | :------ | :------ |
|
|
1682
|
-
| `allowedValues` | `any`[] |
|
|
1496
|
+
| `allowedValues` | `any`[] | |
|
|
1683
1497
|
|
|
1684
1498
|
#### Returns
|
|
1685
1499
|
|
|
@@ -1687,7 +1501,7 @@ Verifies that the value is one of the allowed options.
|
|
|
1687
1501
|
|
|
1688
1502
|
#### Defined in
|
|
1689
1503
|
|
|
1690
|
-
[packages/framework/esm-config/src/validators/validators.ts:62](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
1504
|
+
[packages/framework/esm-config/src/validators/validators.ts:62](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/validators/validators.ts#L62)
|
|
1691
1505
|
|
|
1692
1506
|
___
|
|
1693
1507
|
|
|
@@ -1695,37 +1509,20 @@ ___
|
|
|
1695
1509
|
|
|
1696
1510
|
▸ **validator**(`validationFunction`, `message`): [`Validator`](API.md#validator)
|
|
1697
1511
|
|
|
1698
|
-
Constructs a custom validator.
|
|
1699
|
-
|
|
1700
|
-
### Example
|
|
1701
|
-
|
|
1702
|
-
```typescript
|
|
1703
|
-
{
|
|
1704
|
-
foo: {
|
|
1705
|
-
_default: 0,
|
|
1706
|
-
_validators: [
|
|
1707
|
-
validator(val => val >= 0, "Must not be negative.")
|
|
1708
|
-
]
|
|
1709
|
-
}
|
|
1710
|
-
}
|
|
1711
|
-
```
|
|
1712
|
-
|
|
1713
1512
|
#### Parameters
|
|
1714
1513
|
|
|
1715
1514
|
| Name | Type | Description |
|
|
1716
1515
|
| :------ | :------ | :------ |
|
|
1717
|
-
| `validationFunction` | [`ValidatorFunction`](API.md#validatorfunction) |
|
|
1718
|
-
| `message` | `string` \| (`value`: `any`) => `string` |
|
|
1516
|
+
| `validationFunction` | [`ValidatorFunction`](API.md#validatorfunction) | |
|
|
1517
|
+
| `message` | `string` \| (`value`: `any`) => `string` | |
|
|
1719
1518
|
|
|
1720
1519
|
#### Returns
|
|
1721
1520
|
|
|
1722
1521
|
[`Validator`](API.md#validator)
|
|
1723
1522
|
|
|
1724
|
-
A validator ready for use in a config schema
|
|
1725
|
-
|
|
1726
1523
|
#### Defined in
|
|
1727
1524
|
|
|
1728
|
-
[packages/framework/esm-config/src/validators/validator.ts:25](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
1525
|
+
[packages/framework/esm-config/src/validators/validator.ts:25](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/validators/validator.ts#L25)
|
|
1729
1526
|
|
|
1730
1527
|
___
|
|
1731
1528
|
|
|
@@ -1735,21 +1532,6 @@ ___
|
|
|
1735
1532
|
|
|
1736
1533
|
▸ **formatDate**(`date`, `options?`): `string`
|
|
1737
1534
|
|
|
1738
|
-
Formats the input date according to the current locale and the
|
|
1739
|
-
given options.
|
|
1740
|
-
|
|
1741
|
-
Default options:
|
|
1742
|
-
- mode: "standard",
|
|
1743
|
-
- time: "for today",
|
|
1744
|
-
- day: true,
|
|
1745
|
-
- year: true
|
|
1746
|
-
|
|
1747
|
-
If the date is today then "Today" is produced (in the locale language).
|
|
1748
|
-
|
|
1749
|
-
When time is included, it is appended with a comma and a space. This
|
|
1750
|
-
agrees with the output of `Date.prototype.toLocaleString` for *most*
|
|
1751
|
-
locales.
|
|
1752
|
-
|
|
1753
1535
|
#### Parameters
|
|
1754
1536
|
|
|
1755
1537
|
| Name | Type |
|
|
@@ -1763,7 +1545,7 @@ locales.
|
|
|
1763
1545
|
|
|
1764
1546
|
#### Defined in
|
|
1765
1547
|
|
|
1766
|
-
[packages/framework/esm-utils/src/omrs-dates.ts:
|
|
1548
|
+
[packages/framework/esm-utils/src/omrs-dates.ts:184](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/omrs-dates.ts#L184)
|
|
1767
1549
|
|
|
1768
1550
|
___
|
|
1769
1551
|
|
|
@@ -1771,14 +1553,6 @@ ___
|
|
|
1771
1553
|
|
|
1772
1554
|
▸ **formatDatetime**(`date`, `options?`): `string`
|
|
1773
1555
|
|
|
1774
|
-
Formats the input into a string showing the date and time, according
|
|
1775
|
-
to the current locale. The `mode` parameter is as described for
|
|
1776
|
-
`formatDate`.
|
|
1777
|
-
|
|
1778
|
-
This is created by concatenating the results of `formatDate`
|
|
1779
|
-
and `formatTime` with a comma and space. This agrees with the
|
|
1780
|
-
output of `Date.prototype.toLocaleString` for *most* locales.
|
|
1781
|
-
|
|
1782
1556
|
#### Parameters
|
|
1783
1557
|
|
|
1784
1558
|
| Name | Type |
|
|
@@ -1792,7 +1566,7 @@ output of `Date.prototype.toLocaleString` for *most* locales.
|
|
|
1792
1566
|
|
|
1793
1567
|
#### Defined in
|
|
1794
1568
|
|
|
1795
|
-
[packages/framework/esm-utils/src/omrs-dates.ts:
|
|
1569
|
+
[packages/framework/esm-utils/src/omrs-dates.ts:251](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/omrs-dates.ts#L251)
|
|
1796
1570
|
|
|
1797
1571
|
___
|
|
1798
1572
|
|
|
@@ -1800,9 +1574,6 @@ ___
|
|
|
1800
1574
|
|
|
1801
1575
|
▸ **formatTime**(`date`): `string`
|
|
1802
1576
|
|
|
1803
|
-
Formats the input as a time, according to the current locale.
|
|
1804
|
-
12-hour or 24-hour clock depends on locale.
|
|
1805
|
-
|
|
1806
1577
|
#### Parameters
|
|
1807
1578
|
|
|
1808
1579
|
| Name | Type |
|
|
@@ -1815,7 +1586,7 @@ Formats the input as a time, according to the current locale.
|
|
|
1815
1586
|
|
|
1816
1587
|
#### Defined in
|
|
1817
1588
|
|
|
1818
|
-
[packages/framework/esm-utils/src/omrs-dates.ts:
|
|
1589
|
+
[packages/framework/esm-utils/src/omrs-dates.ts:235](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/omrs-dates.ts#L235)
|
|
1819
1590
|
|
|
1820
1591
|
___
|
|
1821
1592
|
|
|
@@ -1823,9 +1594,6 @@ ___
|
|
|
1823
1594
|
|
|
1824
1595
|
▸ **isOmrsDateStrict**(`omrsPayloadString`): `boolean`
|
|
1825
1596
|
|
|
1826
|
-
This function is STRICT on checking whether a date string is the openmrs format.
|
|
1827
|
-
The format should be YYYY-MM-DDTHH:mm:ss.SSSZZ
|
|
1828
|
-
|
|
1829
1597
|
#### Parameters
|
|
1830
1598
|
|
|
1831
1599
|
| Name | Type |
|
|
@@ -1838,7 +1606,7 @@ The format should be YYYY-MM-DDTHH:mm:ss.SSSZZ
|
|
|
1838
1606
|
|
|
1839
1607
|
#### Defined in
|
|
1840
1608
|
|
|
1841
|
-
[packages/framework/esm-utils/src/omrs-dates.ts:27](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
1609
|
+
[packages/framework/esm-utils/src/omrs-dates.ts:27](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/omrs-dates.ts#L27)
|
|
1842
1610
|
|
|
1843
1611
|
___
|
|
1844
1612
|
|
|
@@ -1850,7 +1618,7 @@ ___
|
|
|
1850
1618
|
|
|
1851
1619
|
| Name | Type | Description |
|
|
1852
1620
|
| :------ | :------ | :------ |
|
|
1853
|
-
| `date` | [`DateInput`](API.md#dateinput) |
|
|
1621
|
+
| `date` | [`DateInput`](API.md#dateinput) | |
|
|
1854
1622
|
|
|
1855
1623
|
#### Returns
|
|
1856
1624
|
|
|
@@ -1858,7 +1626,7 @@ ___
|
|
|
1858
1626
|
|
|
1859
1627
|
#### Defined in
|
|
1860
1628
|
|
|
1861
|
-
[packages/framework/esm-utils/src/omrs-dates.ts:64](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
1629
|
+
[packages/framework/esm-utils/src/omrs-dates.ts:64](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/omrs-dates.ts#L64)
|
|
1862
1630
|
|
|
1863
1631
|
___
|
|
1864
1632
|
|
|
@@ -1866,9 +1634,6 @@ ___
|
|
|
1866
1634
|
|
|
1867
1635
|
▸ **parseDate**(`dateString`): `Date`
|
|
1868
1636
|
|
|
1869
|
-
Utility function to parse an arbitrary string into a date.
|
|
1870
|
-
Uses `dayjs(dateString)`.
|
|
1871
|
-
|
|
1872
1637
|
#### Parameters
|
|
1873
1638
|
|
|
1874
1639
|
| Name | Type |
|
|
@@ -1881,7 +1646,7 @@ Uses `dayjs(dateString)`.
|
|
|
1881
1646
|
|
|
1882
1647
|
#### Defined in
|
|
1883
1648
|
|
|
1884
|
-
[packages/framework/esm-utils/src/omrs-dates.ts:136](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
1649
|
+
[packages/framework/esm-utils/src/omrs-dates.ts:136](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/omrs-dates.ts#L136)
|
|
1885
1650
|
|
|
1886
1651
|
___
|
|
1887
1652
|
|
|
@@ -1889,8 +1654,6 @@ ___
|
|
|
1889
1654
|
|
|
1890
1655
|
▸ **toDateObjectStrict**(`omrsDateString`): `Date` \| ``null``
|
|
1891
1656
|
|
|
1892
|
-
Converts the object to a date object if it is a valid ISO date time string.
|
|
1893
|
-
|
|
1894
1657
|
#### Parameters
|
|
1895
1658
|
|
|
1896
1659
|
| Name | Type |
|
|
@@ -1903,7 +1666,7 @@ Converts the object to a date object if it is a valid ISO date time string.
|
|
|
1903
1666
|
|
|
1904
1667
|
#### Defined in
|
|
1905
1668
|
|
|
1906
|
-
[packages/framework/esm-utils/src/omrs-dates.ts:71](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
1669
|
+
[packages/framework/esm-utils/src/omrs-dates.ts:71](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/omrs-dates.ts#L71)
|
|
1907
1670
|
|
|
1908
1671
|
___
|
|
1909
1672
|
|
|
@@ -1911,9 +1674,6 @@ ___
|
|
|
1911
1674
|
|
|
1912
1675
|
▸ **toOmrsDateFormat**(`date`, `format?`): `string`
|
|
1913
1676
|
|
|
1914
|
-
**`deprecated`** use `formatDate(date)`
|
|
1915
|
-
Formats the input as a date string. By default the format "YYYY-MMM-DD" is used.
|
|
1916
|
-
|
|
1917
1677
|
#### Parameters
|
|
1918
1678
|
|
|
1919
1679
|
| Name | Type | Default value |
|
|
@@ -1927,7 +1687,7 @@ Formats the input as a date string. By default the format "YYYY-MMM-DD" is used.
|
|
|
1927
1687
|
|
|
1928
1688
|
#### Defined in
|
|
1929
1689
|
|
|
1930
|
-
[packages/framework/esm-utils/src/omrs-dates.ts:128](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
1690
|
+
[packages/framework/esm-utils/src/omrs-dates.ts:128](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/omrs-dates.ts#L128)
|
|
1931
1691
|
|
|
1932
1692
|
___
|
|
1933
1693
|
|
|
@@ -1935,9 +1695,6 @@ ___
|
|
|
1935
1695
|
|
|
1936
1696
|
▸ **toOmrsDayDateFormat**(`date`): `string`
|
|
1937
1697
|
|
|
1938
|
-
**`deprecated`** use `formatDate(date, "wide")`
|
|
1939
|
-
Formats the input as a date string using the format "DD - MMM - YYYY".
|
|
1940
|
-
|
|
1941
1698
|
#### Parameters
|
|
1942
1699
|
|
|
1943
1700
|
| Name | Type |
|
|
@@ -1950,7 +1707,7 @@ Formats the input as a date string using the format "DD - MMM - YYYY".
|
|
|
1950
1707
|
|
|
1951
1708
|
#### Defined in
|
|
1952
1709
|
|
|
1953
|
-
[packages/framework/esm-utils/src/omrs-dates.ts:112](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
1710
|
+
[packages/framework/esm-utils/src/omrs-dates.ts:112](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/omrs-dates.ts#L112)
|
|
1954
1711
|
|
|
1955
1712
|
___
|
|
1956
1713
|
|
|
@@ -1958,8 +1715,6 @@ ___
|
|
|
1958
1715
|
|
|
1959
1716
|
▸ **toOmrsIsoString**(`date`, `toUTC?`): `string`
|
|
1960
1717
|
|
|
1961
|
-
Formats the input as a date time string using the format "YYYY-MM-DDTHH:mm:ss.SSSZZ".
|
|
1962
|
-
|
|
1963
1718
|
#### Parameters
|
|
1964
1719
|
|
|
1965
1720
|
| Name | Type | Default value |
|
|
@@ -1973,7 +1728,7 @@ Formats the input as a date time string using the format "YYYY-MM-DDTHH:mm:ss.SS
|
|
|
1973
1728
|
|
|
1974
1729
|
#### Defined in
|
|
1975
1730
|
|
|
1976
|
-
[packages/framework/esm-utils/src/omrs-dates.ts:82](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
1731
|
+
[packages/framework/esm-utils/src/omrs-dates.ts:82](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/omrs-dates.ts#L82)
|
|
1977
1732
|
|
|
1978
1733
|
___
|
|
1979
1734
|
|
|
@@ -1981,9 +1736,6 @@ ___
|
|
|
1981
1736
|
|
|
1982
1737
|
▸ **toOmrsTimeString**(`date`): `string`
|
|
1983
1738
|
|
|
1984
|
-
**`deprecated`** use `formatTime`
|
|
1985
|
-
Formats the input as a time string using the format "HH:mm A".
|
|
1986
|
-
|
|
1987
1739
|
#### Parameters
|
|
1988
1740
|
|
|
1989
1741
|
| Name | Type |
|
|
@@ -1996,7 +1748,7 @@ Formats the input as a time string using the format "HH:mm A".
|
|
|
1996
1748
|
|
|
1997
1749
|
#### Defined in
|
|
1998
1750
|
|
|
1999
|
-
[packages/framework/esm-utils/src/omrs-dates.ts:104](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
1751
|
+
[packages/framework/esm-utils/src/omrs-dates.ts:104](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/omrs-dates.ts#L104)
|
|
2000
1752
|
|
|
2001
1753
|
___
|
|
2002
1754
|
|
|
@@ -2004,9 +1756,6 @@ ___
|
|
|
2004
1756
|
|
|
2005
1757
|
▸ **toOmrsTimeString24**(`date`): `string`
|
|
2006
1758
|
|
|
2007
|
-
**`deprecated`** use `formatTime`
|
|
2008
|
-
Formats the input as a time string using the format "HH:mm".
|
|
2009
|
-
|
|
2010
1759
|
#### Parameters
|
|
2011
1760
|
|
|
2012
1761
|
| Name | Type |
|
|
@@ -2019,7 +1768,7 @@ Formats the input as a time string using the format "HH:mm".
|
|
|
2019
1768
|
|
|
2020
1769
|
#### Defined in
|
|
2021
1770
|
|
|
2022
|
-
[packages/framework/esm-utils/src/omrs-dates.ts:96](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
1771
|
+
[packages/framework/esm-utils/src/omrs-dates.ts:96](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/omrs-dates.ts#L96)
|
|
2023
1772
|
|
|
2024
1773
|
___
|
|
2025
1774
|
|
|
@@ -2027,9 +1776,6 @@ ___
|
|
|
2027
1776
|
|
|
2028
1777
|
▸ **toOmrsYearlessDateFormat**(`date`): `string`
|
|
2029
1778
|
|
|
2030
|
-
**`deprecated`** use `formatDate(date, "no year")`
|
|
2031
|
-
Formats the input as a date string using the format "DD-MMM".
|
|
2032
|
-
|
|
2033
1779
|
#### Parameters
|
|
2034
1780
|
|
|
2035
1781
|
| Name | Type |
|
|
@@ -2042,7 +1788,7 @@ Formats the input as a date string using the format "DD-MMM".
|
|
|
2042
1788
|
|
|
2043
1789
|
#### Defined in
|
|
2044
1790
|
|
|
2045
|
-
[packages/framework/esm-utils/src/omrs-dates.ts:120](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
1791
|
+
[packages/framework/esm-utils/src/omrs-dates.ts:120](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/omrs-dates.ts#L120)
|
|
2046
1792
|
|
|
2047
1793
|
___
|
|
2048
1794
|
|
|
@@ -2070,7 +1816,7 @@ ___
|
|
|
2070
1816
|
|
|
2071
1817
|
#### Defined in
|
|
2072
1818
|
|
|
2073
|
-
[packages/framework/esm-error-handling/src/index.ts:24](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
1819
|
+
[packages/framework/esm-error-handling/src/index.ts:24](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-error-handling/src/index.ts#L24)
|
|
2074
1820
|
|
|
2075
1821
|
___
|
|
2076
1822
|
|
|
@@ -2090,7 +1836,7 @@ ___
|
|
|
2090
1836
|
|
|
2091
1837
|
#### Defined in
|
|
2092
1838
|
|
|
2093
|
-
[packages/framework/esm-error-handling/src/index.ts:17](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
1839
|
+
[packages/framework/esm-error-handling/src/index.ts:17](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-error-handling/src/index.ts#L17)
|
|
2094
1840
|
|
|
2095
1841
|
___
|
|
2096
1842
|
|
|
@@ -2100,25 +1846,12 @@ ___
|
|
|
2100
1846
|
|
|
2101
1847
|
▸ **attach**(`slotName`, `extensionId`): `void`
|
|
2102
1848
|
|
|
2103
|
-
Attach an extension to an extension slot.
|
|
2104
|
-
|
|
2105
|
-
This will cause the extension to be rendered into the specified
|
|
2106
|
-
extension slot, unless it is removed by configuration. Using
|
|
2107
|
-
`attach` is an alternative to specifying the `slot` or `slots`
|
|
2108
|
-
in the extension declaration.
|
|
2109
|
-
|
|
2110
|
-
It is particularly useful when creating a slot into which
|
|
2111
|
-
you want to render an existing extension. This enables you
|
|
2112
|
-
to do so without modifying the extension's declaration, which
|
|
2113
|
-
may be impractical or inappropriate, for example if you are
|
|
2114
|
-
writing a module for a specific implementation.
|
|
2115
|
-
|
|
2116
1849
|
#### Parameters
|
|
2117
1850
|
|
|
2118
1851
|
| Name | Type | Description |
|
|
2119
1852
|
| :------ | :------ | :------ |
|
|
2120
|
-
| `slotName` | `string` |
|
|
2121
|
-
| `extensionId` | `string` |
|
|
1853
|
+
| `slotName` | `string` | |
|
|
1854
|
+
| `extensionId` | `string` | |
|
|
2122
1855
|
|
|
2123
1856
|
#### Returns
|
|
2124
1857
|
|
|
@@ -2126,7 +1859,7 @@ writing a module for a specific implementation.
|
|
|
2126
1859
|
|
|
2127
1860
|
#### Defined in
|
|
2128
1861
|
|
|
2129
|
-
[packages/framework/esm-extensions/src/extensions.ts:
|
|
1862
|
+
[packages/framework/esm-extensions/src/extensions.ts:174](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/extensions.ts#L174)
|
|
2130
1863
|
|
|
2131
1864
|
___
|
|
2132
1865
|
|
|
@@ -2134,8 +1867,6 @@ ___
|
|
|
2134
1867
|
|
|
2135
1868
|
▸ **detach**(`extensionSlotName`, `extensionId`): `void`
|
|
2136
1869
|
|
|
2137
|
-
Avoid using this. Extension attachments should be considered declarative.
|
|
2138
|
-
|
|
2139
1870
|
#### Parameters
|
|
2140
1871
|
|
|
2141
1872
|
| Name | Type |
|
|
@@ -2149,7 +1880,7 @@ Avoid using this. Extension attachments should be considered declarative.
|
|
|
2149
1880
|
|
|
2150
1881
|
#### Defined in
|
|
2151
1882
|
|
|
2152
|
-
[packages/framework/esm-extensions/src/extensions.ts:
|
|
1883
|
+
[packages/framework/esm-extensions/src/extensions.ts:205](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/extensions.ts#L205)
|
|
2153
1884
|
|
|
2154
1885
|
___
|
|
2155
1886
|
|
|
@@ -2157,8 +1888,6 @@ ___
|
|
|
2157
1888
|
|
|
2158
1889
|
▸ **detachAll**(`extensionSlotName`): `void`
|
|
2159
1890
|
|
|
2160
|
-
Avoid using this. Extension attachments should be considered declarative.
|
|
2161
|
-
|
|
2162
1891
|
#### Parameters
|
|
2163
1892
|
|
|
2164
1893
|
| Name | Type |
|
|
@@ -2171,7 +1900,7 @@ Avoid using this. Extension attachments should be considered declarative.
|
|
|
2171
1900
|
|
|
2172
1901
|
#### Defined in
|
|
2173
1902
|
|
|
2174
|
-
[packages/framework/esm-extensions/src/extensions.ts:
|
|
1903
|
+
[packages/framework/esm-extensions/src/extensions.ts:229](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/extensions.ts#L229)
|
|
2175
1904
|
|
|
2176
1905
|
___
|
|
2177
1906
|
|
|
@@ -2181,9 +1910,9 @@ ___
|
|
|
2181
1910
|
|
|
2182
1911
|
#### Parameters
|
|
2183
1912
|
|
|
2184
|
-
| Name | Type |
|
|
2185
|
-
| :------ | :------ |
|
|
2186
|
-
| `slotName` | `string` |
|
|
1913
|
+
| Name | Type | Description |
|
|
1914
|
+
| :------ | :------ | :------ |
|
|
1915
|
+
| `slotName` | `string` | |
|
|
2187
1916
|
|
|
2188
1917
|
#### Returns
|
|
2189
1918
|
|
|
@@ -2191,7 +1920,7 @@ ___
|
|
|
2191
1920
|
|
|
2192
1921
|
#### Defined in
|
|
2193
1922
|
|
|
2194
|
-
[packages/framework/esm-extensions/src/extensions.ts:
|
|
1923
|
+
[packages/framework/esm-extensions/src/extensions.ts:359](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/extensions.ts#L359)
|
|
2195
1924
|
|
|
2196
1925
|
___
|
|
2197
1926
|
|
|
@@ -2199,25 +1928,20 @@ ___
|
|
|
2199
1928
|
|
|
2200
1929
|
▸ **getConnectedExtensions**(`assignedExtensions`, `online?`): [`ConnectedExtension`](interfaces/ConnectedExtension.md)[]
|
|
2201
1930
|
|
|
2202
|
-
Filters a list of extensions according to whether they support the
|
|
2203
|
-
current connectivity status.
|
|
2204
|
-
|
|
2205
1931
|
#### Parameters
|
|
2206
1932
|
|
|
2207
1933
|
| Name | Type | Default value | Description |
|
|
2208
1934
|
| :------ | :------ | :------ | :------ |
|
|
2209
|
-
| `assignedExtensions` | [`AssignedExtension`](interfaces/AssignedExtension.md)[] | `undefined` |
|
|
2210
|
-
| `online` | ``null`` \| `boolean` | `null` |
|
|
1935
|
+
| `assignedExtensions` | [`AssignedExtension`](interfaces/AssignedExtension.md)[] | `undefined` | |
|
|
1936
|
+
| `online` | ``null`` \| `boolean` | `null` | |
|
|
2211
1937
|
|
|
2212
1938
|
#### Returns
|
|
2213
1939
|
|
|
2214
1940
|
[`ConnectedExtension`](interfaces/ConnectedExtension.md)[]
|
|
2215
1941
|
|
|
2216
|
-
A list of extensions that should be rendered
|
|
2217
|
-
|
|
2218
1942
|
#### Defined in
|
|
2219
1943
|
|
|
2220
|
-
[packages/framework/esm-extensions/src/extensions.ts:
|
|
1944
|
+
[packages/framework/esm-extensions/src/extensions.ts:287](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/extensions.ts#L287)
|
|
2221
1945
|
|
|
2222
1946
|
___
|
|
2223
1947
|
|
|
@@ -2225,18 +1949,6 @@ ___
|
|
|
2225
1949
|
|
|
2226
1950
|
▸ **getExtensionNameFromId**(`extensionId`): `string`
|
|
2227
1951
|
|
|
2228
|
-
Given an extension ID, which is a string uniquely identifying
|
|
2229
|
-
an instance of an extension within an extension slot, this
|
|
2230
|
-
returns the extension name.
|
|
2231
|
-
|
|
2232
|
-
**`example`**
|
|
2233
|
-
```js
|
|
2234
|
-
getExtensionNameFromId("foo#bar")
|
|
2235
|
-
--> "foo"
|
|
2236
|
-
getExtensionNameFromId("baz")
|
|
2237
|
-
--> "baz"
|
|
2238
|
-
```
|
|
2239
|
-
|
|
2240
1952
|
#### Parameters
|
|
2241
1953
|
|
|
2242
1954
|
| Name | Type |
|
|
@@ -2249,17 +1961,13 @@ getExtensionNameFromId("baz")
|
|
|
2249
1961
|
|
|
2250
1962
|
#### Defined in
|
|
2251
1963
|
|
|
2252
|
-
[packages/framework/esm-extensions/src/extensions.ts:
|
|
1964
|
+
[packages/framework/esm-extensions/src/extensions.ts:118](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/extensions.ts#L118)
|
|
2253
1965
|
|
|
2254
1966
|
___
|
|
2255
1967
|
|
|
2256
1968
|
### getExtensionStore
|
|
2257
1969
|
|
|
2258
|
-
▸
|
|
2259
|
-
|
|
2260
|
-
This returns a [store](https://github.com/developit/unistore#store)
|
|
2261
|
-
that modules can use to get information about the state of the
|
|
2262
|
-
extension system.
|
|
1970
|
+
▸ **getExtensionStore**(): `Store`<[`ExtensionStore`](interfaces/ExtensionStore.md)\>
|
|
2263
1971
|
|
|
2264
1972
|
#### Returns
|
|
2265
1973
|
|
|
@@ -2267,17 +1975,13 @@ extension system.
|
|
|
2267
1975
|
|
|
2268
1976
|
#### Defined in
|
|
2269
1977
|
|
|
2270
|
-
[packages/framework/esm-extensions/src/store.ts:
|
|
1978
|
+
[packages/framework/esm-extensions/src/store.ts:130](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L130)
|
|
2271
1979
|
|
|
2272
1980
|
___
|
|
2273
1981
|
|
|
2274
1982
|
### renderExtension
|
|
2275
1983
|
|
|
2276
|
-
▸ **renderExtension**(`domElement`, `extensionSlotName`, `extensionSlotModuleName`, `extensionId`, `renderFunction?`, `additionalProps?`):
|
|
2277
|
-
|
|
2278
|
-
Mounts into a DOM node (representing an extension slot)
|
|
2279
|
-
a lazy-loaded component from *any* frontend module
|
|
2280
|
-
that registered an extension component for this slot.
|
|
1984
|
+
▸ **renderExtension**(`domElement`, `extensionSlotName`, `extensionSlotModuleName`, `extensionId`, `renderFunction?`, `additionalProps?`): `Parcel` \| ``null``
|
|
2281
1985
|
|
|
2282
1986
|
#### Parameters
|
|
2283
1987
|
|
|
@@ -2292,11 +1996,11 @@ that registered an extension component for this slot.
|
|
|
2292
1996
|
|
|
2293
1997
|
#### Returns
|
|
2294
1998
|
|
|
2295
|
-
|
|
1999
|
+
`Parcel` \| ``null``
|
|
2296
2000
|
|
|
2297
2001
|
#### Defined in
|
|
2298
2002
|
|
|
2299
|
-
[packages/framework/esm-extensions/src/render.ts:17](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
2003
|
+
[packages/framework/esm-extensions/src/render.ts:17](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/render.ts#L17)
|
|
2300
2004
|
|
|
2301
2005
|
___
|
|
2302
2006
|
|
|
@@ -2304,16 +2008,11 @@ ___
|
|
|
2304
2008
|
|
|
2305
2009
|
▸ **useAssignedExtensionIds**(`slotName`): `string`[]
|
|
2306
2010
|
|
|
2307
|
-
Gets the assigned extension ids for a given extension slot name.
|
|
2308
|
-
Does not consider if offline or online.
|
|
2309
|
-
|
|
2310
|
-
**`deprecated`** Use `useAssignedExtensions`
|
|
2311
|
-
|
|
2312
2011
|
#### Parameters
|
|
2313
2012
|
|
|
2314
2013
|
| Name | Type | Description |
|
|
2315
2014
|
| :------ | :------ | :------ |
|
|
2316
|
-
| `slotName` | `string` |
|
|
2015
|
+
| `slotName` | `string` | |
|
|
2317
2016
|
|
|
2318
2017
|
#### Returns
|
|
2319
2018
|
|
|
@@ -2321,7 +2020,7 @@ Does not consider if offline or online.
|
|
|
2321
2020
|
|
|
2322
2021
|
#### Defined in
|
|
2323
2022
|
|
|
2324
|
-
[packages/framework/esm-react-utils/src/useAssignedExtensionIds.ts:13](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
2023
|
+
[packages/framework/esm-react-utils/src/useAssignedExtensionIds.ts:13](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useAssignedExtensionIds.ts#L13)
|
|
2325
2024
|
|
|
2326
2025
|
___
|
|
2327
2026
|
|
|
@@ -2329,14 +2028,11 @@ ___
|
|
|
2329
2028
|
|
|
2330
2029
|
▸ **useAssignedExtensions**(`slotName`): [`AssignedExtension`](interfaces/AssignedExtension.md)[]
|
|
2331
2030
|
|
|
2332
|
-
Gets the assigned extensions for a given extension slot name.
|
|
2333
|
-
Does not consider if offline or online.
|
|
2334
|
-
|
|
2335
2031
|
#### Parameters
|
|
2336
2032
|
|
|
2337
2033
|
| Name | Type | Description |
|
|
2338
2034
|
| :------ | :------ | :------ |
|
|
2339
|
-
| `slotName` | `string` |
|
|
2035
|
+
| `slotName` | `string` | |
|
|
2340
2036
|
|
|
2341
2037
|
#### Returns
|
|
2342
2038
|
|
|
@@ -2344,7 +2040,7 @@ Does not consider if offline or online.
|
|
|
2344
2040
|
|
|
2345
2041
|
#### Defined in
|
|
2346
2042
|
|
|
2347
|
-
[packages/framework/esm-react-utils/src/useAssignedExtensions.ts:15](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
2043
|
+
[packages/framework/esm-react-utils/src/useAssignedExtensions.ts:15](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useAssignedExtensions.ts#L15)
|
|
2348
2044
|
|
|
2349
2045
|
___
|
|
2350
2046
|
|
|
@@ -2352,14 +2048,11 @@ ___
|
|
|
2352
2048
|
|
|
2353
2049
|
▸ **useConnectedExtensions**(`slotName`): [`ConnectedExtension`](interfaces/ConnectedExtension.md)[]
|
|
2354
2050
|
|
|
2355
|
-
Gets the assigned extension for a given extension slot name.
|
|
2356
|
-
Considers if offline or online.
|
|
2357
|
-
|
|
2358
2051
|
#### Parameters
|
|
2359
2052
|
|
|
2360
2053
|
| Name | Type | Description |
|
|
2361
2054
|
| :------ | :------ | :------ |
|
|
2362
|
-
| `slotName` | `string` |
|
|
2055
|
+
| `slotName` | `string` | |
|
|
2363
2056
|
|
|
2364
2057
|
#### Returns
|
|
2365
2058
|
|
|
@@ -2367,7 +2060,7 @@ Considers if offline or online.
|
|
|
2367
2060
|
|
|
2368
2061
|
#### Defined in
|
|
2369
2062
|
|
|
2370
|
-
[packages/framework/esm-react-utils/src/useConnectedExtensions.ts:15](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
2063
|
+
[packages/framework/esm-react-utils/src/useConnectedExtensions.ts:15](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useConnectedExtensions.ts#L15)
|
|
2371
2064
|
|
|
2372
2065
|
___
|
|
2373
2066
|
|
|
@@ -2375,8 +2068,6 @@ ___
|
|
|
2375
2068
|
|
|
2376
2069
|
▸ **useExtensionSlotMeta**<`T`\>(`extensionSlotName`): `Object`
|
|
2377
2070
|
|
|
2378
|
-
Extract meta data from all extension for a given extension slot.
|
|
2379
|
-
|
|
2380
2071
|
#### Type parameters
|
|
2381
2072
|
|
|
2382
2073
|
| Name | Type |
|
|
@@ -2385,9 +2076,9 @@ Extract meta data from all extension for a given extension slot.
|
|
|
2385
2076
|
|
|
2386
2077
|
#### Parameters
|
|
2387
2078
|
|
|
2388
|
-
| Name | Type |
|
|
2389
|
-
| :------ | :------ |
|
|
2390
|
-
| `extensionSlotName` | `string` |
|
|
2079
|
+
| Name | Type | Description |
|
|
2080
|
+
| :------ | :------ | :------ |
|
|
2081
|
+
| `extensionSlotName` | `string` | |
|
|
2391
2082
|
|
|
2392
2083
|
#### Returns
|
|
2393
2084
|
|
|
@@ -2395,13 +2086,13 @@ Extract meta data from all extension for a given extension slot.
|
|
|
2395
2086
|
|
|
2396
2087
|
#### Defined in
|
|
2397
2088
|
|
|
2398
|
-
[packages/framework/esm-react-utils/src/useExtensionSlotMeta.ts:10](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
2089
|
+
[packages/framework/esm-react-utils/src/useExtensionSlotMeta.ts:10](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useExtensionSlotMeta.ts#L10)
|
|
2399
2090
|
|
|
2400
2091
|
___
|
|
2401
2092
|
|
|
2402
2093
|
### useExtensionStore
|
|
2403
2094
|
|
|
2404
|
-
▸
|
|
2095
|
+
▸ **useExtensionStore**(): `T`
|
|
2405
2096
|
|
|
2406
2097
|
#### Returns
|
|
2407
2098
|
|
|
@@ -2409,9 +2100,9 @@ ___
|
|
|
2409
2100
|
|
|
2410
2101
|
#### Defined in
|
|
2411
2102
|
|
|
2412
|
-
[packages/framework/esm-react-utils/src/useExtensionStore.ts:5](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
2103
|
+
[packages/framework/esm-react-utils/src/useExtensionStore.ts:5](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useExtensionStore.ts#L5)
|
|
2413
2104
|
|
|
2414
|
-
▸
|
|
2105
|
+
▸ **useExtensionStore**(`actions`): `T` & [`BoundActions`](API.md#boundactions)
|
|
2415
2106
|
|
|
2416
2107
|
#### Parameters
|
|
2417
2108
|
|
|
@@ -2425,9 +2116,9 @@ ___
|
|
|
2425
2116
|
|
|
2426
2117
|
#### Defined in
|
|
2427
2118
|
|
|
2428
|
-
[packages/framework/esm-react-utils/src/useExtensionStore.ts:5](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
2119
|
+
[packages/framework/esm-react-utils/src/useExtensionStore.ts:5](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useExtensionStore.ts#L5)
|
|
2429
2120
|
|
|
2430
|
-
▸
|
|
2121
|
+
▸ **useExtensionStore**(`actions?`): `T` & [`BoundActions`](API.md#boundactions)
|
|
2431
2122
|
|
|
2432
2123
|
#### Parameters
|
|
2433
2124
|
|
|
@@ -2441,7 +2132,7 @@ ___
|
|
|
2441
2132
|
|
|
2442
2133
|
#### Defined in
|
|
2443
2134
|
|
|
2444
|
-
[packages/framework/esm-react-utils/src/useExtensionStore.ts:5](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
2135
|
+
[packages/framework/esm-react-utils/src/useExtensionStore.ts:5](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useExtensionStore.ts#L5)
|
|
2445
2136
|
|
|
2446
2137
|
___
|
|
2447
2138
|
|
|
@@ -2449,9 +2140,7 @@ ___
|
|
|
2449
2140
|
|
|
2450
2141
|
### getAsyncExtensionLifecycle
|
|
2451
2142
|
|
|
2452
|
-
▸
|
|
2453
|
-
|
|
2454
|
-
**`deprecated`** Use getAsyncLifecycle instead.
|
|
2143
|
+
▸ **getAsyncExtensionLifecycle**<`T`\>(`lazy`, `options`): () => `Promise`<`ReactAppOrParcel`<`any`\>\>
|
|
2455
2144
|
|
|
2456
2145
|
#### Type parameters
|
|
2457
2146
|
|
|
@@ -2478,7 +2167,7 @@ ___
|
|
|
2478
2167
|
|
|
2479
2168
|
#### Defined in
|
|
2480
2169
|
|
|
2481
|
-
[packages/framework/esm-react-utils/src/getLifecycle.ts:39](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
2170
|
+
[packages/framework/esm-react-utils/src/getLifecycle.ts:39](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/getLifecycle.ts#L39)
|
|
2482
2171
|
|
|
2483
2172
|
___
|
|
2484
2173
|
|
|
@@ -2511,7 +2200,7 @@ ___
|
|
|
2511
2200
|
|
|
2512
2201
|
#### Defined in
|
|
2513
2202
|
|
|
2514
|
-
[packages/framework/esm-react-utils/src/getLifecycle.ts:21](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
2203
|
+
[packages/framework/esm-react-utils/src/getLifecycle.ts:21](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/getLifecycle.ts#L21)
|
|
2515
2204
|
|
|
2516
2205
|
___
|
|
2517
2206
|
|
|
@@ -2538,7 +2227,7 @@ ___
|
|
|
2538
2227
|
|
|
2539
2228
|
#### Defined in
|
|
2540
2229
|
|
|
2541
|
-
[packages/framework/esm-react-utils/src/getLifecycle.ts:10](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
2230
|
+
[packages/framework/esm-react-utils/src/getLifecycle.ts:10](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/getLifecycle.ts#L10)
|
|
2542
2231
|
|
|
2543
2232
|
___
|
|
2544
2233
|
|
|
@@ -2571,36 +2260,42 @@ ___
|
|
|
2571
2260
|
|
|
2572
2261
|
#### Defined in
|
|
2573
2262
|
|
|
2574
|
-
[packages/framework/esm-react-utils/src/getLifecycle.ts:29](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
2263
|
+
[packages/framework/esm-react-utils/src/getLifecycle.ts:29](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/getLifecycle.ts#L29)
|
|
2575
2264
|
|
|
2576
2265
|
___
|
|
2577
2266
|
|
|
2578
2267
|
## Navigation Functions
|
|
2579
2268
|
|
|
2580
|
-
###
|
|
2269
|
+
### ConfigurableLink
|
|
2581
2270
|
|
|
2582
|
-
▸ **
|
|
2271
|
+
▸ **ConfigurableLink**(`__namedParameters`): `Element`
|
|
2272
|
+
|
|
2273
|
+
#### Parameters
|
|
2274
|
+
|
|
2275
|
+
| Name | Type |
|
|
2276
|
+
| :------ | :------ |
|
|
2277
|
+
| `__namedParameters` | [`ConfigurableLinkProps`](interfaces/ConfigurableLinkProps.md) |
|
|
2278
|
+
|
|
2279
|
+
#### Returns
|
|
2280
|
+
|
|
2281
|
+
`Element`
|
|
2282
|
+
|
|
2283
|
+
#### Defined in
|
|
2583
2284
|
|
|
2584
|
-
|
|
2285
|
+
[packages/framework/esm-react-utils/src/ConfigurableLink.tsx:38](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/ConfigurableLink.tsx#L38)
|
|
2585
2286
|
|
|
2586
|
-
|
|
2287
|
+
___
|
|
2288
|
+
|
|
2289
|
+
### interpolateString
|
|
2587
2290
|
|
|
2588
|
-
|
|
2589
|
-
```js
|
|
2590
|
-
navigate({
|
|
2591
|
-
to: interpolateString(
|
|
2592
|
-
config.links.patientChart,
|
|
2593
|
-
{ patientUuid: patient.uuid }
|
|
2594
|
-
)
|
|
2595
|
-
});
|
|
2596
|
-
```
|
|
2291
|
+
▸ **interpolateString**(`template`, `params`): `string`
|
|
2597
2292
|
|
|
2598
2293
|
#### Parameters
|
|
2599
2294
|
|
|
2600
2295
|
| Name | Type | Description |
|
|
2601
2296
|
| :------ | :------ | :------ |
|
|
2602
|
-
| `template` | `string` |
|
|
2603
|
-
| `params` | `
|
|
2297
|
+
| `template` | `string` | |
|
|
2298
|
+
| `params` | `Object` | |
|
|
2604
2299
|
|
|
2605
2300
|
#### Returns
|
|
2606
2301
|
|
|
@@ -2608,24 +2303,20 @@ navigate({
|
|
|
2608
2303
|
|
|
2609
2304
|
#### Defined in
|
|
2610
2305
|
|
|
2611
|
-
[packages/framework/esm-config/src/navigation/interpolate-string.ts:
|
|
2306
|
+
[packages/framework/esm-config/src/navigation/interpolate-string.ts:63](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/navigation/interpolate-string.ts#L63)
|
|
2612
2307
|
|
|
2613
2308
|
___
|
|
2614
2309
|
|
|
2615
2310
|
### interpolateUrl
|
|
2616
2311
|
|
|
2617
|
-
▸ **interpolateUrl**(`template`): `string`
|
|
2618
|
-
|
|
2619
|
-
Interpolates a string with openmrsBase and openmrsSpaBase.
|
|
2620
|
-
|
|
2621
|
-
Useful for accepting `${openmrsBase}` or `${openmrsSpaBase}` template
|
|
2622
|
-
parameters in configurable URLs.
|
|
2312
|
+
▸ **interpolateUrl**(`template`, `additionalParams?`): `string`
|
|
2623
2313
|
|
|
2624
2314
|
#### Parameters
|
|
2625
2315
|
|
|
2626
2316
|
| Name | Type | Description |
|
|
2627
2317
|
| :------ | :------ | :------ |
|
|
2628
|
-
| `template` | `string` |
|
|
2318
|
+
| `template` | `string` | |
|
|
2319
|
+
| `additionalParams?` | `Object` | |
|
|
2629
2320
|
|
|
2630
2321
|
#### Returns
|
|
2631
2322
|
|
|
@@ -2633,7 +2324,7 @@ parameters in configurable URLs.
|
|
|
2633
2324
|
|
|
2634
2325
|
#### Defined in
|
|
2635
2326
|
|
|
2636
|
-
[packages/framework/esm-config/src/navigation/interpolate-string.ts:
|
|
2327
|
+
[packages/framework/esm-config/src/navigation/interpolate-string.ts:36](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/navigation/interpolate-string.ts#L36)
|
|
2637
2328
|
|
|
2638
2329
|
___
|
|
2639
2330
|
|
|
@@ -2641,21 +2332,11 @@ ___
|
|
|
2641
2332
|
|
|
2642
2333
|
▸ **navigate**(`to`): `void`
|
|
2643
2334
|
|
|
2644
|
-
Calls `location.assign` for non-SPA paths and [navigateToUrl](https://single-spa.js.org/docs/api/#navigatetourl) for SPA paths
|
|
2645
|
-
|
|
2646
|
-
Example usage:
|
|
2647
|
-
```js
|
|
2648
|
-
const config = getConfig();
|
|
2649
|
-
const submitHandler = () => {
|
|
2650
|
-
navigate({ to: config.links.submitSuccess });
|
|
2651
|
-
};
|
|
2652
|
-
```
|
|
2653
|
-
|
|
2654
2335
|
#### Parameters
|
|
2655
2336
|
|
|
2656
2337
|
| Name | Type | Description |
|
|
2657
2338
|
| :------ | :------ | :------ |
|
|
2658
|
-
| `to` | [`NavigateOptions`](interfaces/NavigateOptions.md) |
|
|
2339
|
+
| `to` | [`NavigateOptions`](interfaces/NavigateOptions.md) | |
|
|
2659
2340
|
|
|
2660
2341
|
#### Returns
|
|
2661
2342
|
|
|
@@ -2663,7 +2344,7 @@ const submitHandler = () => {
|
|
|
2663
2344
|
|
|
2664
2345
|
#### Defined in
|
|
2665
2346
|
|
|
2666
|
-
[packages/framework/esm-config/src/navigation/navigate.ts:
|
|
2347
|
+
[packages/framework/esm-config/src/navigation/navigate.ts:42](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/navigation/navigate.ts#L42)
|
|
2667
2348
|
|
|
2668
2349
|
___
|
|
2669
2350
|
|
|
@@ -2673,14 +2354,11 @@ ___
|
|
|
2673
2354
|
|
|
2674
2355
|
▸ **beginEditSynchronizationItem**(`id`): `Promise`<`void`\>
|
|
2675
2356
|
|
|
2676
|
-
Triggers an edit flow for the given synchronization item.
|
|
2677
|
-
If this is not possible, throws an error.
|
|
2678
|
-
|
|
2679
2357
|
#### Parameters
|
|
2680
2358
|
|
|
2681
2359
|
| Name | Type | Description |
|
|
2682
2360
|
| :------ | :------ | :------ |
|
|
2683
|
-
| `id` | `number` |
|
|
2361
|
+
| `id` | `number` | |
|
|
2684
2362
|
|
|
2685
2363
|
#### Returns
|
|
2686
2364
|
|
|
@@ -2688,7 +2366,7 @@ If this is not possible, throws an error.
|
|
|
2688
2366
|
|
|
2689
2367
|
#### Defined in
|
|
2690
2368
|
|
|
2691
|
-
[packages/framework/esm-offline/src/sync.ts:
|
|
2369
|
+
[packages/framework/esm-offline/src/sync.ts:357](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/sync.ts#L357)
|
|
2692
2370
|
|
|
2693
2371
|
___
|
|
2694
2372
|
|
|
@@ -2696,14 +2374,11 @@ ___
|
|
|
2696
2374
|
|
|
2697
2375
|
▸ **canBeginEditSynchronizationItemsOfType**(`type`): `boolean`
|
|
2698
2376
|
|
|
2699
|
-
Returns whether editing synchronization items of the given type is supported by the currently
|
|
2700
|
-
registered synchronization handlers.
|
|
2701
|
-
|
|
2702
2377
|
#### Parameters
|
|
2703
2378
|
|
|
2704
2379
|
| Name | Type | Description |
|
|
2705
2380
|
| :------ | :------ | :------ |
|
|
2706
|
-
| `type` | `string` |
|
|
2381
|
+
| `type` | `string` | |
|
|
2707
2382
|
|
|
2708
2383
|
#### Returns
|
|
2709
2384
|
|
|
@@ -2711,7 +2386,7 @@ registered synchronization handlers.
|
|
|
2711
2386
|
|
|
2712
2387
|
#### Defined in
|
|
2713
2388
|
|
|
2714
|
-
[packages/framework/esm-offline/src/sync.ts:
|
|
2389
|
+
[packages/framework/esm-offline/src/sync.ts:347](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/sync.ts#L347)
|
|
2715
2390
|
|
|
2716
2391
|
___
|
|
2717
2392
|
|
|
@@ -2719,13 +2394,11 @@ ___
|
|
|
2719
2394
|
|
|
2720
2395
|
▸ **deleteSynchronizationItem**(`id`): `Promise`<`void`\>
|
|
2721
2396
|
|
|
2722
|
-
Deletes a queued up sync item with the given ID.
|
|
2723
|
-
|
|
2724
2397
|
#### Parameters
|
|
2725
2398
|
|
|
2726
2399
|
| Name | Type | Description |
|
|
2727
2400
|
| :------ | :------ | :------ |
|
|
2728
|
-
| `id` | `number` |
|
|
2401
|
+
| `id` | `number` | |
|
|
2729
2402
|
|
|
2730
2403
|
#### Returns
|
|
2731
2404
|
|
|
@@ -2733,7 +2406,7 @@ Deletes a queued up sync item with the given ID.
|
|
|
2733
2406
|
|
|
2734
2407
|
#### Defined in
|
|
2735
2408
|
|
|
2736
|
-
[packages/framework/esm-offline/src/sync.ts:
|
|
2409
|
+
[packages/framework/esm-offline/src/sync.ts:377](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/sync.ts#L377)
|
|
2737
2410
|
|
|
2738
2411
|
___
|
|
2739
2412
|
|
|
@@ -2741,15 +2414,13 @@ ___
|
|
|
2741
2414
|
|
|
2742
2415
|
▸ **generateOfflineUuid**(): `string`
|
|
2743
2416
|
|
|
2744
|
-
Generates a UUID-like string which is used for uniquely identifying objects while offline.
|
|
2745
|
-
|
|
2746
2417
|
#### Returns
|
|
2747
2418
|
|
|
2748
2419
|
`string`
|
|
2749
2420
|
|
|
2750
2421
|
#### Defined in
|
|
2751
2422
|
|
|
2752
|
-
[packages/framework/esm-offline/src/uuid.ts:7](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
2423
|
+
[packages/framework/esm-offline/src/uuid.ts:7](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/uuid.ts#L7)
|
|
2753
2424
|
|
|
2754
2425
|
___
|
|
2755
2426
|
|
|
@@ -2763,7 +2434,62 @@ ___
|
|
|
2763
2434
|
|
|
2764
2435
|
#### Defined in
|
|
2765
2436
|
|
|
2766
|
-
[packages/framework/esm-offline/src/mode.ts:49](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
2437
|
+
[packages/framework/esm-offline/src/mode.ts:49](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/mode.ts#L49)
|
|
2438
|
+
|
|
2439
|
+
___
|
|
2440
|
+
|
|
2441
|
+
### getDynamicOfflineDataEntries
|
|
2442
|
+
|
|
2443
|
+
▸ **getDynamicOfflineDataEntries**(`type?`): `Promise`<[`DynamicOfflineData`](interfaces/DynamicOfflineData.md)[]\>
|
|
2444
|
+
|
|
2445
|
+
#### Parameters
|
|
2446
|
+
|
|
2447
|
+
| Name | Type | Description |
|
|
2448
|
+
| :------ | :------ | :------ |
|
|
2449
|
+
| `type?` | `string` | |
|
|
2450
|
+
|
|
2451
|
+
#### Returns
|
|
2452
|
+
|
|
2453
|
+
`Promise`<[`DynamicOfflineData`](interfaces/DynamicOfflineData.md)[]\>
|
|
2454
|
+
|
|
2455
|
+
#### Defined in
|
|
2456
|
+
|
|
2457
|
+
[packages/framework/esm-offline/src/dynamic-offline-data.ts:131](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L131)
|
|
2458
|
+
|
|
2459
|
+
___
|
|
2460
|
+
|
|
2461
|
+
### getDynamicOfflineDataEntriesFor
|
|
2462
|
+
|
|
2463
|
+
▸ **getDynamicOfflineDataEntriesFor**(`userId`, `type?`): `Promise`<[`DynamicOfflineData`](interfaces/DynamicOfflineData.md)[]\>
|
|
2464
|
+
|
|
2465
|
+
#### Parameters
|
|
2466
|
+
|
|
2467
|
+
| Name | Type | Description |
|
|
2468
|
+
| :------ | :------ | :------ |
|
|
2469
|
+
| `userId` | `string` | |
|
|
2470
|
+
| `type?` | `string` | |
|
|
2471
|
+
|
|
2472
|
+
#### Returns
|
|
2473
|
+
|
|
2474
|
+
`Promise`<[`DynamicOfflineData`](interfaces/DynamicOfflineData.md)[]\>
|
|
2475
|
+
|
|
2476
|
+
#### Defined in
|
|
2477
|
+
|
|
2478
|
+
[packages/framework/esm-offline/src/dynamic-offline-data.ts:144](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L144)
|
|
2479
|
+
|
|
2480
|
+
___
|
|
2481
|
+
|
|
2482
|
+
### getDynamicOfflineDataHandlers
|
|
2483
|
+
|
|
2484
|
+
▸ **getDynamicOfflineDataHandlers**(): [`DynamicOfflineDataHandler`](interfaces/DynamicOfflineDataHandler.md)[]
|
|
2485
|
+
|
|
2486
|
+
#### Returns
|
|
2487
|
+
|
|
2488
|
+
[`DynamicOfflineDataHandler`](interfaces/DynamicOfflineDataHandler.md)[]
|
|
2489
|
+
|
|
2490
|
+
#### Defined in
|
|
2491
|
+
|
|
2492
|
+
[packages/framework/esm-offline/src/dynamic-offline-data.ts:105](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L105)
|
|
2767
2493
|
|
|
2768
2494
|
___
|
|
2769
2495
|
|
|
@@ -2771,8 +2497,6 @@ ___
|
|
|
2771
2497
|
|
|
2772
2498
|
▸ **getFullSynchronizationItems**<`T`\>(`type?`): `Promise`<[`SyncItem`](interfaces/SyncItem.md)<`T`\>[]\>
|
|
2773
2499
|
|
|
2774
|
-
Returns all currently queued up sync items of the currently signed in user.
|
|
2775
|
-
|
|
2776
2500
|
#### Type parameters
|
|
2777
2501
|
|
|
2778
2502
|
| Name |
|
|
@@ -2783,7 +2507,7 @@ Returns all currently queued up sync items of the currently signed in user.
|
|
|
2783
2507
|
|
|
2784
2508
|
| Name | Type | Description |
|
|
2785
2509
|
| :------ | :------ | :------ |
|
|
2786
|
-
| `type?` | `string` |
|
|
2510
|
+
| `type?` | `string` | |
|
|
2787
2511
|
|
|
2788
2512
|
#### Returns
|
|
2789
2513
|
|
|
@@ -2791,7 +2515,7 @@ Returns all currently queued up sync items of the currently signed in user.
|
|
|
2791
2515
|
|
|
2792
2516
|
#### Defined in
|
|
2793
2517
|
|
|
2794
|
-
[packages/framework/esm-offline/src/sync.ts:
|
|
2518
|
+
[packages/framework/esm-offline/src/sync.ts:325](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/sync.ts#L325)
|
|
2795
2519
|
|
|
2796
2520
|
___
|
|
2797
2521
|
|
|
@@ -2799,8 +2523,6 @@ ___
|
|
|
2799
2523
|
|
|
2800
2524
|
▸ **getFullSynchronizationItemsFor**<`T`\>(`userId`, `type?`): `Promise`<[`SyncItem`](interfaces/SyncItem.md)<`T`\>[]\>
|
|
2801
2525
|
|
|
2802
|
-
Returns all currently queued up sync items of a given user.
|
|
2803
|
-
|
|
2804
2526
|
#### Type parameters
|
|
2805
2527
|
|
|
2806
2528
|
| Name |
|
|
@@ -2811,8 +2533,8 @@ Returns all currently queued up sync items of a given user.
|
|
|
2811
2533
|
|
|
2812
2534
|
| Name | Type | Description |
|
|
2813
2535
|
| :------ | :------ | :------ |
|
|
2814
|
-
| `userId` | `string` |
|
|
2815
|
-
| `type?` | `string` |
|
|
2536
|
+
| `userId` | `string` | |
|
|
2537
|
+
| `type?` | `string` | |
|
|
2816
2538
|
|
|
2817
2539
|
#### Returns
|
|
2818
2540
|
|
|
@@ -2820,7 +2542,7 @@ Returns all currently queued up sync items of a given user.
|
|
|
2820
2542
|
|
|
2821
2543
|
#### Defined in
|
|
2822
2544
|
|
|
2823
|
-
[packages/framework/esm-offline/src/sync.ts:
|
|
2545
|
+
[packages/framework/esm-offline/src/sync.ts:301](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/sync.ts#L301)
|
|
2824
2546
|
|
|
2825
2547
|
___
|
|
2826
2548
|
|
|
@@ -2834,7 +2556,7 @@ ___
|
|
|
2834
2556
|
|
|
2835
2557
|
#### Defined in
|
|
2836
2558
|
|
|
2837
|
-
[packages/framework/esm-offline/src/offline-patient-data.ts:
|
|
2559
|
+
[packages/framework/esm-offline/src/offline-patient-data.ts:45](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/offline-patient-data.ts#L45)
|
|
2838
2560
|
|
|
2839
2561
|
___
|
|
2840
2562
|
|
|
@@ -2842,8 +2564,6 @@ ___
|
|
|
2842
2564
|
|
|
2843
2565
|
▸ **getSynchronizationItem**<`T`\>(`id`): `Promise`<[`SyncItem`](interfaces/SyncItem.md)<`T`\> \| `undefined`\>
|
|
2844
2566
|
|
|
2845
|
-
Returns a queued sync item with the given ID or `undefined` if no such item exists.
|
|
2846
|
-
|
|
2847
2567
|
#### Type parameters
|
|
2848
2568
|
|
|
2849
2569
|
| Name | Type |
|
|
@@ -2854,7 +2574,7 @@ Returns a queued sync item with the given ID or `undefined` if no such item exis
|
|
|
2854
2574
|
|
|
2855
2575
|
| Name | Type | Description |
|
|
2856
2576
|
| :------ | :------ | :------ |
|
|
2857
|
-
| `id` | `number` |
|
|
2577
|
+
| `id` | `number` | |
|
|
2858
2578
|
|
|
2859
2579
|
#### Returns
|
|
2860
2580
|
|
|
@@ -2862,7 +2582,7 @@ Returns a queued sync item with the given ID or `undefined` if no such item exis
|
|
|
2862
2582
|
|
|
2863
2583
|
#### Defined in
|
|
2864
2584
|
|
|
2865
|
-
[packages/framework/esm-offline/src/sync.ts:
|
|
2585
|
+
[packages/framework/esm-offline/src/sync.ts:334](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/sync.ts#L334)
|
|
2866
2586
|
|
|
2867
2587
|
___
|
|
2868
2588
|
|
|
@@ -2870,8 +2590,6 @@ ___
|
|
|
2870
2590
|
|
|
2871
2591
|
▸ **getSynchronizationItems**<`T`\>(`type?`): `Promise`<`T`[]\>
|
|
2872
2592
|
|
|
2873
|
-
Returns the content of all currently queued up sync items of the currently signed in user.
|
|
2874
|
-
|
|
2875
2593
|
#### Type parameters
|
|
2876
2594
|
|
|
2877
2595
|
| Name |
|
|
@@ -2882,7 +2600,7 @@ Returns the content of all currently queued up sync items of the currently signe
|
|
|
2882
2600
|
|
|
2883
2601
|
| Name | Type | Description |
|
|
2884
2602
|
| :------ | :------ | :------ |
|
|
2885
|
-
| `type?` | `string` |
|
|
2603
|
+
| `type?` | `string` | |
|
|
2886
2604
|
|
|
2887
2605
|
#### Returns
|
|
2888
2606
|
|
|
@@ -2890,7 +2608,7 @@ Returns the content of all currently queued up sync items of the currently signe
|
|
|
2890
2608
|
|
|
2891
2609
|
#### Defined in
|
|
2892
2610
|
|
|
2893
|
-
[packages/framework/esm-offline/src/sync.ts:
|
|
2611
|
+
[packages/framework/esm-offline/src/sync.ts:316](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/sync.ts#L316)
|
|
2894
2612
|
|
|
2895
2613
|
___
|
|
2896
2614
|
|
|
@@ -2898,8 +2616,6 @@ ___
|
|
|
2898
2616
|
|
|
2899
2617
|
▸ **isOfflineUuid**(`uuid`): `boolean`
|
|
2900
2618
|
|
|
2901
|
-
Checks whether the given string has the format of an offline UUID generated by [generateOfflineUuid](API.md#generateofflineuuid)
|
|
2902
|
-
|
|
2903
2619
|
#### Parameters
|
|
2904
2620
|
|
|
2905
2621
|
| Name | Type |
|
|
@@ -2912,13 +2628,40 @@ Checks whether the given string has the format of an offline UUID generated by [
|
|
|
2912
2628
|
|
|
2913
2629
|
#### Defined in
|
|
2914
2630
|
|
|
2915
|
-
[packages/framework/esm-offline/src/uuid.ts:12](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
2631
|
+
[packages/framework/esm-offline/src/uuid.ts:12](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/uuid.ts#L12)
|
|
2632
|
+
|
|
2633
|
+
___
|
|
2634
|
+
|
|
2635
|
+
### messageOmrsServiceWorker
|
|
2636
|
+
|
|
2637
|
+
▸ **messageOmrsServiceWorker**(`message`): `Promise`<[`MessageServiceWorkerResult`](interfaces/MessageServiceWorkerResult.md)<`any`\>\>
|
|
2638
|
+
|
|
2639
|
+
#### Parameters
|
|
2640
|
+
|
|
2641
|
+
| Name | Type | Description |
|
|
2642
|
+
| :------ | :------ | :------ |
|
|
2643
|
+
| `message` | [`KnownOmrsServiceWorkerMessages`](API.md#knownomrsserviceworkermessages) | |
|
|
2644
|
+
|
|
2645
|
+
#### Returns
|
|
2646
|
+
|
|
2647
|
+
`Promise`<[`MessageServiceWorkerResult`](interfaces/MessageServiceWorkerResult.md)<`any`\>\>
|
|
2648
|
+
|
|
2649
|
+
#### Defined in
|
|
2650
|
+
|
|
2651
|
+
[packages/framework/esm-offline/src/service-worker-messaging.ts:11](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/service-worker-messaging.ts#L11)
|
|
2916
2652
|
|
|
2917
2653
|
___
|
|
2918
2654
|
|
|
2919
|
-
###
|
|
2655
|
+
### putDynamicOfflineData
|
|
2920
2656
|
|
|
2921
|
-
▸ **
|
|
2657
|
+
▸ **putDynamicOfflineData**(`type`, `identifier`): `Promise`<`void`\>
|
|
2658
|
+
|
|
2659
|
+
#### Parameters
|
|
2660
|
+
|
|
2661
|
+
| Name | Type | Description |
|
|
2662
|
+
| :------ | :------ | :------ |
|
|
2663
|
+
| `type` | `string` | |
|
|
2664
|
+
| `identifier` | `string` | |
|
|
2922
2665
|
|
|
2923
2666
|
#### Returns
|
|
2924
2667
|
|
|
@@ -2926,31 +2669,29 @@ ___
|
|
|
2926
2669
|
|
|
2927
2670
|
#### Defined in
|
|
2928
2671
|
|
|
2929
|
-
[packages/framework/esm-offline/src/offline-
|
|
2672
|
+
[packages/framework/esm-offline/src/dynamic-offline-data.ts:162](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L162)
|
|
2930
2673
|
|
|
2931
2674
|
___
|
|
2932
2675
|
|
|
2933
|
-
###
|
|
2676
|
+
### putDynamicOfflineDataFor
|
|
2934
2677
|
|
|
2935
|
-
▸ **
|
|
2936
|
-
|
|
2937
|
-
Sends the specified message to the application's service worker.
|
|
2678
|
+
▸ **putDynamicOfflineDataFor**(`userId`, `type`, `identifier`): `Promise`<`void`\>
|
|
2938
2679
|
|
|
2939
2680
|
#### Parameters
|
|
2940
2681
|
|
|
2941
2682
|
| Name | Type | Description |
|
|
2942
2683
|
| :------ | :------ | :------ |
|
|
2943
|
-
| `
|
|
2684
|
+
| `userId` | `string` | |
|
|
2685
|
+
| `type` | `string` | |
|
|
2686
|
+
| `identifier` | `string` | |
|
|
2944
2687
|
|
|
2945
2688
|
#### Returns
|
|
2946
2689
|
|
|
2947
|
-
`Promise
|
|
2948
|
-
|
|
2949
|
-
A promise which completes when the message has been successfully processed by the Service Worker.
|
|
2690
|
+
`Promise`<`void`\>
|
|
2950
2691
|
|
|
2951
2692
|
#### Defined in
|
|
2952
2693
|
|
|
2953
|
-
[packages/framework/esm-offline/src/
|
|
2694
|
+
[packages/framework/esm-offline/src/dynamic-offline-data.ts:177](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L177)
|
|
2954
2695
|
|
|
2955
2696
|
___
|
|
2956
2697
|
|
|
@@ -2958,8 +2699,6 @@ ___
|
|
|
2958
2699
|
|
|
2959
2700
|
▸ **queueSynchronizationItem**<`T`\>(`type`, `content`, `descriptor?`): `Promise`<`number`\>
|
|
2960
2701
|
|
|
2961
|
-
Enqueues a new item in the sync queue and associates the item with the currently signed in user.
|
|
2962
|
-
|
|
2963
2702
|
#### Type parameters
|
|
2964
2703
|
|
|
2965
2704
|
| Name |
|
|
@@ -2970,9 +2709,9 @@ Enqueues a new item in the sync queue and associates the item with the currently
|
|
|
2970
2709
|
|
|
2971
2710
|
| Name | Type | Description |
|
|
2972
2711
|
| :------ | :------ | :------ |
|
|
2973
|
-
| `type` | `string` |
|
|
2974
|
-
| `content` | `T` |
|
|
2975
|
-
| `descriptor?` | [`QueueItemDescriptor`](interfaces/QueueItemDescriptor.md) |
|
|
2712
|
+
| `type` | `string` | |
|
|
2713
|
+
| `content` | `T` | |
|
|
2714
|
+
| `descriptor?` | [`QueueItemDescriptor`](interfaces/QueueItemDescriptor.md) | |
|
|
2976
2715
|
|
|
2977
2716
|
#### Returns
|
|
2978
2717
|
|
|
@@ -2980,7 +2719,7 @@ Enqueues a new item in the sync queue and associates the item with the currently
|
|
|
2980
2719
|
|
|
2981
2720
|
#### Defined in
|
|
2982
2721
|
|
|
2983
|
-
[packages/framework/esm-offline/src/sync.ts:
|
|
2722
|
+
[packages/framework/esm-offline/src/sync.ts:274](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/sync.ts#L274)
|
|
2984
2723
|
|
|
2985
2724
|
___
|
|
2986
2725
|
|
|
@@ -2988,25 +2727,83 @@ ___
|
|
|
2988
2727
|
|
|
2989
2728
|
▸ **registerOfflinePatientHandler**(`identifier`, `handler`): `void`
|
|
2990
2729
|
|
|
2991
|
-
|
|
2730
|
+
#### Parameters
|
|
2731
|
+
|
|
2732
|
+
| Name | Type |
|
|
2733
|
+
| :------ | :------ |
|
|
2734
|
+
| `identifier` | `string` |
|
|
2735
|
+
| `handler` | [`OfflinePatientDataSyncHandler`](interfaces/OfflinePatientDataSyncHandler.md) |
|
|
2736
|
+
|
|
2737
|
+
#### Returns
|
|
2738
|
+
|
|
2739
|
+
`void`
|
|
2740
|
+
|
|
2741
|
+
#### Defined in
|
|
2742
|
+
|
|
2743
|
+
[packages/framework/esm-offline/src/offline-patient-data.ts:51](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/offline-patient-data.ts#L51)
|
|
2744
|
+
|
|
2745
|
+
___
|
|
2746
|
+
|
|
2747
|
+
### removeDynamicOfflineData
|
|
2748
|
+
|
|
2749
|
+
▸ **removeDynamicOfflineData**(`type`, `identifier`): `Promise`<`void`\>
|
|
2992
2750
|
|
|
2993
2751
|
#### Parameters
|
|
2994
2752
|
|
|
2995
2753
|
| Name | Type | Description |
|
|
2996
2754
|
| :------ | :------ | :------ |
|
|
2997
|
-
| `
|
|
2998
|
-
| `
|
|
2755
|
+
| `type` | `string` | |
|
|
2756
|
+
| `identifier` | `string` | |
|
|
2999
2757
|
|
|
3000
2758
|
#### Returns
|
|
3001
2759
|
|
|
3002
|
-
`void
|
|
2760
|
+
`Promise`<`void`\>
|
|
2761
|
+
|
|
2762
|
+
#### Defined in
|
|
2763
|
+
|
|
2764
|
+
[packages/framework/esm-offline/src/dynamic-offline-data.ts:213](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L213)
|
|
2765
|
+
|
|
2766
|
+
___
|
|
3003
2767
|
|
|
3004
|
-
|
|
3005
|
-
|
|
2768
|
+
### removeDynamicOfflineDataFor
|
|
2769
|
+
|
|
2770
|
+
▸ **removeDynamicOfflineDataFor**(`userId`, `type`, `identifier`): `Promise`<`void`\>
|
|
2771
|
+
|
|
2772
|
+
#### Parameters
|
|
2773
|
+
|
|
2774
|
+
| Name | Type | Description |
|
|
2775
|
+
| :------ | :------ | :------ |
|
|
2776
|
+
| `userId` | `string` | |
|
|
2777
|
+
| `type` | `string` | |
|
|
2778
|
+
| `identifier` | `string` | |
|
|
2779
|
+
|
|
2780
|
+
#### Returns
|
|
2781
|
+
|
|
2782
|
+
`Promise`<`void`\>
|
|
3006
2783
|
|
|
3007
2784
|
#### Defined in
|
|
3008
2785
|
|
|
3009
|
-
[packages/framework/esm-offline/src/offline-
|
|
2786
|
+
[packages/framework/esm-offline/src/dynamic-offline-data.ts:228](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L228)
|
|
2787
|
+
|
|
2788
|
+
___
|
|
2789
|
+
|
|
2790
|
+
### setupDynamicOfflineDataHandler
|
|
2791
|
+
|
|
2792
|
+
▸ **setupDynamicOfflineDataHandler**(`handler`): `void`
|
|
2793
|
+
|
|
2794
|
+
#### Parameters
|
|
2795
|
+
|
|
2796
|
+
| Name | Type | Description |
|
|
2797
|
+
| :------ | :------ | :------ |
|
|
2798
|
+
| `handler` | [`DynamicOfflineDataHandler`](interfaces/DynamicOfflineDataHandler.md) | |
|
|
2799
|
+
|
|
2800
|
+
#### Returns
|
|
2801
|
+
|
|
2802
|
+
`void`
|
|
2803
|
+
|
|
2804
|
+
#### Defined in
|
|
2805
|
+
|
|
2806
|
+
[packages/framework/esm-offline/src/dynamic-offline-data.ts:114](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L114)
|
|
3010
2807
|
|
|
3011
2808
|
___
|
|
3012
2809
|
|
|
@@ -3014,8 +2811,6 @@ ___
|
|
|
3014
2811
|
|
|
3015
2812
|
▸ **setupOfflineSync**<`T`\>(`type`, `dependsOn`, `process`, `options?`): `void`
|
|
3016
2813
|
|
|
3017
|
-
Registers a new synchronization handler which is able to synchronize data of a specific type.
|
|
3018
|
-
|
|
3019
2814
|
#### Type parameters
|
|
3020
2815
|
|
|
3021
2816
|
| Name |
|
|
@@ -3026,10 +2821,10 @@ Registers a new synchronization handler which is able to synchronize data of a s
|
|
|
3026
2821
|
|
|
3027
2822
|
| Name | Type | Description |
|
|
3028
2823
|
| :------ | :------ | :------ |
|
|
3029
|
-
| `type` | `string` |
|
|
3030
|
-
| `dependsOn` | `string`[] |
|
|
3031
|
-
| `process` | `ProcessSyncItem`<`T`\> |
|
|
3032
|
-
| `options` | `SetupOfflineSyncOptions`<`T`\> |
|
|
2824
|
+
| `type` | `string` | |
|
|
2825
|
+
| `dependsOn` | `string`[] | |
|
|
2826
|
+
| `process` | `ProcessSyncItem`<`T`\> | |
|
|
2827
|
+
| `options` | `SetupOfflineSyncOptions`<`T`\> | |
|
|
3033
2828
|
|
|
3034
2829
|
#### Returns
|
|
3035
2830
|
|
|
@@ -3037,7 +2832,7 @@ Registers a new synchronization handler which is able to synchronize data of a s
|
|
|
3037
2832
|
|
|
3038
2833
|
#### Defined in
|
|
3039
2834
|
|
|
3040
|
-
[packages/framework/esm-offline/src/sync.ts:
|
|
2835
|
+
[packages/framework/esm-offline/src/sync.ts:392](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/sync.ts#L392)
|
|
3041
2836
|
|
|
3042
2837
|
___
|
|
3043
2838
|
|
|
@@ -3063,7 +2858,7 @@ ___
|
|
|
3063
2858
|
|
|
3064
2859
|
#### Defined in
|
|
3065
2860
|
|
|
3066
|
-
[packages/framework/esm-globals/src/events.ts:24](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
2861
|
+
[packages/framework/esm-globals/src/events.ts:24](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/events.ts#L24)
|
|
3067
2862
|
|
|
3068
2863
|
___
|
|
3069
2864
|
|
|
@@ -3089,7 +2884,7 @@ ___
|
|
|
3089
2884
|
|
|
3090
2885
|
#### Defined in
|
|
3091
2886
|
|
|
3092
|
-
[packages/framework/esm-globals/src/events.ts:14](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
2887
|
+
[packages/framework/esm-globals/src/events.ts:14](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/events.ts#L14)
|
|
3093
2888
|
|
|
3094
2889
|
___
|
|
3095
2890
|
|
|
@@ -3115,7 +2910,50 @@ ___
|
|
|
3115
2910
|
|
|
3116
2911
|
#### Defined in
|
|
3117
2912
|
|
|
3118
|
-
[packages/framework/esm-globals/src/events.ts:45](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
2913
|
+
[packages/framework/esm-globals/src/events.ts:45](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/events.ts#L45)
|
|
2914
|
+
|
|
2915
|
+
___
|
|
2916
|
+
|
|
2917
|
+
### syncAllDynamicOfflineData
|
|
2918
|
+
|
|
2919
|
+
▸ **syncAllDynamicOfflineData**(`type`, `abortSignal?`): `Promise`<`void`\>
|
|
2920
|
+
|
|
2921
|
+
#### Parameters
|
|
2922
|
+
|
|
2923
|
+
| Name | Type | Description |
|
|
2924
|
+
| :------ | :------ | :------ |
|
|
2925
|
+
| `type` | `string` | |
|
|
2926
|
+
| `abortSignal?` | `AbortSignal` | |
|
|
2927
|
+
|
|
2928
|
+
#### Returns
|
|
2929
|
+
|
|
2930
|
+
`Promise`<`void`\>
|
|
2931
|
+
|
|
2932
|
+
#### Defined in
|
|
2933
|
+
|
|
2934
|
+
[packages/framework/esm-offline/src/dynamic-offline-data.ts:262](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L262)
|
|
2935
|
+
|
|
2936
|
+
___
|
|
2937
|
+
|
|
2938
|
+
### syncDynamicOfflineData
|
|
2939
|
+
|
|
2940
|
+
▸ **syncDynamicOfflineData**(`type`, `identifier`, `abortSignal?`): `Promise`<`void`\>
|
|
2941
|
+
|
|
2942
|
+
#### Parameters
|
|
2943
|
+
|
|
2944
|
+
| Name | Type | Description |
|
|
2945
|
+
| :------ | :------ | :------ |
|
|
2946
|
+
| `type` | `string` | |
|
|
2947
|
+
| `identifier` | `string` | |
|
|
2948
|
+
| `abortSignal?` | `AbortSignal` | |
|
|
2949
|
+
|
|
2950
|
+
#### Returns
|
|
2951
|
+
|
|
2952
|
+
`Promise`<`void`\>
|
|
2953
|
+
|
|
2954
|
+
#### Defined in
|
|
2955
|
+
|
|
2956
|
+
[packages/framework/esm-offline/src/dynamic-offline-data.ts:280](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L280)
|
|
3119
2957
|
|
|
3120
2958
|
___
|
|
3121
2959
|
|
|
@@ -3123,8 +2961,6 @@ ___
|
|
|
3123
2961
|
|
|
3124
2962
|
▸ **syncOfflinePatientData**(`patientUuid`): `Promise`<`void`\>
|
|
3125
2963
|
|
|
3126
|
-
Notifies all registered offline patient handlers that a new patient must be made available offline.
|
|
3127
|
-
|
|
3128
2964
|
#### Parameters
|
|
3129
2965
|
|
|
3130
2966
|
| Name | Type |
|
|
@@ -3135,11 +2971,9 @@ Notifies all registered offline patient handlers that a new patient must be made
|
|
|
3135
2971
|
|
|
3136
2972
|
`Promise`<`void`\>
|
|
3137
2973
|
|
|
3138
|
-
A promise which resolves once all registered handlers have finished synchronizing.
|
|
3139
|
-
|
|
3140
2974
|
#### Defined in
|
|
3141
2975
|
|
|
3142
|
-
[packages/framework/esm-offline/src/offline-patient-data.ts:
|
|
2976
|
+
[packages/framework/esm-offline/src/offline-patient-data.ts:71](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/offline-patient-data.ts#L71)
|
|
3143
2977
|
|
|
3144
2978
|
___
|
|
3145
2979
|
|
|
@@ -3153,7 +2987,29 @@ ___
|
|
|
3153
2987
|
|
|
3154
2988
|
#### Defined in
|
|
3155
2989
|
|
|
3156
|
-
[packages/framework/esm-react-utils/src/useConnectivity.ts:5](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
2990
|
+
[packages/framework/esm-react-utils/src/useConnectivity.ts:5](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useConnectivity.ts#L5)
|
|
2991
|
+
|
|
2992
|
+
___
|
|
2993
|
+
|
|
2994
|
+
## Other Functions
|
|
2995
|
+
|
|
2996
|
+
### ExtensionSlot
|
|
2997
|
+
|
|
2998
|
+
▸ **ExtensionSlot**(`__namedParameters`): `Element`
|
|
2999
|
+
|
|
3000
|
+
#### Parameters
|
|
3001
|
+
|
|
3002
|
+
| Name | Type |
|
|
3003
|
+
| :------ | :------ |
|
|
3004
|
+
| `__namedParameters` | [`ExtensionSlotProps`](API.md#extensionslotprops) |
|
|
3005
|
+
|
|
3006
|
+
#### Returns
|
|
3007
|
+
|
|
3008
|
+
`Element`
|
|
3009
|
+
|
|
3010
|
+
#### Defined in
|
|
3011
|
+
|
|
3012
|
+
[packages/framework/esm-react-utils/src/ExtensionSlot.tsx:85](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/ExtensionSlot.tsx#L85)
|
|
3157
3013
|
|
|
3158
3014
|
___
|
|
3159
3015
|
|
|
@@ -3163,8 +3019,6 @@ ___
|
|
|
3163
3019
|
|
|
3164
3020
|
▸ **createGlobalStore**<`TState`\>(`name`, `initialState`): `Store`<`TState`\>
|
|
3165
3021
|
|
|
3166
|
-
Creates a Unistore [store](https://github.com/developit/unistore#store).
|
|
3167
|
-
|
|
3168
3022
|
#### Type parameters
|
|
3169
3023
|
|
|
3170
3024
|
| Name |
|
|
@@ -3175,18 +3029,16 @@ Creates a Unistore [store](https://github.com/developit/unistore#store).
|
|
|
3175
3029
|
|
|
3176
3030
|
| Name | Type | Description |
|
|
3177
3031
|
| :------ | :------ | :------ |
|
|
3178
|
-
| `name` | `string` |
|
|
3179
|
-
| `initialState` | `TState` |
|
|
3032
|
+
| `name` | `string` | |
|
|
3033
|
+
| `initialState` | `TState` | |
|
|
3180
3034
|
|
|
3181
3035
|
#### Returns
|
|
3182
3036
|
|
|
3183
3037
|
`Store`<`TState`\>
|
|
3184
3038
|
|
|
3185
|
-
The newly created store.
|
|
3186
|
-
|
|
3187
3039
|
#### Defined in
|
|
3188
3040
|
|
|
3189
|
-
[packages/framework/esm-state/src/state.ts:19](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
3041
|
+
[packages/framework/esm-state/src/state.ts:19](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-state/src/state.ts#L19)
|
|
3190
3042
|
|
|
3191
3043
|
___
|
|
3192
3044
|
|
|
@@ -3194,8 +3046,6 @@ ___
|
|
|
3194
3046
|
|
|
3195
3047
|
▸ **createUseStore**<`T`\>(`store`): () => `T`(`actions`: [`Actions`](API.md#actions)) => `T` & [`BoundActions`](API.md#boundactions)(`actions?`: [`Actions`](API.md#actions)) => `T` & [`BoundActions`](API.md#boundactions)
|
|
3196
3048
|
|
|
3197
|
-
Avoid this; generally prefer to have clients use `useStore(yourStore)`
|
|
3198
|
-
|
|
3199
3049
|
#### Type parameters
|
|
3200
3050
|
|
|
3201
3051
|
| Name |
|
|
@@ -3244,7 +3094,7 @@ Avoid this; generally prefer to have clients use `useStore(yourStore)`
|
|
|
3244
3094
|
|
|
3245
3095
|
#### Defined in
|
|
3246
3096
|
|
|
3247
|
-
[packages/framework/esm-react-utils/src/createUseStore.ts:23](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
3097
|
+
[packages/framework/esm-react-utils/src/createUseStore.ts:23](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/createUseStore.ts#L23)
|
|
3248
3098
|
|
|
3249
3099
|
___
|
|
3250
3100
|
|
|
@@ -3256,11 +3106,9 @@ ___
|
|
|
3256
3106
|
|
|
3257
3107
|
`Store`<[`AppState`](interfaces/AppState.md)\>
|
|
3258
3108
|
|
|
3259
|
-
The [store](https://github.com/developit/unistore#store) named `app`.
|
|
3260
|
-
|
|
3261
3109
|
#### Defined in
|
|
3262
3110
|
|
|
3263
|
-
[packages/framework/esm-state/src/state.ts:86](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
3111
|
+
[packages/framework/esm-state/src/state.ts:86](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-state/src/state.ts#L86)
|
|
3264
3112
|
|
|
3265
3113
|
___
|
|
3266
3114
|
|
|
@@ -3268,9 +3116,6 @@ ___
|
|
|
3268
3116
|
|
|
3269
3117
|
▸ **getGlobalStore**<`TState`\>(`name`, `fallbackState?`): `Store`<`TState`\>
|
|
3270
3118
|
|
|
3271
|
-
Returns the existing [store](https://github.com/developit/unistore#store) named `name`,
|
|
3272
|
-
or creates a new store named `name` if none exists.
|
|
3273
|
-
|
|
3274
3119
|
#### Type parameters
|
|
3275
3120
|
|
|
3276
3121
|
| Name | Type |
|
|
@@ -3281,18 +3126,16 @@ or creates a new store named `name` if none exists.
|
|
|
3281
3126
|
|
|
3282
3127
|
| Name | Type | Description |
|
|
3283
3128
|
| :------ | :------ | :------ |
|
|
3284
|
-
| `name` | `string` |
|
|
3285
|
-
| `fallbackState?` | `TState` |
|
|
3129
|
+
| `name` | `string` | |
|
|
3130
|
+
| `fallbackState?` | `TState` | |
|
|
3286
3131
|
|
|
3287
3132
|
#### Returns
|
|
3288
3133
|
|
|
3289
3134
|
`Store`<`TState`\>
|
|
3290
3135
|
|
|
3291
|
-
The found or newly created store.
|
|
3292
|
-
|
|
3293
3136
|
#### Defined in
|
|
3294
3137
|
|
|
3295
|
-
[packages/framework/esm-state/src/state.ts:56](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
3138
|
+
[packages/framework/esm-state/src/state.ts:56](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-state/src/state.ts#L56)
|
|
3296
3139
|
|
|
3297
3140
|
___
|
|
3298
3141
|
|
|
@@ -3321,7 +3164,7 @@ ___
|
|
|
3321
3164
|
|
|
3322
3165
|
#### Defined in
|
|
3323
3166
|
|
|
3324
|
-
[packages/framework/esm-state/src/state.ts:90](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
3167
|
+
[packages/framework/esm-state/src/state.ts:90](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-state/src/state.ts#L90)
|
|
3325
3168
|
|
|
3326
3169
|
___
|
|
3327
3170
|
|
|
@@ -3348,7 +3191,7 @@ ___
|
|
|
3348
3191
|
|
|
3349
3192
|
#### Defined in
|
|
3350
3193
|
|
|
3351
|
-
[packages/framework/esm-react-utils/src/useStore.ts:23](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
3194
|
+
[packages/framework/esm-react-utils/src/useStore.ts:23](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useStore.ts#L23)
|
|
3352
3195
|
|
|
3353
3196
|
▸ **useStore**<`T`, `U`\>(`store`, `select`): `U`
|
|
3354
3197
|
|
|
@@ -3372,7 +3215,7 @@ ___
|
|
|
3372
3215
|
|
|
3373
3216
|
#### Defined in
|
|
3374
3217
|
|
|
3375
|
-
[packages/framework/esm-react-utils/src/useStore.ts:24](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
3218
|
+
[packages/framework/esm-react-utils/src/useStore.ts:24](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useStore.ts#L24)
|
|
3376
3219
|
|
|
3377
3220
|
▸ **useStore**<`T`, `U`\>(`store`, `select`, `actions`): `T` & [`BoundActions`](API.md#boundactions)
|
|
3378
3221
|
|
|
@@ -3397,7 +3240,7 @@ ___
|
|
|
3397
3240
|
|
|
3398
3241
|
#### Defined in
|
|
3399
3242
|
|
|
3400
|
-
[packages/framework/esm-react-utils/src/useStore.ts:25](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
3243
|
+
[packages/framework/esm-react-utils/src/useStore.ts:25](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useStore.ts#L25)
|
|
3401
3244
|
|
|
3402
3245
|
▸ **useStore**<`T`, `U`\>(`store`, `select`, `actions`): `U` & [`BoundActions`](API.md#boundactions)
|
|
3403
3246
|
|
|
@@ -3422,7 +3265,7 @@ ___
|
|
|
3422
3265
|
|
|
3423
3266
|
#### Defined in
|
|
3424
3267
|
|
|
3425
|
-
[packages/framework/esm-react-utils/src/useStore.ts:30](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
3268
|
+
[packages/framework/esm-react-utils/src/useStore.ts:30](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useStore.ts#L30)
|
|
3426
3269
|
|
|
3427
3270
|
___
|
|
3428
3271
|
|
|
@@ -3449,12 +3292,32 @@ ___
|
|
|
3449
3292
|
|
|
3450
3293
|
#### Defined in
|
|
3451
3294
|
|
|
3452
|
-
[packages/framework/esm-react-utils/src/useStore.ts:52](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
3295
|
+
[packages/framework/esm-react-utils/src/useStore.ts:52](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useStore.ts#L52)
|
|
3453
3296
|
|
|
3454
3297
|
___
|
|
3455
3298
|
|
|
3456
3299
|
## UI Functions
|
|
3457
3300
|
|
|
3301
|
+
### isDesktop
|
|
3302
|
+
|
|
3303
|
+
▸ **isDesktop**(`layout`): `boolean`
|
|
3304
|
+
|
|
3305
|
+
#### Parameters
|
|
3306
|
+
|
|
3307
|
+
| Name | Type |
|
|
3308
|
+
| :------ | :------ |
|
|
3309
|
+
| `layout` | [`LayoutType`](API.md#layouttype) |
|
|
3310
|
+
|
|
3311
|
+
#### Returns
|
|
3312
|
+
|
|
3313
|
+
`boolean`
|
|
3314
|
+
|
|
3315
|
+
#### Defined in
|
|
3316
|
+
|
|
3317
|
+
[packages/framework/esm-react-utils/src/useLayoutType.ts:40](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useLayoutType.ts#L40)
|
|
3318
|
+
|
|
3319
|
+
___
|
|
3320
|
+
|
|
3458
3321
|
### setLeftNav
|
|
3459
3322
|
|
|
3460
3323
|
▸ **setLeftNav**(`__namedParameters`): `void`
|
|
@@ -3471,7 +3334,7 @@ ___
|
|
|
3471
3334
|
|
|
3472
3335
|
#### Defined in
|
|
3473
3336
|
|
|
3474
|
-
[packages/framework/esm-styleguide/src/left-nav/index.tsx:18](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
3337
|
+
[packages/framework/esm-styleguide/src/left-nav/index.tsx:18](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/left-nav/index.tsx#L18)
|
|
3475
3338
|
|
|
3476
3339
|
___
|
|
3477
3340
|
|
|
@@ -3479,22 +3342,18 @@ ___
|
|
|
3479
3342
|
|
|
3480
3343
|
▸ **showModal**(`extensionId`, `props?`, `onClose?`): () => `void`
|
|
3481
3344
|
|
|
3482
|
-
Shows the provided extension component in a modal dialog.
|
|
3483
|
-
|
|
3484
3345
|
#### Parameters
|
|
3485
3346
|
|
|
3486
3347
|
| Name | Type | Description |
|
|
3487
3348
|
| :------ | :------ | :------ |
|
|
3488
|
-
| `extensionId` | `string` |
|
|
3489
|
-
| `props` | `Record`<`string`, `any`\> |
|
|
3490
|
-
| `onClose` | () => `void` |
|
|
3349
|
+
| `extensionId` | `string` | |
|
|
3350
|
+
| `props` | `Record`<`string`, `any`\> | |
|
|
3351
|
+
| `onClose` | () => `void` | |
|
|
3491
3352
|
|
|
3492
3353
|
#### Returns
|
|
3493
3354
|
|
|
3494
3355
|
`fn`
|
|
3495
3356
|
|
|
3496
|
-
The dispose function to force closing the modal dialog.
|
|
3497
|
-
|
|
3498
3357
|
▸ (): `void`
|
|
3499
3358
|
|
|
3500
3359
|
##### Returns
|
|
@@ -3503,7 +3362,7 @@ The dispose function to force closing the modal dialog.
|
|
|
3503
3362
|
|
|
3504
3363
|
#### Defined in
|
|
3505
3364
|
|
|
3506
|
-
[packages/framework/esm-styleguide/src/modals/index.tsx:
|
|
3365
|
+
[packages/framework/esm-styleguide/src/modals/index.tsx:165](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/modals/index.tsx#L165)
|
|
3507
3366
|
|
|
3508
3367
|
___
|
|
3509
3368
|
|
|
@@ -3511,13 +3370,11 @@ ___
|
|
|
3511
3370
|
|
|
3512
3371
|
▸ **showNotification**(`notification`): `void`
|
|
3513
3372
|
|
|
3514
|
-
Displays an inline notification in the UI.
|
|
3515
|
-
|
|
3516
3373
|
#### Parameters
|
|
3517
3374
|
|
|
3518
3375
|
| Name | Type | Description |
|
|
3519
3376
|
| :------ | :------ | :------ |
|
|
3520
|
-
| `notification` | [`NotificationDescriptor`](interfaces/NotificationDescriptor.md) |
|
|
3377
|
+
| `notification` | [`NotificationDescriptor`](interfaces/NotificationDescriptor.md) | |
|
|
3521
3378
|
|
|
3522
3379
|
#### Returns
|
|
3523
3380
|
|
|
@@ -3525,7 +3382,7 @@ Displays an inline notification in the UI.
|
|
|
3525
3382
|
|
|
3526
3383
|
#### Defined in
|
|
3527
3384
|
|
|
3528
|
-
[packages/framework/esm-styleguide/src/notifications/index.tsx:
|
|
3385
|
+
[packages/framework/esm-styleguide/src/notifications/index.tsx:40](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/notifications/index.tsx#L40)
|
|
3529
3386
|
|
|
3530
3387
|
___
|
|
3531
3388
|
|
|
@@ -3533,13 +3390,11 @@ ___
|
|
|
3533
3390
|
|
|
3534
3391
|
▸ **showToast**(`toast`): `void`
|
|
3535
3392
|
|
|
3536
|
-
Displays a toast notification in the UI.
|
|
3537
|
-
|
|
3538
3393
|
#### Parameters
|
|
3539
3394
|
|
|
3540
3395
|
| Name | Type | Description |
|
|
3541
3396
|
| :------ | :------ | :------ |
|
|
3542
|
-
| `toast` | [`ToastDescriptor`](interfaces/ToastDescriptor.md) |
|
|
3397
|
+
| `toast` | [`ToastDescriptor`](interfaces/ToastDescriptor.md) | |
|
|
3543
3398
|
|
|
3544
3399
|
#### Returns
|
|
3545
3400
|
|
|
@@ -3547,7 +3402,7 @@ Displays a toast notification in the UI.
|
|
|
3547
3402
|
|
|
3548
3403
|
#### Defined in
|
|
3549
3404
|
|
|
3550
|
-
[packages/framework/esm-styleguide/src/toasts/index.tsx:
|
|
3405
|
+
[packages/framework/esm-styleguide/src/toasts/index.tsx:36](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/toasts/index.tsx#L36)
|
|
3551
3406
|
|
|
3552
3407
|
___
|
|
3553
3408
|
|
|
@@ -3573,7 +3428,7 @@ ___
|
|
|
3573
3428
|
|
|
3574
3429
|
#### Defined in
|
|
3575
3430
|
|
|
3576
|
-
[packages/framework/esm-globals/src/events.ts:93](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
3431
|
+
[packages/framework/esm-globals/src/events.ts:93](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/events.ts#L93)
|
|
3577
3432
|
|
|
3578
3433
|
___
|
|
3579
3434
|
|
|
@@ -3599,7 +3454,7 @@ ___
|
|
|
3599
3454
|
|
|
3600
3455
|
#### Defined in
|
|
3601
3456
|
|
|
3602
|
-
[packages/framework/esm-globals/src/events.ts:102](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
3457
|
+
[packages/framework/esm-globals/src/events.ts:102](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/events.ts#L102)
|
|
3603
3458
|
|
|
3604
3459
|
___
|
|
3605
3460
|
|
|
@@ -3619,7 +3474,7 @@ ___
|
|
|
3619
3474
|
|
|
3620
3475
|
#### Defined in
|
|
3621
3476
|
|
|
3622
|
-
[packages/framework/esm-styleguide/src/left-nav/index.tsx:22](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
3477
|
+
[packages/framework/esm-styleguide/src/left-nav/index.tsx:22](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/left-nav/index.tsx#L22)
|
|
3623
3478
|
|
|
3624
3479
|
___
|
|
3625
3480
|
|
|
@@ -3639,7 +3494,7 @@ ___
|
|
|
3639
3494
|
|
|
3640
3495
|
#### Defined in
|
|
3641
3496
|
|
|
3642
|
-
[packages/framework/esm-react-utils/src/useBodyScrollLock.ts:4](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
3497
|
+
[packages/framework/esm-react-utils/src/useBodyScrollLock.ts:4](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useBodyScrollLock.ts#L4)
|
|
3643
3498
|
|
|
3644
3499
|
___
|
|
3645
3500
|
|
|
@@ -3653,7 +3508,7 @@ ___
|
|
|
3653
3508
|
|
|
3654
3509
|
#### Defined in
|
|
3655
3510
|
|
|
3656
|
-
[packages/framework/esm-react-utils/src/useLayoutType.ts:
|
|
3511
|
+
[packages/framework/esm-react-utils/src/useLayoutType.ts:26](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useLayoutType.ts#L26)
|
|
3657
3512
|
|
|
3658
3513
|
___
|
|
3659
3514
|
|
|
@@ -3680,7 +3535,7 @@ ___
|
|
|
3680
3535
|
|
|
3681
3536
|
#### Defined in
|
|
3682
3537
|
|
|
3683
|
-
[packages/framework/esm-react-utils/src/useOnClickOutside.tsx:4](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
3538
|
+
[packages/framework/esm-react-utils/src/useOnClickOutside.tsx:4](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useOnClickOutside.tsx#L4)
|
|
3684
3539
|
|
|
3685
3540
|
___
|
|
3686
3541
|
|
|
@@ -3719,7 +3574,7 @@ ___
|
|
|
3719
3574
|
|
|
3720
3575
|
#### Defined in
|
|
3721
3576
|
|
|
3722
|
-
[packages/framework/esm-react-utils/src/usePagination.ts:6](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
3577
|
+
[packages/framework/esm-react-utils/src/usePagination.ts:6](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/usePagination.ts#L6)
|
|
3723
3578
|
|
|
3724
3579
|
___
|
|
3725
3580
|
|
|
@@ -3729,23 +3584,19 @@ ___
|
|
|
3729
3584
|
|
|
3730
3585
|
▸ **age**(`dateString`): `string`
|
|
3731
3586
|
|
|
3732
|
-
Gets a human readable age represention of the provided date string.
|
|
3733
|
-
|
|
3734
3587
|
#### Parameters
|
|
3735
3588
|
|
|
3736
3589
|
| Name | Type | Description |
|
|
3737
3590
|
| :------ | :------ | :------ |
|
|
3738
|
-
| `dateString` | `string` |
|
|
3591
|
+
| `dateString` | `string` | |
|
|
3739
3592
|
|
|
3740
3593
|
#### Returns
|
|
3741
3594
|
|
|
3742
3595
|
`string`
|
|
3743
3596
|
|
|
3744
|
-
A human-readable string version of the age.
|
|
3745
|
-
|
|
3746
3597
|
#### Defined in
|
|
3747
3598
|
|
|
3748
|
-
[packages/framework/esm-utils/src/age-helpers.tsx:39](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
3599
|
+
[packages/framework/esm-utils/src/age-helpers.tsx:39](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/age-helpers.tsx#L39)
|
|
3749
3600
|
|
|
3750
3601
|
___
|
|
3751
3602
|
|
|
@@ -3753,23 +3604,19 @@ ___
|
|
|
3753
3604
|
|
|
3754
3605
|
▸ **daysIntoYear**(`date`): `number`
|
|
3755
3606
|
|
|
3756
|
-
Gets the number of days in the year of the given date.
|
|
3757
|
-
|
|
3758
3607
|
#### Parameters
|
|
3759
3608
|
|
|
3760
3609
|
| Name | Type | Description |
|
|
3761
3610
|
| :------ | :------ | :------ |
|
|
3762
|
-
| `date` | `Date` |
|
|
3611
|
+
| `date` | `Date` | |
|
|
3763
3612
|
|
|
3764
3613
|
#### Returns
|
|
3765
3614
|
|
|
3766
3615
|
`number`
|
|
3767
3616
|
|
|
3768
|
-
The number of days.
|
|
3769
|
-
|
|
3770
3617
|
#### Defined in
|
|
3771
3618
|
|
|
3772
|
-
[packages/framework/esm-utils/src/age-helpers.tsx:8](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
3619
|
+
[packages/framework/esm-utils/src/age-helpers.tsx:8](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/age-helpers.tsx#L8)
|
|
3773
3620
|
|
|
3774
3621
|
___
|
|
3775
3622
|
|
|
@@ -3777,24 +3624,20 @@ ___
|
|
|
3777
3624
|
|
|
3778
3625
|
▸ **isSameDay**(`firstDate`, `secondDate`): `boolean`
|
|
3779
3626
|
|
|
3780
|
-
Checks if two dates are representing the same day.
|
|
3781
|
-
|
|
3782
3627
|
#### Parameters
|
|
3783
3628
|
|
|
3784
3629
|
| Name | Type | Description |
|
|
3785
3630
|
| :------ | :------ | :------ |
|
|
3786
|
-
| `firstDate` | `Date` |
|
|
3787
|
-
| `secondDate` | `Date` |
|
|
3631
|
+
| `firstDate` | `Date` | |
|
|
3632
|
+
| `secondDate` | `Date` | |
|
|
3788
3633
|
|
|
3789
3634
|
#### Returns
|
|
3790
3635
|
|
|
3791
3636
|
`boolean`
|
|
3792
3637
|
|
|
3793
|
-
True if both are located on the same day.
|
|
3794
|
-
|
|
3795
3638
|
#### Defined in
|
|
3796
3639
|
|
|
3797
|
-
[packages/framework/esm-utils/src/age-helpers.tsx:25](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
3640
|
+
[packages/framework/esm-utils/src/age-helpers.tsx:25](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/age-helpers.tsx#L25)
|
|
3798
3641
|
|
|
3799
3642
|
___
|
|
3800
3643
|
|
|
@@ -3815,7 +3658,7 @@ ___
|
|
|
3815
3658
|
|
|
3816
3659
|
#### Defined in
|
|
3817
3660
|
|
|
3818
|
-
[packages/framework/esm-utils/src/version.ts:22](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
3661
|
+
[packages/framework/esm-utils/src/version.ts:22](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/version.ts#L22)
|
|
3819
3662
|
|
|
3820
3663
|
___
|
|
3821
3664
|
|
|
@@ -3823,15 +3666,6 @@ ___
|
|
|
3823
3666
|
|
|
3824
3667
|
▸ **retry**<`T`\>(`fn`, `options?`): `Promise`<`T`\>
|
|
3825
3668
|
|
|
3826
|
-
Executes the specified function and retries executing on failure with a custom backoff strategy
|
|
3827
|
-
defined by the options.
|
|
3828
|
-
|
|
3829
|
-
If not configured otherwise, this function uses the following default options:
|
|
3830
|
-
* Retries 5 times beyond the initial attempt.
|
|
3831
|
-
* Uses an exponential backoff starting with an initial delay of 1000ms.
|
|
3832
|
-
|
|
3833
|
-
**`throws`** Rethrows the final error of running `fn` when the function stops retrying.
|
|
3834
|
-
|
|
3835
3669
|
#### Type parameters
|
|
3836
3670
|
|
|
3837
3671
|
| Name |
|
|
@@ -3842,18 +3676,16 @@ If not configured otherwise, this function uses the following default options:
|
|
|
3842
3676
|
|
|
3843
3677
|
| Name | Type | Description |
|
|
3844
3678
|
| :------ | :------ | :------ |
|
|
3845
|
-
| `fn` | () => `Promise`<`T`\> |
|
|
3846
|
-
| `options` | [`RetryOptions`](interfaces/RetryOptions.md) |
|
|
3679
|
+
| `fn` | () => `Promise`<`T`\> | |
|
|
3680
|
+
| `options` | [`RetryOptions`](interfaces/RetryOptions.md) | |
|
|
3847
3681
|
|
|
3848
3682
|
#### Returns
|
|
3849
3683
|
|
|
3850
3684
|
`Promise`<`T`\>
|
|
3851
3685
|
|
|
3852
|
-
The result of successfully executing `fn`.
|
|
3853
|
-
|
|
3854
3686
|
#### Defined in
|
|
3855
3687
|
|
|
3856
|
-
[packages/framework/esm-utils/src/retry.ts:40](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
3688
|
+
[packages/framework/esm-utils/src/retry.ts:40](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/retry.ts#L40)
|
|
3857
3689
|
|
|
3858
3690
|
___
|
|
3859
3691
|
|
|
@@ -3876,4 +3708,4 @@ ___
|
|
|
3876
3708
|
|
|
3877
3709
|
#### Defined in
|
|
3878
3710
|
|
|
3879
|
-
[packages/framework/esm-utils/src/translate.ts:4](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
3711
|
+
[packages/framework/esm-utils/src/translate.ts:4](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/translate.ts#L4)
|