@openmrs/esm-framework 6.3.1-pre.3106 → 6.3.1-pre.3119

package/docs/interfaces/FetchResponse.md

@@ -1,285 +1,279 @@
-[@openmrs/esm-framework](../API.md) / FetchResponse
+[O3 Framework](../API.md) / FetchResponse
 
-# Interface: FetchResponse<T\>
+# Interface: FetchResponse\<T\>
 
-## Type parameters
+Defined in: [packages/framework/esm-api/src/types/fetch.ts:3](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/fetch.ts#L3)
 
-| Name | Type |
-| :------ | :------ |
-| `T` | `any` |
-
-## Hierarchy
+## Extends
 
 - `Response`
 
-  ↳ **`FetchResponse`**
-
-  ↳↳ [`LoggedInUserFetchResponse`](LoggedInUserFetchResponse.md)
-
-## Table of contents
+## Extended by
 
-### Properties
+- [`LoggedInUserFetchResponse`](LoggedInUserFetchResponse.md)
 
-- [body](FetchResponse.md#body)
-- [bodyUsed](FetchResponse.md#bodyused)
-- [data](FetchResponse.md#data)
-- [headers](FetchResponse.md#headers)
-- [ok](FetchResponse.md#ok)
-- [redirected](FetchResponse.md#redirected)
-- [status](FetchResponse.md#status)
-- [statusText](FetchResponse.md#statustext)
-- [type](FetchResponse.md#type)
-- [url](FetchResponse.md#url)
+## Type Parameters
 
-### Methods
+### T
 
-- [arrayBuffer](FetchResponse.md#arraybuffer)
-- [blob](FetchResponse.md#blob)
-- [clone](FetchResponse.md#clone)
-- [formData](FetchResponse.md#formdata)
-- [json](FetchResponse.md#json)
-- [text](FetchResponse.md#text)
+`T` = `any`
 
 ## Properties
 
 ### body
 
-• `Readonly` **body**: ``null`` \| `ReadableStream`<`Uint8Array`\>
+> `readonly` **body**: `null` \| `ReadableStream`\<`Uint8Array`\<`ArrayBufferLike`\>\>
 
-#### Inherited from
+Defined in: node\_modules/typescript/lib/lib.dom.d.ts:3534
 
-Response.body
+[MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/body)
 
-#### Defined in
+#### Inherited from
 
-node_modules/typescript/lib/lib.dom.d.ts:2587
+`Response.body`
 
-___
+***
 
 ### bodyUsed
 
-• `Readonly` **bodyUsed**: `boolean`
+> `readonly` **bodyUsed**: `boolean`
 
-#### Inherited from
+Defined in: node\_modules/typescript/lib/lib.dom.d.ts:3536
 
-Response.bodyUsed
+[MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/bodyUsed)
 
-#### Defined in
+#### Inherited from
 
-node_modules/typescript/lib/lib.dom.d.ts:2588
+`Response.bodyUsed`
 
-___
+***
 
 ### data
 
-• **data**: `T`
+> **data**: `T`
 
-#### Defined in
+Defined in: [packages/framework/esm-api/src/types/fetch.ts:4](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/fetch.ts#L4)
 
-[packages/framework/esm-api/src/types/fetch.ts:4](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/fetch.ts#L4)
-
-___
+***
 
 ### headers
 
-• `Readonly` **headers**: `Headers`
+> `readonly` **headers**: `Headers`
 
-#### Inherited from
+Defined in: node\_modules/typescript/lib/lib.dom.d.ts:19881
 
-Response.headers
+[MDN Reference](https://developer.mozilla.org/docs/Web/API/Response/headers)
 
-#### Defined in
+#### Inherited from
 
-node_modules/typescript/lib/lib.dom.d.ts:11772
+`Response.headers`
 
-___
+***
 
 ### ok
 
-• `Readonly` **ok**: `boolean`
+> `readonly` **ok**: `boolean`
 
-#### Inherited from
+Defined in: node\_modules/typescript/lib/lib.dom.d.ts:19883
 
-Response.ok
+[MDN Reference](https://developer.mozilla.org/docs/Web/API/Response/ok)
 
-#### Defined in
+#### Inherited from
 
-node_modules/typescript/lib/lib.dom.d.ts:11773
+`Response.ok`
 
-___
+***
 
 ### redirected
 
-• `Readonly` **redirected**: `boolean`
+> `readonly` **redirected**: `boolean`
 
-#### Inherited from
+Defined in: node\_modules/typescript/lib/lib.dom.d.ts:19885
 
-Response.redirected
+[MDN Reference](https://developer.mozilla.org/docs/Web/API/Response/redirected)
 
-#### Defined in
+#### Inherited from
 
-node_modules/typescript/lib/lib.dom.d.ts:11774
+`Response.redirected`
 
-___
+***
 
 ### status
 
-• `Readonly` **status**: `number`
+> `readonly` **status**: `number`
 
-#### Inherited from
+Defined in: node\_modules/typescript/lib/lib.dom.d.ts:19887
 
-Response.status
+[MDN Reference](https://developer.mozilla.org/docs/Web/API/Response/status)
 
-#### Defined in
+#### Inherited from
 
-node_modules/typescript/lib/lib.dom.d.ts:11775
+`Response.status`
 
-___
+***
 
 ### statusText
 
-• `Readonly` **statusText**: `string`
+> `readonly` **statusText**: `string`
 
-#### Inherited from
+Defined in: node\_modules/typescript/lib/lib.dom.d.ts:19889
 
-Response.statusText
+[MDN Reference](https://developer.mozilla.org/docs/Web/API/Response/statusText)
 
-#### Defined in
+#### Inherited from
 
-node_modules/typescript/lib/lib.dom.d.ts:11776
+`Response.statusText`
 
-___
+***
 
 ### type
 
-• `Readonly` **type**: `ResponseType`
+> `readonly` **type**: `ResponseType`
 
-#### Inherited from
+Defined in: node\_modules/typescript/lib/lib.dom.d.ts:19891
 
-Response.type
+[MDN Reference](https://developer.mozilla.org/docs/Web/API/Response/type)
 
-#### Defined in
+#### Inherited from
 
-node_modules/typescript/lib/lib.dom.d.ts:11777
+`Response.type`
 
-___
+***
 
 ### url
 
-• `Readonly` **url**: `string`
+> `readonly` **url**: `string`
 
-#### Inherited from
+Defined in: node\_modules/typescript/lib/lib.dom.d.ts:19893
 
-Response.url
+[MDN Reference](https://developer.mozilla.org/docs/Web/API/Response/url)
 
-#### Defined in
+#### Inherited from
 
-node_modules/typescript/lib/lib.dom.d.ts:11778
+`Response.url`
 
 ## Methods
 
-### arrayBuffer
+### arrayBuffer()
+
+> **arrayBuffer**(): `Promise`\<`ArrayBuffer`\>
 
-▸ **arrayBuffer**(): `Promise`<`ArrayBuffer`\>
+Defined in: node\_modules/typescript/lib/lib.dom.d.ts:3538
+
+[MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/arrayBuffer)
 
 #### Returns
 
-`Promise`<`ArrayBuffer`\>
+`Promise`\<`ArrayBuffer`\>
 
 #### Inherited from
 
-Response.arrayBuffer
+`Response.arrayBuffer`
 
-#### Defined in
+***
 
-node_modules/typescript/lib/lib.dom.d.ts:2589
+### blob()
 
-___
+> **blob**(): `Promise`\<`Blob`\>
 
-### blob
+Defined in: node\_modules/typescript/lib/lib.dom.d.ts:3540
 
-▸ **blob**(): `Promise`<`Blob`\>
+[MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/blob)
 
 #### Returns
 
-`Promise`<`Blob`\>
+`Promise`\<`Blob`\>
 
 #### Inherited from
 
-Response.blob
+`Response.blob`
 
-#### Defined in
+***
 
-node_modules/typescript/lib/lib.dom.d.ts:2590
+### bytes()
 
-___
+> **bytes**(): `Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
 
-### clone
+Defined in: node\_modules/typescript/lib/lib.dom.d.ts:3542
 
-▸ **clone**(): `Response`
+[MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/bytes)
 
 #### Returns
 
-`Response`
+`Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
 
 #### Inherited from
 
-Response.clone
+`Response.bytes`
 
-#### Defined in
+***
 
-node_modules/typescript/lib/lib.dom.d.ts:11779
+### clone()
 
-___
+> **clone**(): `Response`
 
-### formData
+Defined in: node\_modules/typescript/lib/lib.dom.d.ts:19895
 
-▸ **formData**(): `Promise`<`FormData`\>
+[MDN Reference](https://developer.mozilla.org/docs/Web/API/Response/clone)
 
 #### Returns
 
-`Promise`<`FormData`\>
+`Response`
 
 #### Inherited from
 
-Response.formData
+`Response.clone`
 
-#### Defined in
+***
 
-node_modules/typescript/lib/lib.dom.d.ts:2591
+### formData()
 
-___
+> **formData**(): `Promise`\<`FormData`\>
 
-### json
+Defined in: node\_modules/typescript/lib/lib.dom.d.ts:3544
 
-▸ **json**(): `Promise`<`any`\>
+[MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/formData)
 
 #### Returns
 
-`Promise`<`any`\>
+`Promise`\<`FormData`\>
 
 #### Inherited from
 
-Response.json
+`Response.formData`
 
-#### Defined in
+***
 
-node_modules/typescript/lib/lib.dom.d.ts:2592
+### json()
 
-___
+> **json**(): `Promise`\<`any`\>
 
-### text
+Defined in: node\_modules/typescript/lib/lib.dom.d.ts:3546
 
-▸ **text**(): `Promise`<`string`\>
+[MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/json)
 
 #### Returns
 
-`Promise`<`string`\>
+`Promise`\<`any`\>
 
 #### Inherited from
 
-Response.text
+`Response.json`
+
+***
 
-#### Defined in
+### text()
+
+> **text**(): `Promise`\<`string`\>
+
+Defined in: node\_modules/typescript/lib/lib.dom.d.ts:3548
+
+[MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/text)
+
+#### Returns
+
+`Promise`\<`string`\>
+
+#### Inherited from
 
-node_modules/typescript/lib/lib.dom.d.ts:2593
+`Response.text`

package/docs/interfaces/FetchResponseJson.md

@@ -1,7 +1,9 @@
-[@openmrs/esm-framework](../API.md) / FetchResponseJson
+[O3 Framework](../API.md) / FetchResponseJson
 
 # Interface: FetchResponseJson
 
+Defined in: [packages/framework/esm-api/src/openmrs-fetch.ts:329](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/openmrs-fetch.ts#L329)
+
 ## Indexable
 
-▪ [key: `string`]: `any`
+\[`key`: `string`\]: `any`

package/docs/interfaces/ImportMap.md

@@ -1,19 +1,13 @@
-[@openmrs/esm-framework](../API.md) / ImportMap
+[O3 Framework](../API.md) / ImportMap
 
 # Interface: ImportMap
 
-## Table of contents
-
-### Properties
-
-- [imports](ImportMap.md#imports)
+Defined in: packages/framework/esm-globals/dist/types.d.ts:74
 
 ## Properties
 
 ### imports
 
-• **imports**: `Record`<`string`, `string`\>
-
-#### Defined in
+> **imports**: `Record`\<`string`, `string`\>
 
-packages/framework/esm-globals/dist/types.d.ts:75
+Defined in: packages/framework/esm-globals/dist/types.d.ts:75

package/docs/interfaces/LeftNavStore.md

@@ -1,52 +1,37 @@
-[@openmrs/esm-framework](../API.md) / LeftNavStore
+[O3 Framework](../API.md) / LeftNavStore
 
 # Interface: LeftNavStore
 
-## Table of contents
-
-### Properties
-
-- [basePath](LeftNavStore.md#basepath)
-- [componentContext](LeftNavStore.md#componentcontext)
-- [mode](LeftNavStore.md#mode)
-- [slotName](LeftNavStore.md#slotname)
+Defined in: [packages/framework/esm-extensions/src/left-nav.ts:6](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/left-nav.ts#L6)
 
 ## Properties
 
 ### basePath
 
-• **basePath**: `string`
-
-#### Defined in
+> **basePath**: `string`
 
-[packages/framework/esm-extensions/src/left-nav.ts:8](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/left-nav.ts#L8)
+Defined in: [packages/framework/esm-extensions/src/left-nav.ts:8](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/left-nav.ts#L8)
 
-___
+***
 
-### componentContext
+### componentContext?
 
-• `Optional` **componentContext**: [`ComponentConfig`](ComponentConfig.md)
+> `optional` **componentContext**: [`ComponentConfig`](ComponentConfig.md)
 
-#### Defined in
+Defined in: [packages/framework/esm-extensions/src/left-nav.ts:10](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/left-nav.ts#L10)
 
-[packages/framework/esm-extensions/src/left-nav.ts:10](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/left-nav.ts#L10)
-
-___
+***
 
 ### mode
 
-• **mode**: `LeftNavMode`
-
-#### Defined in
+> **mode**: `LeftNavMode`
 
-[packages/framework/esm-extensions/src/left-nav.ts:9](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/left-nav.ts#L9)
+Defined in: [packages/framework/esm-extensions/src/left-nav.ts:9](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/left-nav.ts#L9)
 
-___
+***
 
 ### slotName
 
-• **slotName**: ``null`` \| `string`
-
-#### Defined in
+> **slotName**: `null` \| `string`
 
-[packages/framework/esm-extensions/src/left-nav.ts:7](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/left-nav.ts#L7)
+Defined in: [packages/framework/esm-extensions/src/left-nav.ts:7](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/left-nav.ts#L7)

package/docs/interfaces/Link.md

@@ -1,41 +1,29 @@
-[@openmrs/esm-framework](../API.md) / Link
+[O3 Framework](../API.md) / Link
 
 # Interface: Link
 
-## Table of contents
-
-### Properties
-
-- [rel](Link.md#rel)
-- [resourceAlias](Link.md#resourcealias)
-- [uri](Link.md#uri)
+Defined in: [packages/framework/esm-api/src/types/openmrs-resource.ts:20](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/openmrs-resource.ts#L20)
 
 ## Properties
 
 ### rel
 
-• **rel**: `string`
-
-#### Defined in
+> **rel**: `string`
 
-[packages/framework/esm-api/src/types/openmrs-resource.ts:21](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/openmrs-resource.ts#L21)
+Defined in: [packages/framework/esm-api/src/types/openmrs-resource.ts:21](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/openmrs-resource.ts#L21)
 
-___
+***
 
-### resourceAlias
+### resourceAlias?
 
-• `Optional` **resourceAlias**: `string`
+> `optional` **resourceAlias**: `string`
 
-#### Defined in
+Defined in: [packages/framework/esm-api/src/types/openmrs-resource.ts:23](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/openmrs-resource.ts#L23)
 
-[packages/framework/esm-api/src/types/openmrs-resource.ts:23](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/openmrs-resource.ts#L23)
-
-___
+***
 
 ### uri
 
-• **uri**: `string`
-
-#### Defined in
+> **uri**: `string`
 
-[packages/framework/esm-api/src/types/openmrs-resource.ts:22](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/openmrs-resource.ts#L22)
+Defined in: [packages/framework/esm-api/src/types/openmrs-resource.ts:22](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/openmrs-resource.ts#L22)