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

package/docs/interfaces/FetchConfig.md

@@ -1,228 +1,191 @@
-[@openmrs/esm-framework](../API.md) / FetchConfig
+[O3 Framework](../API.md) / FetchConfig
 
 # Interface: FetchConfig
 
-## Hierarchy
+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)
 
-- `Omit`<`RequestInit`, ``"body"`` \| ``"headers"``\>
+## Extends
 
-  ↳ **`FetchConfig`**
+- `Omit`\<`RequestInit`, `"body"` \| `"headers"`\>
 
-## Table of contents
+## Properties
 
-### API Properties
+### body?
 
-- [body](FetchConfig.md#body)
-- [headers](FetchConfig.md#headers)
+> `optional` **body**: `string` \| `FetchBody`
 
-### Other Properties
+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)
 
-- [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)
+***
 
-## API Properties
+### cache?
 
-### body
+> `optional` **cache**: `RequestCache`
 
-• `Optional` **body**: `string` \| `FetchBody`
+Defined in: node\_modules/typescript/lib/lib.dom.d.ts:1924
 
-#### Defined in
-
-[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)
+A string indicating how the request will interact with the browser's cache to set request's cache.
 
-___
+#### Inherited from
 
-### headers
+`Omit.cache`
 
-• `Optional` **headers**: [`FetchHeaders`](FetchHeaders.md)
+***
 
-#### Defined in
+### credentials?
 
-[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)
+> `optional` **credentials**: `RequestCredentials`
 
-___
+Defined in: node\_modules/typescript/lib/lib.dom.d.ts:1926
 
-## Other Properties
+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.
 
-### cache
+#### Inherited from
 
-• `Optional` **cache**: `RequestCache`
+`Omit.credentials`
 
-A string indicating how the request will interact with the browser's cache to set request's cache.
+***
 
-#### Inherited from
+### headers?
 
-Omit.cache
+> `optional` **headers**: [`FetchHeaders`](FetchHeaders.md)
 
-#### Defined in
+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)
 
-node_modules/typescript/lib/lib.dom.d.ts:1593
+***
 
-___
+### integrity?
 
-### credentials
+> `optional` **integrity**: `string`
 
-• `Optional` **credentials**: `RequestCredentials`
+Defined in: node\_modules/typescript/lib/lib.dom.d.ts:1930
 
-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.
+A cryptographic hash of the resource to be fetched by request. Sets request's integrity.
 
 #### Inherited from
 
-Omit.credentials
+`Omit.integrity`
 
-#### Defined in
+***
 
-node_modules/typescript/lib/lib.dom.d.ts:1595
+### keepalive?
 
-___
+> `optional` **keepalive**: `boolean`
 
-### integrity
+Defined in: node\_modules/typescript/lib/lib.dom.d.ts:1932
 
-• `Optional` **integrity**: `string`
-
-A cryptographic hash of the resource to be fetched by request. Sets request's integrity.
+A boolean to set request's keepalive.
 
 #### Inherited from
 
-Omit.integrity
-
-#### Defined in
+`Omit.keepalive`
 
-node_modules/typescript/lib/lib.dom.d.ts:1599
+***
 
-___
+### method?
 
-### keepalive
+> `optional` **method**: `string`
 
-• `Optional` **keepalive**: `boolean`
+Defined in: node\_modules/typescript/lib/lib.dom.d.ts:1934
 
-A boolean to set request's keepalive.
+A string to set request's method.
 
 #### Inherited from
 
-Omit.keepalive
-
-#### Defined in
+`Omit.method`
 
-node_modules/typescript/lib/lib.dom.d.ts:1601
+***
 
-___
+### mode?
 
-### method
+> `optional` **mode**: `RequestMode`
 
-• `Optional` **method**: `string`
+Defined in: node\_modules/typescript/lib/lib.dom.d.ts:1936
 
-A string to set request's method.
+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.method
+`Omit.mode`
 
-#### Defined in
+***
 
-node_modules/typescript/lib/lib.dom.d.ts:1603
+### priority?
 
-___
+> `optional` **priority**: `RequestPriority`
 
-### 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.
+Defined in: node\_modules/typescript/lib/lib.dom.d.ts:1937
 
 #### Inherited from
 
-Omit.mode
+`Omit.priority`
 
-#### Defined in
+***
 
-node_modules/typescript/lib/lib.dom.d.ts:1605
+### redirect?
 
-___
+> `optional` **redirect**: `RequestRedirect`
 
-### redirect
-
-• `Optional` **redirect**: `RequestRedirect`
+Defined in: node\_modules/typescript/lib/lib.dom.d.ts:1939
 
 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
-
-#### Defined in
+`Omit.redirect`
 
-node_modules/typescript/lib/lib.dom.d.ts:1607
+***
 
-___
+### referrer?
 
-### referrer
+> `optional` **referrer**: `string`
 
-• `Optional` **referrer**: `string`
+Defined in: node\_modules/typescript/lib/lib.dom.d.ts:1941
 
 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
+***
 
-node_modules/typescript/lib/lib.dom.d.ts:1609
+### referrerPolicy?
 
-___
+> `optional` **referrerPolicy**: `ReferrerPolicy`
 
-### referrerPolicy
-
-• `Optional` **referrerPolicy**: `ReferrerPolicy`
+Defined in: node\_modules/typescript/lib/lib.dom.d.ts:1943
 
 A referrer policy to set request's referrerPolicy.
 
 #### Inherited from
 
-Omit.referrerPolicy
-
-#### Defined in
+`Omit.referrerPolicy`
 
-node_modules/typescript/lib/lib.dom.d.ts:1611
+***
 
-___
+### signal?
 
-### signal
+> `optional` **signal**: `null` \| `AbortSignal`
 
-• `Optional` **signal**: ``null`` \| `AbortSignal`
+Defined in: node\_modules/typescript/lib/lib.dom.d.ts:1945
 
 An AbortSignal to set request's signal.
 
 #### Inherited from
 
-Omit.signal
+`Omit.signal`
 
-#### Defined in
+***
 
-node_modules/typescript/lib/lib.dom.d.ts:1613
+### window?
 
-___
+> `optional` **window**: `null`
 
-### window
-
-• `Optional` **window**: ``null``
+Defined in: node\_modules/typescript/lib/lib.dom.d.ts:1947
 
 Can only be null. Used to disassociate request from any Window.
 
 #### Inherited from
 
-Omit.window
-
-#### Defined in
-
-node_modules/typescript/lib/lib.dom.d.ts:1615
+`Omit.window`

package/docs/interfaces/FetchError.md

@@ -1,34 +1,21 @@
-[@openmrs/esm-framework](../API.md) / FetchError
+[O3 Framework](../API.md) / FetchError
 
 # Interface: FetchError
 
-## Implemented by
+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)
 
-- [`OpenmrsFetchError`](../classes/OpenmrsFetchError.md)
-
-## Table of contents
-
-### API Properties
-
-- [response](FetchError.md#response)
-- [responseBody](FetchError.md#responsebody)
-
-## API Properties
+## Properties
 
 ### response
 
-• **response**: `Response`
-
-#### Defined in
+> **response**: `Response`
 
-[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)
+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)
 
-___
+***
 
 ### responseBody
 
-• **responseBody**: ``null`` \| `ResponseBody`
-
-#### Defined in
+> **responseBody**: `null` \| `ResponseBody`
 
-[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)
+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)

package/docs/interfaces/FetchHeaders.md

@@ -1,7 +1,9 @@
-[@openmrs/esm-framework](../API.md) / FetchHeaders
+[O3 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`]: `string` \| ``null``
+\[`key`: `string`\]: `null` \| `string`