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

package/docs/interfaces/FetchConfig.md

@@ -1,191 +1,228 @@
-[O3 Framework](../API.md) / FetchConfig
+[@openmrs/esm-framework](../API.md) / FetchConfig
 
 # Interface: FetchConfig
 
-Defined in: [packages/framework/esm-api/src/openmrs-fetch.ts:314](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-api/src/openmrs-fetch.ts#L314)
+## Hierarchy
 
-## Extends
+- `Omit`<`RequestInit`, ``"body"`` \| ``"headers"``\>
 
-- `Omit`\<`RequestInit`, `"body"` \| `"headers"`\>
+  ↳ **`FetchConfig`**
 
-## Properties
+## Table of contents
 
-### body?
+### API Properties
 
-> `optional` **body**: `string` \| `FetchBody`
+- [body](FetchConfig.md#body)
+- [headers](FetchConfig.md#headers)
 
-Defined in: [packages/framework/esm-api/src/openmrs-fetch.ts:316](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-api/src/openmrs-fetch.ts#L316)
+### Other Properties
 
-***
+- [cache](FetchConfig.md#cache)
+- [credentials](FetchConfig.md#credentials)
+- [integrity](FetchConfig.md#integrity)
+- [keepalive](FetchConfig.md#keepalive)
+- [method](FetchConfig.md#method)
+- [mode](FetchConfig.md#mode)
+- [redirect](FetchConfig.md#redirect)
+- [referrer](FetchConfig.md#referrer)
+- [referrerPolicy](FetchConfig.md#referrerpolicy)
+- [signal](FetchConfig.md#signal)
+- [window](FetchConfig.md#window)
 
-### cache?
+## API Properties
 
-> `optional` **cache**: `RequestCache`
+### body
 
-Defined in: node\_modules/typescript/lib/lib.dom.d.ts:1924
+• `Optional` **body**: `string` \| `FetchBody`
 
-A string indicating how the request will interact with the browser's cache to set request's cache.
+#### Defined in
 
-#### Inherited from
+[packages/framework/esm-api/src/openmrs-fetch.ts:316](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/openmrs-fetch.ts#L316)
 
-`Omit.cache`
+___
 
-***
+### headers
 
-### credentials?
+• `Optional` **headers**: [`FetchHeaders`](FetchHeaders.md)
 
-> `optional` **credentials**: `RequestCredentials`
+#### Defined in
 
-Defined in: node\_modules/typescript/lib/lib.dom.d.ts:1926
+[packages/framework/esm-api/src/openmrs-fetch.ts:315](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/openmrs-fetch.ts#L315)
 
-A string indicating whether credentials will be sent with the request always, never, or only when sent to a same-origin URL. Sets request's credentials.
+___
 
-#### Inherited from
+## Other Properties
 
-`Omit.credentials`
+### cache
 
-***
+• `Optional` **cache**: `RequestCache`
 
-### headers?
+A string indicating how the request will interact with the browser's cache to set request's cache.
 
-> `optional` **headers**: [`FetchHeaders`](FetchHeaders.md)
+#### Inherited from
 
-Defined in: [packages/framework/esm-api/src/openmrs-fetch.ts:315](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-api/src/openmrs-fetch.ts#L315)
+Omit.cache
 
-***
+#### Defined in
 
-### integrity?
+node_modules/typescript/lib/lib.dom.d.ts:1593
 
-> `optional` **integrity**: `string`
+___
 
-Defined in: node\_modules/typescript/lib/lib.dom.d.ts:1930
+### credentials
 
-A cryptographic hash of the resource to be fetched by request. Sets request's integrity.
+• `Optional` **credentials**: `RequestCredentials`
+
+A string indicating whether credentials will be sent with the request always, never, or only when sent to a same-origin URL. Sets request's credentials.
 
 #### Inherited from
 
-`Omit.integrity`
+Omit.credentials
 
-***
+#### Defined in
 
-### keepalive?
+node_modules/typescript/lib/lib.dom.d.ts:1595
 
-> `optional` **keepalive**: `boolean`
+___
 
-Defined in: node\_modules/typescript/lib/lib.dom.d.ts:1932
+### integrity
 
-A boolean to set request's keepalive.
+• `Optional` **integrity**: `string`
+
+A cryptographic hash of the resource to be fetched by request. Sets request's integrity.
 
 #### Inherited from
 
-`Omit.keepalive`
+Omit.integrity
 
-***
+#### Defined in
 
-### method?
+node_modules/typescript/lib/lib.dom.d.ts:1599
 
-> `optional` **method**: `string`
+___
 
-Defined in: node\_modules/typescript/lib/lib.dom.d.ts:1934
+### keepalive
 
-A string to set request's method.
+• `Optional` **keepalive**: `boolean`
+
+A boolean to set request's keepalive.
 
 #### Inherited from
 
-`Omit.method`
+Omit.keepalive
 
-***
+#### Defined in
 
-### mode?
+node_modules/typescript/lib/lib.dom.d.ts:1601
 
-> `optional` **mode**: `RequestMode`
+___
 
-Defined in: node\_modules/typescript/lib/lib.dom.d.ts:1936
+### method
 
-A string to indicate whether the request will use CORS, or will be restricted to same-origin URLs. Sets request's mode.
+• `Optional` **method**: `string`
+
+A string to set request's method.
 
 #### Inherited from
 
-`Omit.mode`
+Omit.method
 
-***
+#### Defined in
 
-### priority?
+node_modules/typescript/lib/lib.dom.d.ts:1603
 
-> `optional` **priority**: `RequestPriority`
+___
 
-Defined in: node\_modules/typescript/lib/lib.dom.d.ts:1937
+### mode
+
+• `Optional` **mode**: `RequestMode`
+
+A string to indicate whether the request will use CORS, or will be restricted to same-origin URLs. Sets request's mode.
 
 #### Inherited from
 
-`Omit.priority`
+Omit.mode
 
-***
+#### Defined in
 
-### redirect?
+node_modules/typescript/lib/lib.dom.d.ts:1605
 
-> `optional` **redirect**: `RequestRedirect`
+___
 
-Defined in: node\_modules/typescript/lib/lib.dom.d.ts:1939
+### redirect
+
+• `Optional` **redirect**: `RequestRedirect`
 
 A string indicating whether request follows redirects, results in an error upon encountering a redirect, or returns the redirect (in an opaque fashion). Sets request's redirect.
 
 #### Inherited from
 
-`Omit.redirect`
+Omit.redirect
+
+#### Defined in
 
-***
+node_modules/typescript/lib/lib.dom.d.ts:1607
 
-### referrer?
+___
 
-> `optional` **referrer**: `string`
+### referrer
 
-Defined in: node\_modules/typescript/lib/lib.dom.d.ts:1941
+• `Optional` **referrer**: `string`
 
 A string whose value is a same-origin URL, "about:client", or the empty string, to set request's referrer.
 
 #### Inherited from
 
-`Omit.referrer`
+Omit.referrer
 
-***
+#### Defined in
 
-### referrerPolicy?
+node_modules/typescript/lib/lib.dom.d.ts:1609
 
-> `optional` **referrerPolicy**: `ReferrerPolicy`
+___
 
-Defined in: node\_modules/typescript/lib/lib.dom.d.ts:1943
+### referrerPolicy
+
+• `Optional` **referrerPolicy**: `ReferrerPolicy`
 
 A referrer policy to set request's referrerPolicy.
 
 #### Inherited from
 
-`Omit.referrerPolicy`
+Omit.referrerPolicy
+
+#### Defined in
 
-***
+node_modules/typescript/lib/lib.dom.d.ts:1611
 
-### signal?
+___
 
-> `optional` **signal**: `null` \| `AbortSignal`
+### signal
 
-Defined in: node\_modules/typescript/lib/lib.dom.d.ts:1945
+• `Optional` **signal**: ``null`` \| `AbortSignal`
 
 An AbortSignal to set request's signal.
 
 #### Inherited from
 
-`Omit.signal`
+Omit.signal
 
-***
+#### Defined in
 
-### window?
+node_modules/typescript/lib/lib.dom.d.ts:1613
 
-> `optional` **window**: `null`
+___
 
-Defined in: node\_modules/typescript/lib/lib.dom.d.ts:1947
+### window
+
+• `Optional` **window**: ``null``
 
 Can only be null. Used to disassociate request from any Window.
 
 #### Inherited from
 
-`Omit.window`
+Omit.window
+
+#### Defined in
+
+node_modules/typescript/lib/lib.dom.d.ts:1615

package/docs/interfaces/FetchError.md

@@ -1,21 +1,34 @@
-[O3 Framework](../API.md) / FetchError
+[@openmrs/esm-framework](../API.md) / FetchError
 
 # Interface: FetchError
 
-Defined in: [packages/framework/esm-api/src/openmrs-fetch.ts:333](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-api/src/openmrs-fetch.ts#L333)
+## Implemented by
 
-## Properties
+- [`OpenmrsFetchError`](../classes/OpenmrsFetchError.md)
+
+## Table of contents
+
+### API Properties
+
+- [response](FetchError.md#response)
+- [responseBody](FetchError.md#responsebody)
+
+## API Properties
 
 ### response
 
-> **response**: `Response`
+• **response**: `Response`
+
+#### Defined in
 
-Defined in: [packages/framework/esm-api/src/openmrs-fetch.ts:334](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-api/src/openmrs-fetch.ts#L334)
+[packages/framework/esm-api/src/openmrs-fetch.ts:334](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/openmrs-fetch.ts#L334)
 
-***
+___
 
 ### responseBody
 
-> **responseBody**: `null` \| `ResponseBody`
+• **responseBody**: ``null`` \| `ResponseBody`
+
+#### Defined in
 
-Defined in: [packages/framework/esm-api/src/openmrs-fetch.ts:335](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-api/src/openmrs-fetch.ts#L335)
+[packages/framework/esm-api/src/openmrs-fetch.ts:335](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/openmrs-fetch.ts#L335)

package/docs/interfaces/FetchHeaders.md

@@ -1,9 +1,7 @@
-[O3 Framework](../API.md) / FetchHeaders
+[@openmrs/esm-framework](../API.md) / FetchHeaders
 
 # Interface: FetchHeaders
 
-Defined in: [packages/framework/esm-api/src/openmrs-fetch.ts:321](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-api/src/openmrs-fetch.ts#L321)
-
 ## Indexable
 
-\[`key`: `string`\]: `null` \| `string`
+▪ [key: `string`]: `string` \| ``null``