@openmrs/esm-framework 3.1.10-pre.92 → 3.1.11-pre.597

package/docs/interfaces/Config.md

@@ -0,0 +1,182 @@
+[@openmrs/esm-framework](../API.md) / Config
+
+# Interface: Config
+
+## Hierarchy
+
+- `Object`
+
+  ↳ **`Config`**
+
+## Indexable
+
+▪ [moduleName: `string`]: { [key: string]: `any`;  }
+
+## Table of contents
+
+### Properties
+
+- [constructor](Config.md#constructor)
+
+### Methods
+
+- [hasOwnProperty](Config.md#hasownproperty)
+- [isPrototypeOf](Config.md#isprototypeof)
+- [propertyIsEnumerable](Config.md#propertyisenumerable)
+- [toLocaleString](Config.md#tolocalestring)
+- [toString](Config.md#tostring)
+- [valueOf](Config.md#valueof)
+
+## Properties
+
+### constructor
+
+• **constructor**: `Function`
+
+The initial value of Object.prototype.constructor is the standard built-in Object constructor.
+
+#### Inherited from
+
+Object.constructor
+
+#### Defined in
+
+node_modules/typescript/lib/lib.es5.d.ts:122
+
+## Methods
+
+### hasOwnProperty
+
+▸ **hasOwnProperty**(`v`): `boolean`
+
+Determines whether an object has a property with the specified name.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `v` | `PropertyKey` | A property name. |
+
+#### Returns
+
+`boolean`
+
+#### Inherited from
+
+Object.hasOwnProperty
+
+#### Defined in
+
+node_modules/typescript/lib/lib.es5.d.ts:137
+
+___
+
+### isPrototypeOf
+
+▸ **isPrototypeOf**(`v`): `boolean`
+
+Determines whether an object exists in another object's prototype chain.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `v` | `Object` | Another object whose prototype chain is to be checked. |
+
+#### Returns
+
+`boolean`
+
+#### Inherited from
+
+Object.isPrototypeOf
+
+#### Defined in
+
+node_modules/typescript/lib/lib.es5.d.ts:143
+
+___
+
+### propertyIsEnumerable
+
+▸ **propertyIsEnumerable**(`v`): `boolean`
+
+Determines whether a specified property is enumerable.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `v` | `PropertyKey` | A property name. |
+
+#### Returns
+
+`boolean`
+
+#### Inherited from
+
+Object.propertyIsEnumerable
+
+#### Defined in
+
+node_modules/typescript/lib/lib.es5.d.ts:149
+
+___
+
+### toLocaleString
+
+▸ **toLocaleString**(): `string`
+
+Returns a date converted to a string using the current locale.
+
+#### Returns
+
+`string`
+
+#### Inherited from
+
+Object.toLocaleString
+
+#### Defined in
+
+node_modules/typescript/lib/lib.es5.d.ts:128
+
+___
+
+### toString
+
+▸ **toString**(): `string`
+
+Returns a string representation of an object.
+
+#### Returns
+
+`string`
+
+#### Inherited from
+
+Object.toString
+
+#### Defined in
+
+node_modules/typescript/lib/lib.es5.d.ts:125
+
+___
+
+### valueOf
+
+▸ **valueOf**(): `Object`
+
+Returns the primitive value of the specified object.
+
+#### Returns
+
+`Object`
+
+#### Inherited from
+
+Object.valueOf
+
+#### Defined in
+
+node_modules/typescript/lib/lib.es5.d.ts:131

package/docs/interfaces/ConfigObject.md

@@ -0,0 +1,182 @@
+[@openmrs/esm-framework](../API.md) / ConfigObject
+
+# Interface: ConfigObject
+
+## Hierarchy
+
+- `Object`
+
+  ↳ **`ConfigObject`**
+
+## Indexable
+
+▪ [key: `string`]: `any`
+
+## Table of contents
+
+### Properties
+
+- [constructor](ConfigObject.md#constructor)
+
+### Methods
+
+- [hasOwnProperty](ConfigObject.md#hasownproperty)
+- [isPrototypeOf](ConfigObject.md#isprototypeof)
+- [propertyIsEnumerable](ConfigObject.md#propertyisenumerable)
+- [toLocaleString](ConfigObject.md#tolocalestring)
+- [toString](ConfigObject.md#tostring)
+- [valueOf](ConfigObject.md#valueof)
+
+## Properties
+
+### constructor
+
+• **constructor**: `Function`
+
+The initial value of Object.prototype.constructor is the standard built-in Object constructor.
+
+#### Inherited from
+
+Object.constructor
+
+#### Defined in
+
+node_modules/typescript/lib/lib.es5.d.ts:122
+
+## Methods
+
+### hasOwnProperty
+
+▸ **hasOwnProperty**(`v`): `boolean`
+
+Determines whether an object has a property with the specified name.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `v` | `PropertyKey` | A property name. |
+
+#### Returns
+
+`boolean`
+
+#### Inherited from
+
+Object.hasOwnProperty
+
+#### Defined in
+
+node_modules/typescript/lib/lib.es5.d.ts:137
+
+___
+
+### isPrototypeOf
+
+▸ **isPrototypeOf**(`v`): `boolean`
+
+Determines whether an object exists in another object's prototype chain.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `v` | `Object` | Another object whose prototype chain is to be checked. |
+
+#### Returns
+
+`boolean`
+
+#### Inherited from
+
+Object.isPrototypeOf
+
+#### Defined in
+
+node_modules/typescript/lib/lib.es5.d.ts:143
+
+___
+
+### propertyIsEnumerable
+
+▸ **propertyIsEnumerable**(`v`): `boolean`
+
+Determines whether a specified property is enumerable.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `v` | `PropertyKey` | A property name. |
+
+#### Returns
+
+`boolean`
+
+#### Inherited from
+
+Object.propertyIsEnumerable
+
+#### Defined in
+
+node_modules/typescript/lib/lib.es5.d.ts:149
+
+___
+
+### toLocaleString
+
+▸ **toLocaleString**(): `string`
+
+Returns a date converted to a string using the current locale.
+
+#### Returns
+
+`string`
+
+#### Inherited from
+
+Object.toLocaleString
+
+#### Defined in
+
+node_modules/typescript/lib/lib.es5.d.ts:128
+
+___
+
+### toString
+
+▸ **toString**(): `string`
+
+Returns a string representation of an object.
+
+#### Returns
+
+`string`
+
+#### Inherited from
+
+Object.toString
+
+#### Defined in
+
+node_modules/typescript/lib/lib.es5.d.ts:125
+
+___
+
+### valueOf
+
+▸ **valueOf**(): `Object`
+
+Returns the primitive value of the specified object.
+
+#### Returns
+
+`Object`
+
+#### Inherited from
+
+Object.valueOf
+
+#### Defined in
+
+node_modules/typescript/lib/lib.es5.d.ts:131

package/docs/interfaces/ConfigSchema.md

@@ -0,0 +1,45 @@
+[@openmrs/esm-framework](../API.md) / ConfigSchema
+
+# Interface: ConfigSchema
+
+## Indexable
+
+▪ [key: `string`]: [`ConfigSchema`](ConfigSchema.md) \| [`ConfigValue`](../API.md#configvalue)
+
+## Table of contents
+
+### Properties
+
+- [\_elements](ConfigSchema.md#_elements)
+- [\_type](ConfigSchema.md#_type)
+- [\_validators](ConfigSchema.md#_validators)
+
+## Properties
+
+### \_elements
+
+• `Optional` **\_elements**: [`ConfigSchema`](ConfigSchema.md)
+
+#### Defined in
+
+[packages/framework/esm-config/src/types.ts:19](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/types.ts#L19)
+
+___
+
+### \_type
+
+• `Optional` **\_type**: [`Type`](../enums/Type.md)
+
+#### Defined in
+
+[packages/framework/esm-config/src/types.ts:17](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/types.ts#L17)
+
+___
+
+### \_validators
+
+• `Optional` **\_validators**: [`Validator`](../API.md#validator)[]
+
+#### Defined in
+
+[packages/framework/esm-config/src/types.ts:18](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/types.ts#L18)

package/docs/interfaces/ConfigStore.md

@@ -0,0 +1,34 @@
+[@openmrs/esm-framework](../API.md) / ConfigStore
+
+# Interface: ConfigStore
+
+Output configs
+
+Each module has its own stores for its config and its extension slots' configs.
+
+## Table of contents
+
+### Properties
+
+- [config](ConfigStore.md#config)
+- [loaded](ConfigStore.md#loaded)
+
+## Properties
+
+### config
+
+• **config**: ``null`` \| [`ConfigObject`](ConfigObject.md)
+
+#### Defined in
+
+[packages/framework/esm-config/src/module-config/state.ts:131](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/module-config/state.ts#L131)
+
+___
+
+### loaded
+
+• **loaded**: `boolean`
+
+#### Defined in
+
+[packages/framework/esm-config/src/module-config/state.ts:132](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/module-config/state.ts#L132)

package/docs/interfaces/ConfigurableLinkProps.md

@@ -0,0 +1,25 @@
+[@openmrs/esm-framework](../API.md) / ConfigurableLinkProps
+
+# Interface: ConfigurableLinkProps
+
+## Hierarchy
+
+- `AnchorHTMLAttributes`<`HTMLAnchorElement`\>
+
+  ↳ **`ConfigurableLinkProps`**
+
+## Table of contents
+
+### Properties
+
+- [to](ConfigurableLinkProps.md#to)
+
+## Properties
+
+### to
+
+• **to**: `string`
+
+#### Defined in
+
+[packages/framework/esm-react-utils/src/ConfigurableLink.tsx:21](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/ConfigurableLink.tsx#L21)

package/docs/interfaces/ConnectivityChangedEvent.md

@@ -0,0 +1,19 @@
+[@openmrs/esm-framework](../API.md) / ConnectivityChangedEvent
+
+# Interface: ConnectivityChangedEvent
+
+## Table of contents
+
+### Properties
+
+- [online](ConnectivityChangedEvent.md#online)
+
+## Properties
+
+### online
+
+• **online**: `boolean`
+
+#### Defined in
+
+[packages/framework/esm-globals/src/events.ts:2](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/events.ts#L2)

package/docs/interfaces/CurrentPatientOptions.md

@@ -0,0 +1,27 @@
+[@openmrs/esm-framework](../API.md) / CurrentPatientOptions
+
+# Interface: CurrentPatientOptions
+
+## Hierarchy
+
+- **`CurrentPatientOptions`**
+
+  ↳ [`PatientWithFullResponse`](PatientWithFullResponse.md)
+
+  ↳ [`OnlyThePatient`](OnlyThePatient.md)
+
+## Table of contents
+
+### Properties
+
+- [includeConfig](CurrentPatientOptions.md#includeconfig)
+
+## Properties
+
+### includeConfig
+
+• `Optional` **includeConfig**: `boolean`
+
+#### Defined in
+
+[packages/framework/esm-api/src/shared-api-objects/current-patient.ts:7](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/shared-api-objects/current-patient.ts#L7)

package/docs/interfaces/CurrentUserOptions.md

@@ -0,0 +1,27 @@
+[@openmrs/esm-framework](../API.md) / CurrentUserOptions
+
+# Interface: CurrentUserOptions
+
+## Hierarchy
+
+- **`CurrentUserOptions`**
+
+  ↳ [`CurrentUserWithResponseOption`](CurrentUserWithResponseOption.md)
+
+  ↳ [`CurrentUserWithoutResponseOption`](CurrentUserWithoutResponseOption.md)
+
+## Table of contents
+
+### Properties
+
+- [includeAuthStatus](CurrentUserOptions.md#includeauthstatus)
+
+## Properties
+
+### includeAuthStatus
+
+• `Optional` **includeAuthStatus**: `boolean`
+
+#### Defined in
+
+[packages/framework/esm-api/src/types/user-resource.ts:2](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L2)

package/docs/interfaces/CurrentUserWithResponseOption.md

@@ -0,0 +1,29 @@
+[@openmrs/esm-framework](../API.md) / CurrentUserWithResponseOption
+
+# Interface: CurrentUserWithResponseOption
+
+## Hierarchy
+
+- [`CurrentUserOptions`](CurrentUserOptions.md)
+
+  ↳ **`CurrentUserWithResponseOption`**
+
+## Table of contents
+
+### Properties
+
+- [includeAuthStatus](CurrentUserWithResponseOption.md#includeauthstatus)
+
+## Properties
+
+### includeAuthStatus
+
+• **includeAuthStatus**: ``true``
+
+#### Overrides
+
+[CurrentUserOptions](CurrentUserOptions.md).[includeAuthStatus](CurrentUserOptions.md#includeauthstatus)
+
+#### Defined in
+
+[packages/framework/esm-api/src/types/user-resource.ts:6](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L6)

package/docs/interfaces/CurrentUserWithoutResponseOption.md

@@ -0,0 +1,29 @@
+[@openmrs/esm-framework](../API.md) / CurrentUserWithoutResponseOption
+
+# Interface: CurrentUserWithoutResponseOption
+
+## Hierarchy
+
+- [`CurrentUserOptions`](CurrentUserOptions.md)
+
+  ↳ **`CurrentUserWithoutResponseOption`**
+
+## Table of contents
+
+### Properties
+
+- [includeAuthStatus](CurrentUserWithoutResponseOption.md#includeauthstatus)
+
+## Properties
+
+### includeAuthStatus
+
+• **includeAuthStatus**: ``false``
+
+#### Overrides
+
+[CurrentUserOptions](CurrentUserOptions.md).[includeAuthStatus](CurrentUserOptions.md#includeauthstatus)
+
+#### Defined in
+
+[packages/framework/esm-api/src/types/user-resource.ts:10](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L10)