@openmrs/esm-framework 3.4.1-pre.98 → 4.0.1-pre.204

package/docs/interfaces/OfflinePatientArgs.md

@@ -15,11 +15,9 @@
 
 • **patientUuid**: `string`
 
-The UUID of the patient that should be made available offline.
-
 #### Defined in
 
-[packages/framework/esm-offline/src/offline-patient-data.ts:71](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/offline-patient-data.ts#L71)
+[packages/framework/esm-offline/src/offline-patient-data.ts:32](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/offline-patient-data.ts#L32)
 
 ___
 
@@ -27,8 +25,6 @@ ___
 
 • **signal**: `AbortSignal`
 
-An {@link AbortSignal} which notifies about the cancellation of the operation.
-
 #### Defined in
 
-[packages/framework/esm-offline/src/offline-patient-data.ts:75](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/offline-patient-data.ts#L75)
+[packages/framework/esm-offline/src/offline-patient-data.ts:33](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/offline-patient-data.ts#L33)

package/docs/interfaces/OfflinePatientDataSyncHandler.md

@@ -18,12 +18,9 @@
 
 • `Readonly` **displayName**: `string`
 
-A name of the handler registration which can be displayed to the user.
-This is ideally translated.
-
 #### Defined in
 
-[packages/framework/esm-offline/src/offline-patient-data.ts:56](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/offline-patient-data.ts#L56)
+[packages/framework/esm-offline/src/offline-patient-data.ts:26](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/offline-patient-data.ts#L26)
 
 ## Methods
 
@@ -31,22 +28,16 @@ This is ideally translated.
 
 ▸ **onOfflinePatientAdded**(`args`): `Promise`<`void`\>
 
-A function which is invoked when a patient is added to the app's offline patient cache.
-Signals to the handler that the patient's data must be made available offline.
-
 #### Parameters
 
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `args` | [`OfflinePatientArgs`](OfflinePatientArgs.md) | Arguments which provide data about the patient to be made available offline. |
+| Name | Type |
+| :------ | :------ |
+| `args` | [`OfflinePatientArgs`](OfflinePatientArgs.md) |
 
 #### Returns
 
 `Promise`<`void`\>
 
-A promise which should resolve if all data could be cached and reject when there was an issue
-  caching the data.
-
 #### Defined in
 
-[packages/framework/esm-offline/src/offline-patient-data.ts:64](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/offline-patient-data.ts#L64)
+[packages/framework/esm-offline/src/offline-patient-data.ts:27](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/offline-patient-data.ts#L27)

package/docs/interfaces/OfflinePatientDataSyncState.md

@@ -22,11 +22,9 @@
 
 • `Readonly` **errors**: `Record`<`string`, `string`\>
 
-A set of error messages associated with the identifers of the failed handlers.
-
 #### Defined in
 
-[packages/framework/esm-offline/src/offline-patient-data.ts:42](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/offline-patient-data.ts#L42)
+[packages/framework/esm-offline/src/offline-patient-data.ts:20](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/offline-patient-data.ts#L20)
 
 ___
 
@@ -34,12 +32,9 @@ ___
 
 • `Readonly` **failedHandlers**: `string`[]
 
-A list of the data sync handler registration identifiers which failed to synchronize the
-patient's data.
-
 #### Defined in
 
-[packages/framework/esm-offline/src/offline-patient-data.ts:38](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/offline-patient-data.ts#L38)
+[packages/framework/esm-offline/src/offline-patient-data.ts:19](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/offline-patient-data.ts#L19)
 
 ___
 
@@ -47,12 +42,9 @@ ___
 
 • `Readonly` **syncedHandlers**: `string`[]
 
-A list of the data sync handler registration identifiers which successfully synchronized the
-patient's data.
-
 #### Defined in
 
-[packages/framework/esm-offline/src/offline-patient-data.ts:33](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/offline-patient-data.ts#L33)
+[packages/framework/esm-offline/src/offline-patient-data.ts:18](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/offline-patient-data.ts#L18)
 
 ___
 
@@ -60,12 +52,9 @@ ___
 
 • `Readonly` **syncingHandlers**: `string`[]
 
-A list of the data sync handler registration identifiers which are still in the process
-of synchronizing the patient's data.
-
 #### Defined in
 
-[packages/framework/esm-offline/src/offline-patient-data.ts:28](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/offline-patient-data.ts#L28)
+[packages/framework/esm-offline/src/offline-patient-data.ts:17](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/offline-patient-data.ts#L17)
 
 ___
 
@@ -73,11 +62,9 @@ ___
 
 • `Readonly` **timestamp**: `Date`
 
-The time when this state snapshot was initially created.
-
 #### Defined in
 
-[packages/framework/esm-offline/src/offline-patient-data.ts:23](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/offline-patient-data.ts#L23)
+[packages/framework/esm-offline/src/offline-patient-data.ts:16](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/offline-patient-data.ts#L16)
 
 ## Methods
 
@@ -85,15 +72,10 @@ The time when this state snapshot was initially created.
 
 ▸ **abort**(): `boolean`
 
-Aborts the process of downloading data.
-
 #### Returns
 
 `boolean`
 
-`true` if the cancellation could be triggered (that is, if there were any syncing handlers);
-  `false` if not.
-
 #### Defined in
 
-[packages/framework/esm-offline/src/offline-patient-data.ts:48](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/offline-patient-data.ts#L48)
+[packages/framework/esm-offline/src/offline-patient-data.ts:21](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/offline-patient-data.ts#L21)

package/docs/interfaces/OfflinePatientDataSyncStore.md

@@ -15,13 +15,9 @@
 
 • **handlers**: `Record`<`string`, [`OfflinePatientDataSyncHandler`](OfflinePatientDataSyncHandler.md)\>
 
-Holds the list of currently registered handlers which deal with patients that should be available offline.
-The key is a unique identifier which, once defined, should never change as it gives identity to
-the handler registration.
-
 #### Defined in
 
-[packages/framework/esm-offline/src/offline-patient-data.ts:16](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/offline-patient-data.ts#L16)
+[packages/framework/esm-offline/src/offline-patient-data.ts:11](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/offline-patient-data.ts#L11)
 
 ___
 
@@ -29,9 +25,6 @@ ___
 
 • **offlinePatientDataSyncState**: `Record`<`string`, [`OfflinePatientDataSyncState`](OfflinePatientDataSyncState.md)\>
 
-For each patient ID of the patients whose data is currently made available offline, provides
-the current data synchronizaton state.
-
 #### Defined in
 
-[packages/framework/esm-offline/src/offline-patient-data.ts:10](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/offline-patient-data.ts#L10)
+[packages/framework/esm-offline/src/offline-patient-data.ts:10](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/offline-patient-data.ts#L10)

package/docs/interfaces/OldExtensionSlotBaseProps.md

@@ -0,0 +1,65 @@
+[@openmrs/esm-framework](../API.md) / OldExtensionSlotBaseProps
+
+# Interface: OldExtensionSlotBaseProps
+
+## Table of contents
+
+### Properties
+
+- [extensionSlotName](OldExtensionSlotBaseProps.md#extensionslotname)
+- [name](OldExtensionSlotBaseProps.md#name)
+- [state](OldExtensionSlotBaseProps.md#state)
+
+### Methods
+
+- [select](OldExtensionSlotBaseProps.md#select)
+
+## Properties
+
+### extensionSlotName
+
+• **extensionSlotName**: `string`
+
+#### Defined in
+
+[packages/framework/esm-react-utils/src/ExtensionSlot.tsx:18](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/ExtensionSlot.tsx#L18)
+
+___
+
+### name
+
+• `Optional` **name**: `string`
+
+#### Defined in
+
+[packages/framework/esm-react-utils/src/ExtensionSlot.tsx:16](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/ExtensionSlot.tsx#L16)
+
+___
+
+### state
+
+• `Optional` **state**: `Record`<`string`, `any`\>
+
+#### Defined in
+
+[packages/framework/esm-react-utils/src/ExtensionSlot.tsx:20](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/ExtensionSlot.tsx#L20)
+
+## Methods
+
+### select
+
+▸ `Optional` **select**(`extensions`): [`ConnectedExtension`](ConnectedExtension.md)[]
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `extensions` | [`ConnectedExtension`](ConnectedExtension.md)[] |
+
+#### Returns
+
+[`ConnectedExtension`](ConnectedExtension.md)[]
+
+#### Defined in
+
+[packages/framework/esm-react-utils/src/ExtensionSlot.tsx:19](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/ExtensionSlot.tsx#L19)

package/docs/interfaces/OmrsServiceWorkerMessage.md

@@ -32,4 +32,4 @@
 
 #### Defined in
 
-[packages/framework/esm-offline/src/service-worker-messaging.ts:28](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/service-worker-messaging.ts#L28)
+[packages/framework/esm-offline/src/service-worker-messaging.ts:28](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/service-worker-messaging.ts#L28)

package/docs/interfaces/OnImportMapChangedMessage.md

@@ -23,7 +23,7 @@
 
 #### Defined in
 
-[packages/framework/esm-offline/src/service-worker-messaging.ts:33](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/service-worker-messaging.ts#L33)
+[packages/framework/esm-offline/src/service-worker-messaging.ts:33](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/service-worker-messaging.ts#L33)
 
 ___
 
@@ -37,4 +37,4 @@ ___
 
 #### Defined in
 
-[packages/framework/esm-offline/src/service-worker-messaging.ts:28](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/service-worker-messaging.ts#L28)
+[packages/framework/esm-offline/src/service-worker-messaging.ts:28](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/service-worker-messaging.ts#L28)

package/docs/interfaces/OnlyThePatient.md

@@ -26,4 +26,4 @@
 
 #### Defined in
 
-[packages/framework/esm-api/src/shared-api-objects/current-patient.ts:16](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/shared-api-objects/current-patient.ts#L16)
+[packages/framework/esm-api/src/shared-api-objects/current-patient.ts:16](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/shared-api-objects/current-patient.ts#L16)

package/docs/interfaces/OpenmrsResource.md

@@ -21,7 +21,7 @@
 
 #### Defined in
 
-[packages/framework/esm-api/src/types/openmrs-resource.ts:3](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/openmrs-resource.ts#L3)
+[packages/framework/esm-api/src/types/openmrs-resource.ts:3](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/openmrs-resource.ts#L3)
 
 ___
 
@@ -31,4 +31,4 @@ ___
 
 #### Defined in
 
-[packages/framework/esm-api/src/types/openmrs-resource.ts:2](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/openmrs-resource.ts#L2)
+[packages/framework/esm-api/src/types/openmrs-resource.ts:2](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/openmrs-resource.ts#L2)

package/docs/interfaces/PageDefinition.md

@@ -30,15 +30,13 @@
 
 • **appName**: `string`
 
-The module/app that defines the component
-
 #### Inherited from
 
 [ComponentDefinition](ComponentDefinition.md).[appName](ComponentDefinition.md#appname)
 
 #### Defined in
 
-[packages/framework/esm-globals/src/types.ts:99](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/types.ts#L99)
+[packages/framework/esm-globals/src/types.ts:99](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L99)
 
 ___
 
@@ -46,15 +44,13 @@ ___
 
 • `Optional` **offline**: `boolean` \| `object`
 
-Defines the offline support / properties of the component.
-
 #### Inherited from
 
 [ComponentDefinition](ComponentDefinition.md).[offline](ComponentDefinition.md#offline)
 
 #### Defined in
 
-[packages/framework/esm-globals/src/types.ts:111](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/types.ts#L111)
+[packages/framework/esm-globals/src/types.ts:111](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L111)
 
 ___
 
@@ -62,15 +58,13 @@ ___
 
 • `Optional` **online**: `boolean` \| `object`
 
-Defines the online support / properties of the component.
-
 #### Inherited from
 
 [ComponentDefinition](ComponentDefinition.md).[online](ComponentDefinition.md#online)
 
 #### Defined in
 
-[packages/framework/esm-globals/src/types.ts:107](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/types.ts#L107)
+[packages/framework/esm-globals/src/types.ts:107](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L107)
 
 ___
 
@@ -78,19 +72,15 @@ ___
 
 • **order**: `number`
 
-The order in which to load the page. This determines DOM order.
-
 #### Defined in
 
-[packages/framework/esm-globals/src/types.ts:145](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/types.ts#L145)
+[packages/framework/esm-globals/src/types.ts:146](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L146)
 
 ___
 
 ### privilege
 
-• `Optional` **privilege**: `string`
-
-Defines the access privilege required for this component, if any.
+• `Optional` **privilege**: `string` \| `string`[]
 
 #### Inherited from
 
@@ -98,7 +88,7 @@ Defines the access privilege required for this component, if any.
 
 #### Defined in
 
-[packages/framework/esm-globals/src/types.ts:115](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/types.ts#L115)
+[packages/framework/esm-globals/src/types.ts:116](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L116)
 
 ___
 
@@ -106,15 +96,13 @@ ___
 
 • `Optional` **resources**: `Record`<`string`, [`ResourceLoader`](ResourceLoader.md)<`any`\>\>
 
-Defines resources that are loaded when the component should mount.
-
 #### Inherited from
 
 [ComponentDefinition](ComponentDefinition.md).[resources](ComponentDefinition.md#resources)
 
 #### Defined in
 
-[packages/framework/esm-globals/src/types.ts:119](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/types.ts#L119)
+[packages/framework/esm-globals/src/types.ts:120](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L120)
 
 ___
 
@@ -122,11 +110,9 @@ ___
 
 • **route**: `string`
 
-The route of the page.
-
 #### Defined in
 
-[packages/framework/esm-globals/src/types.ts:141](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/types.ts#L141)
+[packages/framework/esm-globals/src/types.ts:142](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L142)
 
 ## Methods
 
@@ -134,8 +120,6 @@ The route of the page.
 
 ▸ **load**(): `Promise`<`any`\>
 
-Defines a function to use for actually loading the component's lifecycle.
-
 #### Returns
 
 `Promise`<`any`\>
@@ -146,4 +130,4 @@ Defines a function to use for actually loading the component's lifecycle.
 
 #### Defined in
 
-[packages/framework/esm-globals/src/types.ts:103](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/types.ts#L103)
+[packages/framework/esm-globals/src/types.ts:103](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L103)

package/docs/interfaces/PatientWithFullResponse.md

@@ -26,4 +26,4 @@
 
 #### Defined in
 
-[packages/framework/esm-api/src/shared-api-objects/current-patient.ts:12](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/shared-api-objects/current-patient.ts#L12)
+[packages/framework/esm-api/src/shared-api-objects/current-patient.ts:12](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/shared-api-objects/current-patient.ts#L12)

package/docs/interfaces/Person.md

@@ -18,7 +18,7 @@
 
 #### Defined in
 
-[packages/framework/esm-api/src/types/user-resource.ts:34](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L34)
+[packages/framework/esm-api/src/types/user-resource.ts:34](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/user-resource.ts#L34)
 
 ___
 
@@ -28,7 +28,7 @@ ___
 
 #### Defined in
 
-[packages/framework/esm-api/src/types/user-resource.ts:35](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L35)
+[packages/framework/esm-api/src/types/user-resource.ts:35](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/user-resource.ts#L35)
 
 ___
 
@@ -38,4 +38,4 @@ ___
 
 #### Defined in
 
-[packages/framework/esm-api/src/types/user-resource.ts:33](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L33)
+[packages/framework/esm-api/src/types/user-resource.ts:33](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/user-resource.ts#L33)

package/docs/interfaces/Privilege.md

@@ -18,7 +18,7 @@
 
 #### Defined in
 
-[packages/framework/esm-api/src/types/user-resource.ts:40](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L40)
+[packages/framework/esm-api/src/types/user-resource.ts:40](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/user-resource.ts#L40)
 
 ___
 
@@ -28,7 +28,7 @@ ___
 
 #### Defined in
 
-[packages/framework/esm-api/src/types/user-resource.ts:41](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L41)
+[packages/framework/esm-api/src/types/user-resource.ts:41](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/user-resource.ts#L41)
 
 ___
 
@@ -38,4 +38,4 @@ ___
 
 #### Defined in
 
-[packages/framework/esm-api/src/types/user-resource.ts:39](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L39)
+[packages/framework/esm-api/src/types/user-resource.ts:39](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/user-resource.ts#L39)

package/docs/interfaces/QueueItemDescriptor.md

@@ -2,11 +2,6 @@
 
 # Interface: QueueItemDescriptor
 
-Contains information about the sync item which has been provided externally by the caller
-who added the item to the queue.
-This information is all optional, but, when provided while enqueuing the item, can be used in other
-locations to better represent the sync item, e.g. in the UI.
-
 ## Table of contents
 
 ### Offline Properties
@@ -24,7 +19,7 @@ locations to better represent the sync item, e.g. in the UI.
 
 #### Defined in
 
-[packages/framework/esm-offline/src/sync.ts:32](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L32)
+[packages/framework/esm-offline/src/sync.ts:33](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/sync.ts#L33)
 
 ___
 
@@ -34,7 +29,7 @@ ___
 
 #### Defined in
 
-[packages/framework/esm-offline/src/sync.ts:37](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L37)
+[packages/framework/esm-offline/src/sync.ts:38](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/sync.ts#L38)
 
 ___
 
@@ -44,7 +39,7 @@ ___
 
 #### Defined in
 
-[packages/framework/esm-offline/src/sync.ts:31](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L31)
+[packages/framework/esm-offline/src/sync.ts:32](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/sync.ts#L32)
 
 ___
 
@@ -54,4 +49,4 @@ ___
 
 #### Defined in
 
-[packages/framework/esm-offline/src/sync.ts:36](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L36)
+[packages/framework/esm-offline/src/sync.ts:37](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/sync.ts#L37)

package/docs/interfaces/RegisterDynamicRouteMessage.md

@@ -25,7 +25,7 @@
 
 #### Defined in
 
-[packages/framework/esm-offline/src/service-worker-messaging.ts:41](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/service-worker-messaging.ts#L41)
+[packages/framework/esm-offline/src/service-worker-messaging.ts:41](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/service-worker-messaging.ts#L41)
 
 ___
 
@@ -35,7 +35,7 @@ ___
 
 #### Defined in
 
-[packages/framework/esm-offline/src/service-worker-messaging.ts:43](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/service-worker-messaging.ts#L43)
+[packages/framework/esm-offline/src/service-worker-messaging.ts:43](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/service-worker-messaging.ts#L43)
 
 ___
 
@@ -49,7 +49,7 @@ ___
 
 #### Defined in
 
-[packages/framework/esm-offline/src/service-worker-messaging.ts:28](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/service-worker-messaging.ts#L28)
+[packages/framework/esm-offline/src/service-worker-messaging.ts:28](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/service-worker-messaging.ts#L28)
 
 ___
 
@@ -59,4 +59,4 @@ ___
 
 #### Defined in
 
-[packages/framework/esm-offline/src/service-worker-messaging.ts:42](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/service-worker-messaging.ts#L42)
+[packages/framework/esm-offline/src/service-worker-messaging.ts:42](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/service-worker-messaging.ts#L42)

package/docs/interfaces/ResourceLoader.md

@@ -20,4 +20,4 @@
 
 #### Defined in
 
-[packages/framework/esm-globals/src/types.ts:92](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/types.ts#L92)
+[packages/framework/esm-globals/src/types.ts:92](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L92)

package/docs/interfaces/RetryOptions.md

@@ -2,8 +2,6 @@
 
 # Interface: RetryOptions
 
-Options for configuring the behavior of the [retry](../API.md#retry) function.
-
 ## Table of contents
 
 ### Methods
@@ -18,14 +16,11 @@ Options for configuring the behavior of the [retry](../API.md#retry) function.
 
 ▸ `Optional` **getDelay**(`attempt`): `number`
 
-Calculates the next delay (in milliseconds) before a retry attempt.
-Returning a value for the inital attempt (`0`) delays the initial function invocation.
-
 #### Parameters
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `attempt` | `number` | The current (zero-based) retry attempt. `0` indicates the initial attempt. |
+| `attempt` | `number` |  |
 
 #### Returns
 
@@ -33,7 +28,7 @@ Returning a value for the inital attempt (`0`) delays the initial function invoc
 
 #### Defined in
 
-[packages/framework/esm-utils/src/retry.ts:18](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-utils/src/retry.ts#L18)
+[packages/framework/esm-utils/src/retry.ts:18](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/retry.ts#L18)
 
 ___
 
@@ -41,15 +36,12 @@ ___
 
 ▸ `Optional` **onError**(`e`, `attempt`): `void`
 
-Called when invoking the function resulted in an error.
-Allows running side-effects on errors, e.g. logging.
-
 #### Parameters
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `e` | `any` | The error thrown by the function. |
-| `attempt` | `number` | The current (zero-based) retry attempt. `0` indicates the initial attempt. |
+| `e` | `any` |  |
+| `attempt` | `number` |  |
 
 #### Returns
 
@@ -57,7 +49,7 @@ Allows running side-effects on errors, e.g. logging.
 
 #### Defined in
 
-[packages/framework/esm-utils/src/retry.ts:25](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-utils/src/retry.ts#L25)
+[packages/framework/esm-utils/src/retry.ts:25](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/retry.ts#L25)
 
 ___
 
@@ -65,14 +57,11 @@ ___
 
 ▸ `Optional` **shouldRetry**(`attempt`): `any`
 
-Determines whether the retry function should retry executing the function after it failed
-with an error on the current attempt.
-
 #### Parameters
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `attempt` | `number` | The current (zero-based) retry attempt. `0` indicates the initial attempt. |
+| `attempt` | `number` |  |
 
 #### Returns
 
@@ -80,4 +69,4 @@ with an error on the current attempt.
 
 #### Defined in
 
-[packages/framework/esm-utils/src/retry.ts:12](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-utils/src/retry.ts#L12)
+[packages/framework/esm-utils/src/retry.ts:12](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/retry.ts#L12)