@openmrs/esm-config 3.1.15-pre.694 → 3.1.15-pre.712
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +0 -2
- package/package.json +4 -5
- package/docs/API.md +0 -482
- package/docs/enums/Type.md +0 -85
- package/docs/interfaces/Config.md +0 -182
- package/docs/interfaces/ConfigObject.md +0 -182
- package/docs/interfaces/ConfigSchema.md +0 -45
- package/docs/interfaces/ConfigStore.md +0 -34
- package/docs/interfaces/ExtensionSlotConfig.md +0 -52
- package/docs/interfaces/ExtensionSlotConfigObject.md +0 -41
- package/docs/interfaces/ExtensionSlotConfigsStore.md +0 -32
- package/docs/interfaces/ExtensionSlotConfigureValueObject.md +0 -7
- package/docs/interfaces/ImplementerToolsConfigStore.md +0 -19
- package/docs/interfaces/NavigateOptions.md +0 -19
- package/typedoc.json +0 -7
package/README.md
CHANGED
|
@@ -2,8 +2,6 @@
|
|
|
2
2
|
|
|
3
3
|
[](https://www.npmjs.com/package/@openmrs/esm-config)
|
|
4
4
|
|
|
5
|
-
[API Docs](docs/API.md)
|
|
6
|
-
|
|
7
5
|
## What is this?
|
|
8
6
|
|
|
9
7
|
This is the configuration library for [OpenMRS Frontend 3.0](https://wiki.openmrs.org/display/projects/OpenMRS+3.0%3A+A+Frontend+Framework+that+enables+collaboration+and+better+User+Experience).
|
package/package.json
CHANGED
|
@@ -1,13 +1,12 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@openmrs/esm-config",
|
|
3
|
-
"version": "3.1.15-pre.
|
|
3
|
+
"version": "3.1.15-pre.712",
|
|
4
4
|
"license": "MPL-2.0",
|
|
5
5
|
"description": "A configuration library for the OpenMRS Single-Spa framework.",
|
|
6
6
|
"browser": "dist/openmrs-esm-module-config.js",
|
|
7
7
|
"main": "src/index.ts",
|
|
8
8
|
"source": true,
|
|
9
9
|
"scripts": {
|
|
10
|
-
"document": "../../../document.sh esm-config",
|
|
11
10
|
"test": "jest --config jest.config.js --passWithNoTests",
|
|
12
11
|
"build": "webpack --mode=production",
|
|
13
12
|
"analyze": "webpack --mode=production --env analyze=true",
|
|
@@ -46,12 +45,12 @@
|
|
|
46
45
|
"systemjs": "6.x"
|
|
47
46
|
},
|
|
48
47
|
"devDependencies": {
|
|
49
|
-
"@openmrs/esm-globals": "^3.1.15-pre.
|
|
50
|
-
"@openmrs/esm-state": "^3.1.15-pre.
|
|
48
|
+
"@openmrs/esm-globals": "^3.1.15-pre.712",
|
|
49
|
+
"@openmrs/esm-state": "^3.1.15-pre.712",
|
|
51
50
|
"@types/ramda": "^0.26.44",
|
|
52
51
|
"@types/systemjs": "^6.1.0",
|
|
53
52
|
"babel-plugin-ramda": "^2.0.0",
|
|
54
53
|
"single-spa": "^5.9.2"
|
|
55
54
|
},
|
|
56
|
-
"gitHead": "
|
|
55
|
+
"gitHead": "61c481dac38e897e7ced4b6ad2990982131f00bc"
|
|
57
56
|
}
|
package/docs/API.md
DELETED
|
@@ -1,482 +0,0 @@
|
|
|
1
|
-
[Back to README.md](../README.md)
|
|
2
|
-
|
|
3
|
-
# @openmrs/esm-config
|
|
4
|
-
|
|
5
|
-
## Table of contents
|
|
6
|
-
|
|
7
|
-
### Enumerations
|
|
8
|
-
|
|
9
|
-
- [Type](enums/Type.md)
|
|
10
|
-
|
|
11
|
-
### Interfaces
|
|
12
|
-
|
|
13
|
-
- [Config](interfaces/Config.md)
|
|
14
|
-
- [ConfigObject](interfaces/ConfigObject.md)
|
|
15
|
-
- [ConfigSchema](interfaces/ConfigSchema.md)
|
|
16
|
-
- [ConfigStore](interfaces/ConfigStore.md)
|
|
17
|
-
- [ExtensionSlotConfig](interfaces/ExtensionSlotConfig.md)
|
|
18
|
-
- [ExtensionSlotConfigObject](interfaces/ExtensionSlotConfigObject.md)
|
|
19
|
-
- [ExtensionSlotConfigsStore](interfaces/ExtensionSlotConfigsStore.md)
|
|
20
|
-
- [ExtensionSlotConfigureValueObject](interfaces/ExtensionSlotConfigureValueObject.md)
|
|
21
|
-
- [ImplementerToolsConfigStore](interfaces/ImplementerToolsConfigStore.md)
|
|
22
|
-
- [NavigateOptions](interfaces/NavigateOptions.md)
|
|
23
|
-
|
|
24
|
-
### Type aliases
|
|
25
|
-
|
|
26
|
-
- [ConfigValue](API.md#configvalue)
|
|
27
|
-
- [ProvidedConfig](API.md#providedconfig)
|
|
28
|
-
- [Validator](API.md#validator)
|
|
29
|
-
- [ValidatorFunction](API.md#validatorfunction)
|
|
30
|
-
|
|
31
|
-
### Variables
|
|
32
|
-
|
|
33
|
-
- [implementerToolsConfigStore](API.md#implementertoolsconfigstore)
|
|
34
|
-
- [temporaryConfigStore](API.md#temporaryconfigstore)
|
|
35
|
-
- [validators](API.md#validators)
|
|
36
|
-
|
|
37
|
-
### Navigation Functions
|
|
38
|
-
|
|
39
|
-
- [interpolateString](API.md#interpolatestring)
|
|
40
|
-
- [isUrl](API.md#isurl)
|
|
41
|
-
- [isUrlWithTemplateParameters](API.md#isurlwithtemplateparameters)
|
|
42
|
-
- [navigate](API.md#navigate)
|
|
43
|
-
|
|
44
|
-
### Other Functions
|
|
45
|
-
|
|
46
|
-
- [defineConfigSchema](API.md#defineconfigschema)
|
|
47
|
-
- [getConfig](API.md#getconfig)
|
|
48
|
-
- [getConfigStore](API.md#getconfigstore)
|
|
49
|
-
- [getExtensionConfigStore](API.md#getextensionconfigstore)
|
|
50
|
-
- [getExtensionSlotsConfigStore](API.md#getextensionslotsconfigstore)
|
|
51
|
-
- [inRange](API.md#inrange)
|
|
52
|
-
- [processConfig](API.md#processconfig)
|
|
53
|
-
- [provide](API.md#provide)
|
|
54
|
-
- [validator](API.md#validator)
|
|
55
|
-
|
|
56
|
-
## Type aliases
|
|
57
|
-
|
|
58
|
-
### ConfigValue
|
|
59
|
-
|
|
60
|
-
Ƭ **ConfigValue**: `string` \| `number` \| `boolean` \| `void` \| `any`[] \| `object`
|
|
61
|
-
|
|
62
|
-
#### Defined in
|
|
63
|
-
|
|
64
|
-
[packages/framework/esm-config/src/types.ts:30](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/types.ts#L30)
|
|
65
|
-
|
|
66
|
-
___
|
|
67
|
-
|
|
68
|
-
### ProvidedConfig
|
|
69
|
-
|
|
70
|
-
Ƭ **ProvidedConfig**: `Object`
|
|
71
|
-
|
|
72
|
-
#### Type declaration
|
|
73
|
-
|
|
74
|
-
| Name | Type |
|
|
75
|
-
| :------ | :------ |
|
|
76
|
-
| `config` | [`Config`](interfaces/Config.md) |
|
|
77
|
-
| `source` | `string` |
|
|
78
|
-
|
|
79
|
-
#### Defined in
|
|
80
|
-
|
|
81
|
-
[packages/framework/esm-config/src/types.ts:55](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/types.ts#L55)
|
|
82
|
-
|
|
83
|
-
___
|
|
84
|
-
|
|
85
|
-
### Validator
|
|
86
|
-
|
|
87
|
-
Ƭ **Validator**: (`value`: `any`) => `void` \| `string`
|
|
88
|
-
|
|
89
|
-
#### Type declaration
|
|
90
|
-
|
|
91
|
-
▸ (`value`): `void` \| `string`
|
|
92
|
-
|
|
93
|
-
##### Parameters
|
|
94
|
-
|
|
95
|
-
| Name | Type |
|
|
96
|
-
| :------ | :------ |
|
|
97
|
-
| `value` | `any` |
|
|
98
|
-
|
|
99
|
-
##### Returns
|
|
100
|
-
|
|
101
|
-
`void` \| `string`
|
|
102
|
-
|
|
103
|
-
#### Defined in
|
|
104
|
-
|
|
105
|
-
[packages/framework/esm-config/src/types.ts:62](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/types.ts#L62)
|
|
106
|
-
|
|
107
|
-
___
|
|
108
|
-
|
|
109
|
-
### ValidatorFunction
|
|
110
|
-
|
|
111
|
-
Ƭ **ValidatorFunction**: (`value`: `any`) => `boolean`
|
|
112
|
-
|
|
113
|
-
#### Type declaration
|
|
114
|
-
|
|
115
|
-
▸ (`value`): `boolean`
|
|
116
|
-
|
|
117
|
-
##### Parameters
|
|
118
|
-
|
|
119
|
-
| Name | Type |
|
|
120
|
-
| :------ | :------ |
|
|
121
|
-
| `value` | `any` |
|
|
122
|
-
|
|
123
|
-
##### Returns
|
|
124
|
-
|
|
125
|
-
`boolean`
|
|
126
|
-
|
|
127
|
-
#### Defined in
|
|
128
|
-
|
|
129
|
-
[packages/framework/esm-config/src/types.ts:60](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/types.ts#L60)
|
|
130
|
-
|
|
131
|
-
## Variables
|
|
132
|
-
|
|
133
|
-
### implementerToolsConfigStore
|
|
134
|
-
|
|
135
|
-
• `Const` **implementerToolsConfigStore**: `Store`<[`ImplementerToolsConfigStore`](interfaces/ImplementerToolsConfigStore.md)\>
|
|
136
|
-
|
|
137
|
-
#### Defined in
|
|
138
|
-
|
|
139
|
-
[packages/framework/esm-config/src/module-config/state.ts:182](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/module-config/state.ts#L182)
|
|
140
|
-
|
|
141
|
-
___
|
|
142
|
-
|
|
143
|
-
### temporaryConfigStore
|
|
144
|
-
|
|
145
|
-
• `Const` **temporaryConfigStore**: `Store`<`TemporaryConfigStore`\>
|
|
146
|
-
|
|
147
|
-
#### Defined in
|
|
148
|
-
|
|
149
|
-
[packages/framework/esm-config/src/module-config/state.ts:69](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/module-config/state.ts#L69)
|
|
150
|
-
|
|
151
|
-
___
|
|
152
|
-
|
|
153
|
-
### validators
|
|
154
|
-
|
|
155
|
-
• `Const` **validators**: `Object`
|
|
156
|
-
|
|
157
|
-
#### Type declaration
|
|
158
|
-
|
|
159
|
-
| Name | Type |
|
|
160
|
-
| :------ | :------ |
|
|
161
|
-
| `inRange` | (`min`: `number`, `max`: `number`) => [`Validator`](API.md#validator) |
|
|
162
|
-
| `isUrl` | [`Validator`](API.md#validator) |
|
|
163
|
-
| `isUrlWithTemplateParameters` | (`allowedTemplateParameters`: `string`[]) => [`Validator`](API.md#validator) |
|
|
164
|
-
|
|
165
|
-
#### Defined in
|
|
166
|
-
|
|
167
|
-
[packages/framework/esm-config/src/validators/validators.ts:57](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/validators/validators.ts#L57)
|
|
168
|
-
|
|
169
|
-
## Navigation Functions
|
|
170
|
-
|
|
171
|
-
### interpolateString
|
|
172
|
-
|
|
173
|
-
▸ **interpolateString**(`template`, `params`): `string`
|
|
174
|
-
|
|
175
|
-
Interpolates values of `params` into the `template` string.
|
|
176
|
-
|
|
177
|
-
Useful for additional template parameters in URLs.
|
|
178
|
-
|
|
179
|
-
Example usage:
|
|
180
|
-
```js
|
|
181
|
-
navigate({
|
|
182
|
-
to: interpolateString(
|
|
183
|
-
config.links.patientChart,
|
|
184
|
-
{ patientUuid: patient.uuid }
|
|
185
|
-
)
|
|
186
|
-
});
|
|
187
|
-
```
|
|
188
|
-
|
|
189
|
-
#### Parameters
|
|
190
|
-
|
|
191
|
-
| Name | Type | Description |
|
|
192
|
-
| :------ | :------ | :------ |
|
|
193
|
-
| `template` | `string` | With optional params wrapped in `${ }` |
|
|
194
|
-
| `params` | `object` | Values to interpolate into the string template |
|
|
195
|
-
|
|
196
|
-
#### Returns
|
|
197
|
-
|
|
198
|
-
`string`
|
|
199
|
-
|
|
200
|
-
#### Defined in
|
|
201
|
-
|
|
202
|
-
[packages/framework/esm-config/src/navigation/interpolate-string.ts:38](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/navigation/interpolate-string.ts#L38)
|
|
203
|
-
|
|
204
|
-
___
|
|
205
|
-
|
|
206
|
-
### isUrl
|
|
207
|
-
|
|
208
|
-
▸ `Const` **isUrl**(`value`): `string` \| `void`
|
|
209
|
-
|
|
210
|
-
Verifies that a string contains only the default URL template parameters.
|
|
211
|
-
|
|
212
|
-
#### Parameters
|
|
213
|
-
|
|
214
|
-
| Name | Type |
|
|
215
|
-
| :------ | :------ |
|
|
216
|
-
| `value` | `any` |
|
|
217
|
-
|
|
218
|
-
#### Returns
|
|
219
|
-
|
|
220
|
-
`string` \| `void`
|
|
221
|
-
|
|
222
|
-
#### Defined in
|
|
223
|
-
|
|
224
|
-
[packages/framework/esm-config/src/validators/validators.ts:55](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/validators/validators.ts#L55)
|
|
225
|
-
|
|
226
|
-
___
|
|
227
|
-
|
|
228
|
-
### isUrlWithTemplateParameters
|
|
229
|
-
|
|
230
|
-
▸ `Const` **isUrlWithTemplateParameters**(`allowedTemplateParameters`): [`Validator`](API.md#validator)
|
|
231
|
-
|
|
232
|
-
Verifies that a string contains only the default URL template
|
|
233
|
-
parameters, plus any specified in `allowedTemplateParameters`.
|
|
234
|
-
|
|
235
|
-
#### Parameters
|
|
236
|
-
|
|
237
|
-
| Name | Type | Description |
|
|
238
|
-
| :------ | :------ | :------ |
|
|
239
|
-
| `allowedTemplateParameters` | `string`[] | To be added to `openmrsBase` and `openmrsSpaBase` |
|
|
240
|
-
|
|
241
|
-
#### Returns
|
|
242
|
-
|
|
243
|
-
[`Validator`](API.md#validator)
|
|
244
|
-
|
|
245
|
-
#### Defined in
|
|
246
|
-
|
|
247
|
-
[packages/framework/esm-config/src/validators/validators.ts:23](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/validators/validators.ts#L23)
|
|
248
|
-
|
|
249
|
-
___
|
|
250
|
-
|
|
251
|
-
### navigate
|
|
252
|
-
|
|
253
|
-
▸ **navigate**(`__namedParameters`): `void`
|
|
254
|
-
|
|
255
|
-
Calls `location.assign` for non-SPA paths and [navigateToUrl](https://single-spa.js.org/docs/api/#navigatetourl) for SPA paths
|
|
256
|
-
|
|
257
|
-
Example usage:
|
|
258
|
-
```js
|
|
259
|
-
const config = getConfig();
|
|
260
|
-
const submitHandler = () => {
|
|
261
|
-
navigate({ to: config.links.submitSuccess });
|
|
262
|
-
};
|
|
263
|
-
```
|
|
264
|
-
|
|
265
|
-
#### Parameters
|
|
266
|
-
|
|
267
|
-
| Name | Type |
|
|
268
|
-
| :------ | :------ |
|
|
269
|
-
| `__namedParameters` | [`NavigateOptions`](interfaces/NavigateOptions.md) |
|
|
270
|
-
|
|
271
|
-
#### Returns
|
|
272
|
-
|
|
273
|
-
`void`
|
|
274
|
-
|
|
275
|
-
#### Defined in
|
|
276
|
-
|
|
277
|
-
[packages/framework/esm-config/src/navigation/navigate.ts:29](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/navigation/navigate.ts#L29)
|
|
278
|
-
|
|
279
|
-
___
|
|
280
|
-
|
|
281
|
-
## Other Functions
|
|
282
|
-
|
|
283
|
-
### defineConfigSchema
|
|
284
|
-
|
|
285
|
-
▸ **defineConfigSchema**(`moduleName`, `schema`): `void`
|
|
286
|
-
|
|
287
|
-
#### Parameters
|
|
288
|
-
|
|
289
|
-
| Name | Type |
|
|
290
|
-
| :------ | :------ |
|
|
291
|
-
| `moduleName` | `string` |
|
|
292
|
-
| `schema` | [`ConfigSchema`](interfaces/ConfigSchema.md) |
|
|
293
|
-
|
|
294
|
-
#### Returns
|
|
295
|
-
|
|
296
|
-
`void`
|
|
297
|
-
|
|
298
|
-
#### Defined in
|
|
299
|
-
|
|
300
|
-
[packages/framework/esm-config/src/module-config/module-config.ts:172](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/module-config/module-config.ts#L172)
|
|
301
|
-
|
|
302
|
-
___
|
|
303
|
-
|
|
304
|
-
### getConfig
|
|
305
|
-
|
|
306
|
-
▸ **getConfig**(`moduleName`): `Promise`<[`Config`](interfaces/Config.md)\>
|
|
307
|
-
|
|
308
|
-
A promise-based way to access the config as soon as it is fully loaded.
|
|
309
|
-
If it is already loaded, resolves the config in its present state.
|
|
310
|
-
|
|
311
|
-
In general you should use the Unistore-based API provided by
|
|
312
|
-
`getConfigStore`, which allows creating a subscription so that you always
|
|
313
|
-
have the latest config. If using React, just use `useConfig`.
|
|
314
|
-
|
|
315
|
-
This is a useful function if you need to get the config in the course
|
|
316
|
-
of the execution of a function.
|
|
317
|
-
|
|
318
|
-
#### Parameters
|
|
319
|
-
|
|
320
|
-
| Name | Type | Description |
|
|
321
|
-
| :------ | :------ | :------ |
|
|
322
|
-
| `moduleName` | `string` | The name of the module for which to look up the config |
|
|
323
|
-
|
|
324
|
-
#### Returns
|
|
325
|
-
|
|
326
|
-
`Promise`<[`Config`](interfaces/Config.md)\>
|
|
327
|
-
|
|
328
|
-
#### Defined in
|
|
329
|
-
|
|
330
|
-
[packages/framework/esm-config/src/module-config/module-config.ts:200](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/module-config/module-config.ts#L200)
|
|
331
|
-
|
|
332
|
-
___
|
|
333
|
-
|
|
334
|
-
### getConfigStore
|
|
335
|
-
|
|
336
|
-
▸ **getConfigStore**(`moduleName`): `Store`<[`ConfigStore`](interfaces/ConfigStore.md)\>
|
|
337
|
-
|
|
338
|
-
#### Parameters
|
|
339
|
-
|
|
340
|
-
| Name | Type |
|
|
341
|
-
| :------ | :------ |
|
|
342
|
-
| `moduleName` | `string` |
|
|
343
|
-
|
|
344
|
-
#### Returns
|
|
345
|
-
|
|
346
|
-
`Store`<[`ConfigStore`](interfaces/ConfigStore.md)\>
|
|
347
|
-
|
|
348
|
-
#### Defined in
|
|
349
|
-
|
|
350
|
-
[packages/framework/esm-config/src/module-config/state.ts:136](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/module-config/state.ts#L136)
|
|
351
|
-
|
|
352
|
-
___
|
|
353
|
-
|
|
354
|
-
### getExtensionConfigStore
|
|
355
|
-
|
|
356
|
-
▸ **getExtensionConfigStore**(`extensionSlotModuleName`, `attachedExtensionSlotName`, `extensionId`): `Store`<[`ConfigStore`](interfaces/ConfigStore.md)\>
|
|
357
|
-
|
|
358
|
-
#### Parameters
|
|
359
|
-
|
|
360
|
-
| Name | Type |
|
|
361
|
-
| :------ | :------ |
|
|
362
|
-
| `extensionSlotModuleName` | `string` |
|
|
363
|
-
| `attachedExtensionSlotName` | `string` |
|
|
364
|
-
| `extensionId` | `string` |
|
|
365
|
-
|
|
366
|
-
#### Returns
|
|
367
|
-
|
|
368
|
-
`Store`<[`ConfigStore`](interfaces/ConfigStore.md)\>
|
|
369
|
-
|
|
370
|
-
#### Defined in
|
|
371
|
-
|
|
372
|
-
[packages/framework/esm-config/src/module-config/state.ts:166](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/module-config/state.ts#L166)
|
|
373
|
-
|
|
374
|
-
___
|
|
375
|
-
|
|
376
|
-
### getExtensionSlotsConfigStore
|
|
377
|
-
|
|
378
|
-
▸ **getExtensionSlotsConfigStore**(`moduleName`): `Store`<[`ExtensionSlotConfigsStore`](interfaces/ExtensionSlotConfigsStore.md)\>
|
|
379
|
-
|
|
380
|
-
#### Parameters
|
|
381
|
-
|
|
382
|
-
| Name | Type |
|
|
383
|
-
| :------ | :------ |
|
|
384
|
-
| `moduleName` | `string` |
|
|
385
|
-
|
|
386
|
-
#### Returns
|
|
387
|
-
|
|
388
|
-
`Store`<[`ExtensionSlotConfigsStore`](interfaces/ExtensionSlotConfigsStore.md)\>
|
|
389
|
-
|
|
390
|
-
#### Defined in
|
|
391
|
-
|
|
392
|
-
[packages/framework/esm-config/src/module-config/state.ts:157](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/module-config/state.ts#L157)
|
|
393
|
-
|
|
394
|
-
___
|
|
395
|
-
|
|
396
|
-
### inRange
|
|
397
|
-
|
|
398
|
-
▸ `Const` **inRange**(`min`, `max`): [`Validator`](API.md#validator)
|
|
399
|
-
|
|
400
|
-
Verifies that the value is between the provided minimum and maximum
|
|
401
|
-
|
|
402
|
-
#### Parameters
|
|
403
|
-
|
|
404
|
-
| Name | Type | Description |
|
|
405
|
-
| :------ | :------ | :------ |
|
|
406
|
-
| `min` | `number` | Minimum acceptable value |
|
|
407
|
-
| `max` | `number` | Maximum acceptable value |
|
|
408
|
-
|
|
409
|
-
#### Returns
|
|
410
|
-
|
|
411
|
-
[`Validator`](API.md#validator)
|
|
412
|
-
|
|
413
|
-
#### Defined in
|
|
414
|
-
|
|
415
|
-
[packages/framework/esm-config/src/validators/validators.ts:9](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/validators/validators.ts#L9)
|
|
416
|
-
|
|
417
|
-
___
|
|
418
|
-
|
|
419
|
-
### processConfig
|
|
420
|
-
|
|
421
|
-
▸ **processConfig**(`schema`, `providedConfig`, `keyPathContext`, `devDefaultsAreOn?`): [`Config`](interfaces/Config.md)
|
|
422
|
-
|
|
423
|
-
Validate and interpolate defaults for `providedConfig` according to `schema`
|
|
424
|
-
|
|
425
|
-
#### Parameters
|
|
426
|
-
|
|
427
|
-
| Name | Type | Default value | Description |
|
|
428
|
-
| :------ | :------ | :------ | :------ |
|
|
429
|
-
| `schema` | [`ConfigSchema`](interfaces/ConfigSchema.md) | `undefined` | a configuration schema |
|
|
430
|
-
| `providedConfig` | [`ConfigObject`](interfaces/ConfigObject.md) | `undefined` | an object of config values (without the top-level module name) |
|
|
431
|
-
| `keyPathContext` | `string` | `undefined` | a dot-deparated string which helps the user figure out where the provided config came from |
|
|
432
|
-
| `devDefaultsAreOn` | `boolean` | `false` | - |
|
|
433
|
-
|
|
434
|
-
#### Returns
|
|
435
|
-
|
|
436
|
-
[`Config`](interfaces/Config.md)
|
|
437
|
-
|
|
438
|
-
#### Defined in
|
|
439
|
-
|
|
440
|
-
[packages/framework/esm-config/src/module-config/module-config.ts:222](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/module-config/module-config.ts#L222)
|
|
441
|
-
|
|
442
|
-
___
|
|
443
|
-
|
|
444
|
-
### provide
|
|
445
|
-
|
|
446
|
-
▸ **provide**(`config`, `sourceName?`): `void`
|
|
447
|
-
|
|
448
|
-
#### Parameters
|
|
449
|
-
|
|
450
|
-
| Name | Type | Default value |
|
|
451
|
-
| :------ | :------ | :------ |
|
|
452
|
-
| `config` | [`Config`](interfaces/Config.md) | `undefined` |
|
|
453
|
-
| `sourceName` | `string` | `"provided"` |
|
|
454
|
-
|
|
455
|
-
#### Returns
|
|
456
|
-
|
|
457
|
-
`void`
|
|
458
|
-
|
|
459
|
-
#### Defined in
|
|
460
|
-
|
|
461
|
-
[packages/framework/esm-config/src/module-config/module-config.ts:180](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/module-config/module-config.ts#L180)
|
|
462
|
-
|
|
463
|
-
___
|
|
464
|
-
|
|
465
|
-
### validator
|
|
466
|
-
|
|
467
|
-
▸ **validator**(`validationFunction`, `message`): [`Validator`](API.md#validator)
|
|
468
|
-
|
|
469
|
-
#### Parameters
|
|
470
|
-
|
|
471
|
-
| Name | Type |
|
|
472
|
-
| :------ | :------ |
|
|
473
|
-
| `validationFunction` | [`ValidatorFunction`](API.md#validatorfunction) |
|
|
474
|
-
| `message` | `string` |
|
|
475
|
-
|
|
476
|
-
#### Returns
|
|
477
|
-
|
|
478
|
-
[`Validator`](API.md#validator)
|
|
479
|
-
|
|
480
|
-
#### Defined in
|
|
481
|
-
|
|
482
|
-
[packages/framework/esm-config/src/validators/validator.ts:3](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/validators/validator.ts#L3)
|
package/docs/enums/Type.md
DELETED
|
@@ -1,85 +0,0 @@
|
|
|
1
|
-
[@openmrs/esm-config](../API.md) / Type
|
|
2
|
-
|
|
3
|
-
# Enumeration: Type
|
|
4
|
-
|
|
5
|
-
## Table of contents
|
|
6
|
-
|
|
7
|
-
### Enumeration members
|
|
8
|
-
|
|
9
|
-
- [Array](Type.md#array)
|
|
10
|
-
- [Boolean](Type.md#boolean)
|
|
11
|
-
- [ConceptUuid](Type.md#conceptuuid)
|
|
12
|
-
- [Number](Type.md#number)
|
|
13
|
-
- [Object](Type.md#object)
|
|
14
|
-
- [String](Type.md#string)
|
|
15
|
-
- [UUID](Type.md#uuid)
|
|
16
|
-
|
|
17
|
-
## Enumeration members
|
|
18
|
-
|
|
19
|
-
### Array
|
|
20
|
-
|
|
21
|
-
• **Array** = `"Array"`
|
|
22
|
-
|
|
23
|
-
#### Defined in
|
|
24
|
-
|
|
25
|
-
[packages/framework/esm-config/src/types.ts:2](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/types.ts#L2)
|
|
26
|
-
|
|
27
|
-
___
|
|
28
|
-
|
|
29
|
-
### Boolean
|
|
30
|
-
|
|
31
|
-
• **Boolean** = `"Boolean"`
|
|
32
|
-
|
|
33
|
-
#### Defined in
|
|
34
|
-
|
|
35
|
-
[packages/framework/esm-config/src/types.ts:3](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/types.ts#L3)
|
|
36
|
-
|
|
37
|
-
___
|
|
38
|
-
|
|
39
|
-
### ConceptUuid
|
|
40
|
-
|
|
41
|
-
• **ConceptUuid** = `"ConceptUuid"`
|
|
42
|
-
|
|
43
|
-
#### Defined in
|
|
44
|
-
|
|
45
|
-
[packages/framework/esm-config/src/types.ts:4](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/types.ts#L4)
|
|
46
|
-
|
|
47
|
-
___
|
|
48
|
-
|
|
49
|
-
### Number
|
|
50
|
-
|
|
51
|
-
• **Number** = `"Number"`
|
|
52
|
-
|
|
53
|
-
#### Defined in
|
|
54
|
-
|
|
55
|
-
[packages/framework/esm-config/src/types.ts:5](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/types.ts#L5)
|
|
56
|
-
|
|
57
|
-
___
|
|
58
|
-
|
|
59
|
-
### Object
|
|
60
|
-
|
|
61
|
-
• **Object** = `"Object"`
|
|
62
|
-
|
|
63
|
-
#### Defined in
|
|
64
|
-
|
|
65
|
-
[packages/framework/esm-config/src/types.ts:6](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/types.ts#L6)
|
|
66
|
-
|
|
67
|
-
___
|
|
68
|
-
|
|
69
|
-
### String
|
|
70
|
-
|
|
71
|
-
• **String** = `"String"`
|
|
72
|
-
|
|
73
|
-
#### Defined in
|
|
74
|
-
|
|
75
|
-
[packages/framework/esm-config/src/types.ts:7](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/types.ts#L7)
|
|
76
|
-
|
|
77
|
-
___
|
|
78
|
-
|
|
79
|
-
### UUID
|
|
80
|
-
|
|
81
|
-
• **UUID** = `"UUID"`
|
|
82
|
-
|
|
83
|
-
#### Defined in
|
|
84
|
-
|
|
85
|
-
[packages/framework/esm-config/src/types.ts:8](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/types.ts#L8)
|
|
@@ -1,182 +0,0 @@
|
|
|
1
|
-
[@openmrs/esm-config](../API.md) / Config
|
|
2
|
-
|
|
3
|
-
# Interface: Config
|
|
4
|
-
|
|
5
|
-
## Hierarchy
|
|
6
|
-
|
|
7
|
-
- `Object`
|
|
8
|
-
|
|
9
|
-
↳ **`Config`**
|
|
10
|
-
|
|
11
|
-
## Indexable
|
|
12
|
-
|
|
13
|
-
▪ [moduleName: `string`]: { [key: string]: `any`; }
|
|
14
|
-
|
|
15
|
-
## Table of contents
|
|
16
|
-
|
|
17
|
-
### Properties
|
|
18
|
-
|
|
19
|
-
- [constructor](Config.md#constructor)
|
|
20
|
-
|
|
21
|
-
### Methods
|
|
22
|
-
|
|
23
|
-
- [hasOwnProperty](Config.md#hasownproperty)
|
|
24
|
-
- [isPrototypeOf](Config.md#isprototypeof)
|
|
25
|
-
- [propertyIsEnumerable](Config.md#propertyisenumerable)
|
|
26
|
-
- [toLocaleString](Config.md#tolocalestring)
|
|
27
|
-
- [toString](Config.md#tostring)
|
|
28
|
-
- [valueOf](Config.md#valueof)
|
|
29
|
-
|
|
30
|
-
## Properties
|
|
31
|
-
|
|
32
|
-
### constructor
|
|
33
|
-
|
|
34
|
-
• **constructor**: `Function`
|
|
35
|
-
|
|
36
|
-
The initial value of Object.prototype.constructor is the standard built-in Object constructor.
|
|
37
|
-
|
|
38
|
-
#### Inherited from
|
|
39
|
-
|
|
40
|
-
Object.constructor
|
|
41
|
-
|
|
42
|
-
#### Defined in
|
|
43
|
-
|
|
44
|
-
node_modules/typescript/lib/lib.es5.d.ts:124
|
|
45
|
-
|
|
46
|
-
## Methods
|
|
47
|
-
|
|
48
|
-
### hasOwnProperty
|
|
49
|
-
|
|
50
|
-
▸ **hasOwnProperty**(`v`): `boolean`
|
|
51
|
-
|
|
52
|
-
Determines whether an object has a property with the specified name.
|
|
53
|
-
|
|
54
|
-
#### Parameters
|
|
55
|
-
|
|
56
|
-
| Name | Type | Description |
|
|
57
|
-
| :------ | :------ | :------ |
|
|
58
|
-
| `v` | `PropertyKey` | A property name. |
|
|
59
|
-
|
|
60
|
-
#### Returns
|
|
61
|
-
|
|
62
|
-
`boolean`
|
|
63
|
-
|
|
64
|
-
#### Inherited from
|
|
65
|
-
|
|
66
|
-
Object.hasOwnProperty
|
|
67
|
-
|
|
68
|
-
#### Defined in
|
|
69
|
-
|
|
70
|
-
node_modules/typescript/lib/lib.es5.d.ts:139
|
|
71
|
-
|
|
72
|
-
___
|
|
73
|
-
|
|
74
|
-
### isPrototypeOf
|
|
75
|
-
|
|
76
|
-
▸ **isPrototypeOf**(`v`): `boolean`
|
|
77
|
-
|
|
78
|
-
Determines whether an object exists in another object's prototype chain.
|
|
79
|
-
|
|
80
|
-
#### Parameters
|
|
81
|
-
|
|
82
|
-
| Name | Type | Description |
|
|
83
|
-
| :------ | :------ | :------ |
|
|
84
|
-
| `v` | `Object` | Another object whose prototype chain is to be checked. |
|
|
85
|
-
|
|
86
|
-
#### Returns
|
|
87
|
-
|
|
88
|
-
`boolean`
|
|
89
|
-
|
|
90
|
-
#### Inherited from
|
|
91
|
-
|
|
92
|
-
Object.isPrototypeOf
|
|
93
|
-
|
|
94
|
-
#### Defined in
|
|
95
|
-
|
|
96
|
-
node_modules/typescript/lib/lib.es5.d.ts:145
|
|
97
|
-
|
|
98
|
-
___
|
|
99
|
-
|
|
100
|
-
### propertyIsEnumerable
|
|
101
|
-
|
|
102
|
-
▸ **propertyIsEnumerable**(`v`): `boolean`
|
|
103
|
-
|
|
104
|
-
Determines whether a specified property is enumerable.
|
|
105
|
-
|
|
106
|
-
#### Parameters
|
|
107
|
-
|
|
108
|
-
| Name | Type | Description |
|
|
109
|
-
| :------ | :------ | :------ |
|
|
110
|
-
| `v` | `PropertyKey` | A property name. |
|
|
111
|
-
|
|
112
|
-
#### Returns
|
|
113
|
-
|
|
114
|
-
`boolean`
|
|
115
|
-
|
|
116
|
-
#### Inherited from
|
|
117
|
-
|
|
118
|
-
Object.propertyIsEnumerable
|
|
119
|
-
|
|
120
|
-
#### Defined in
|
|
121
|
-
|
|
122
|
-
node_modules/typescript/lib/lib.es5.d.ts:151
|
|
123
|
-
|
|
124
|
-
___
|
|
125
|
-
|
|
126
|
-
### toLocaleString
|
|
127
|
-
|
|
128
|
-
▸ **toLocaleString**(): `string`
|
|
129
|
-
|
|
130
|
-
Returns a date converted to a string using the current locale.
|
|
131
|
-
|
|
132
|
-
#### Returns
|
|
133
|
-
|
|
134
|
-
`string`
|
|
135
|
-
|
|
136
|
-
#### Inherited from
|
|
137
|
-
|
|
138
|
-
Object.toLocaleString
|
|
139
|
-
|
|
140
|
-
#### Defined in
|
|
141
|
-
|
|
142
|
-
node_modules/typescript/lib/lib.es5.d.ts:130
|
|
143
|
-
|
|
144
|
-
___
|
|
145
|
-
|
|
146
|
-
### toString
|
|
147
|
-
|
|
148
|
-
▸ **toString**(): `string`
|
|
149
|
-
|
|
150
|
-
Returns a string representation of an object.
|
|
151
|
-
|
|
152
|
-
#### Returns
|
|
153
|
-
|
|
154
|
-
`string`
|
|
155
|
-
|
|
156
|
-
#### Inherited from
|
|
157
|
-
|
|
158
|
-
Object.toString
|
|
159
|
-
|
|
160
|
-
#### Defined in
|
|
161
|
-
|
|
162
|
-
node_modules/typescript/lib/lib.es5.d.ts:127
|
|
163
|
-
|
|
164
|
-
___
|
|
165
|
-
|
|
166
|
-
### valueOf
|
|
167
|
-
|
|
168
|
-
▸ **valueOf**(): `Object`
|
|
169
|
-
|
|
170
|
-
Returns the primitive value of the specified object.
|
|
171
|
-
|
|
172
|
-
#### Returns
|
|
173
|
-
|
|
174
|
-
`Object`
|
|
175
|
-
|
|
176
|
-
#### Inherited from
|
|
177
|
-
|
|
178
|
-
Object.valueOf
|
|
179
|
-
|
|
180
|
-
#### Defined in
|
|
181
|
-
|
|
182
|
-
node_modules/typescript/lib/lib.es5.d.ts:133
|
|
@@ -1,182 +0,0 @@
|
|
|
1
|
-
[@openmrs/esm-config](../API.md) / ConfigObject
|
|
2
|
-
|
|
3
|
-
# Interface: ConfigObject
|
|
4
|
-
|
|
5
|
-
## Hierarchy
|
|
6
|
-
|
|
7
|
-
- `Object`
|
|
8
|
-
|
|
9
|
-
↳ **`ConfigObject`**
|
|
10
|
-
|
|
11
|
-
## Indexable
|
|
12
|
-
|
|
13
|
-
▪ [key: `string`]: `any`
|
|
14
|
-
|
|
15
|
-
## Table of contents
|
|
16
|
-
|
|
17
|
-
### Properties
|
|
18
|
-
|
|
19
|
-
- [constructor](ConfigObject.md#constructor)
|
|
20
|
-
|
|
21
|
-
### Methods
|
|
22
|
-
|
|
23
|
-
- [hasOwnProperty](ConfigObject.md#hasownproperty)
|
|
24
|
-
- [isPrototypeOf](ConfigObject.md#isprototypeof)
|
|
25
|
-
- [propertyIsEnumerable](ConfigObject.md#propertyisenumerable)
|
|
26
|
-
- [toLocaleString](ConfigObject.md#tolocalestring)
|
|
27
|
-
- [toString](ConfigObject.md#tostring)
|
|
28
|
-
- [valueOf](ConfigObject.md#valueof)
|
|
29
|
-
|
|
30
|
-
## Properties
|
|
31
|
-
|
|
32
|
-
### constructor
|
|
33
|
-
|
|
34
|
-
• **constructor**: `Function`
|
|
35
|
-
|
|
36
|
-
The initial value of Object.prototype.constructor is the standard built-in Object constructor.
|
|
37
|
-
|
|
38
|
-
#### Inherited from
|
|
39
|
-
|
|
40
|
-
Object.constructor
|
|
41
|
-
|
|
42
|
-
#### Defined in
|
|
43
|
-
|
|
44
|
-
node_modules/typescript/lib/lib.es5.d.ts:124
|
|
45
|
-
|
|
46
|
-
## Methods
|
|
47
|
-
|
|
48
|
-
### hasOwnProperty
|
|
49
|
-
|
|
50
|
-
▸ **hasOwnProperty**(`v`): `boolean`
|
|
51
|
-
|
|
52
|
-
Determines whether an object has a property with the specified name.
|
|
53
|
-
|
|
54
|
-
#### Parameters
|
|
55
|
-
|
|
56
|
-
| Name | Type | Description |
|
|
57
|
-
| :------ | :------ | :------ |
|
|
58
|
-
| `v` | `PropertyKey` | A property name. |
|
|
59
|
-
|
|
60
|
-
#### Returns
|
|
61
|
-
|
|
62
|
-
`boolean`
|
|
63
|
-
|
|
64
|
-
#### Inherited from
|
|
65
|
-
|
|
66
|
-
Object.hasOwnProperty
|
|
67
|
-
|
|
68
|
-
#### Defined in
|
|
69
|
-
|
|
70
|
-
node_modules/typescript/lib/lib.es5.d.ts:139
|
|
71
|
-
|
|
72
|
-
___
|
|
73
|
-
|
|
74
|
-
### isPrototypeOf
|
|
75
|
-
|
|
76
|
-
▸ **isPrototypeOf**(`v`): `boolean`
|
|
77
|
-
|
|
78
|
-
Determines whether an object exists in another object's prototype chain.
|
|
79
|
-
|
|
80
|
-
#### Parameters
|
|
81
|
-
|
|
82
|
-
| Name | Type | Description |
|
|
83
|
-
| :------ | :------ | :------ |
|
|
84
|
-
| `v` | `Object` | Another object whose prototype chain is to be checked. |
|
|
85
|
-
|
|
86
|
-
#### Returns
|
|
87
|
-
|
|
88
|
-
`boolean`
|
|
89
|
-
|
|
90
|
-
#### Inherited from
|
|
91
|
-
|
|
92
|
-
Object.isPrototypeOf
|
|
93
|
-
|
|
94
|
-
#### Defined in
|
|
95
|
-
|
|
96
|
-
node_modules/typescript/lib/lib.es5.d.ts:145
|
|
97
|
-
|
|
98
|
-
___
|
|
99
|
-
|
|
100
|
-
### propertyIsEnumerable
|
|
101
|
-
|
|
102
|
-
▸ **propertyIsEnumerable**(`v`): `boolean`
|
|
103
|
-
|
|
104
|
-
Determines whether a specified property is enumerable.
|
|
105
|
-
|
|
106
|
-
#### Parameters
|
|
107
|
-
|
|
108
|
-
| Name | Type | Description |
|
|
109
|
-
| :------ | :------ | :------ |
|
|
110
|
-
| `v` | `PropertyKey` | A property name. |
|
|
111
|
-
|
|
112
|
-
#### Returns
|
|
113
|
-
|
|
114
|
-
`boolean`
|
|
115
|
-
|
|
116
|
-
#### Inherited from
|
|
117
|
-
|
|
118
|
-
Object.propertyIsEnumerable
|
|
119
|
-
|
|
120
|
-
#### Defined in
|
|
121
|
-
|
|
122
|
-
node_modules/typescript/lib/lib.es5.d.ts:151
|
|
123
|
-
|
|
124
|
-
___
|
|
125
|
-
|
|
126
|
-
### toLocaleString
|
|
127
|
-
|
|
128
|
-
▸ **toLocaleString**(): `string`
|
|
129
|
-
|
|
130
|
-
Returns a date converted to a string using the current locale.
|
|
131
|
-
|
|
132
|
-
#### Returns
|
|
133
|
-
|
|
134
|
-
`string`
|
|
135
|
-
|
|
136
|
-
#### Inherited from
|
|
137
|
-
|
|
138
|
-
Object.toLocaleString
|
|
139
|
-
|
|
140
|
-
#### Defined in
|
|
141
|
-
|
|
142
|
-
node_modules/typescript/lib/lib.es5.d.ts:130
|
|
143
|
-
|
|
144
|
-
___
|
|
145
|
-
|
|
146
|
-
### toString
|
|
147
|
-
|
|
148
|
-
▸ **toString**(): `string`
|
|
149
|
-
|
|
150
|
-
Returns a string representation of an object.
|
|
151
|
-
|
|
152
|
-
#### Returns
|
|
153
|
-
|
|
154
|
-
`string`
|
|
155
|
-
|
|
156
|
-
#### Inherited from
|
|
157
|
-
|
|
158
|
-
Object.toString
|
|
159
|
-
|
|
160
|
-
#### Defined in
|
|
161
|
-
|
|
162
|
-
node_modules/typescript/lib/lib.es5.d.ts:127
|
|
163
|
-
|
|
164
|
-
___
|
|
165
|
-
|
|
166
|
-
### valueOf
|
|
167
|
-
|
|
168
|
-
▸ **valueOf**(): `Object`
|
|
169
|
-
|
|
170
|
-
Returns the primitive value of the specified object.
|
|
171
|
-
|
|
172
|
-
#### Returns
|
|
173
|
-
|
|
174
|
-
`Object`
|
|
175
|
-
|
|
176
|
-
#### Inherited from
|
|
177
|
-
|
|
178
|
-
Object.valueOf
|
|
179
|
-
|
|
180
|
-
#### Defined in
|
|
181
|
-
|
|
182
|
-
node_modules/typescript/lib/lib.es5.d.ts:133
|
|
@@ -1,45 +0,0 @@
|
|
|
1
|
-
[@openmrs/esm-config](../API.md) / ConfigSchema
|
|
2
|
-
|
|
3
|
-
# Interface: ConfigSchema
|
|
4
|
-
|
|
5
|
-
## Indexable
|
|
6
|
-
|
|
7
|
-
▪ [key: `string`]: [`ConfigSchema`](ConfigSchema.md) \| [`ConfigValue`](../API.md#configvalue)
|
|
8
|
-
|
|
9
|
-
## Table of contents
|
|
10
|
-
|
|
11
|
-
### Properties
|
|
12
|
-
|
|
13
|
-
- [\_elements](ConfigSchema.md#_elements)
|
|
14
|
-
- [\_type](ConfigSchema.md#_type)
|
|
15
|
-
- [\_validators](ConfigSchema.md#_validators)
|
|
16
|
-
|
|
17
|
-
## Properties
|
|
18
|
-
|
|
19
|
-
### \_elements
|
|
20
|
-
|
|
21
|
-
• `Optional` **\_elements**: [`ConfigSchema`](ConfigSchema.md)
|
|
22
|
-
|
|
23
|
-
#### Defined in
|
|
24
|
-
|
|
25
|
-
[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)
|
|
26
|
-
|
|
27
|
-
___
|
|
28
|
-
|
|
29
|
-
### \_type
|
|
30
|
-
|
|
31
|
-
• `Optional` **\_type**: [`Type`](../enums/Type.md)
|
|
32
|
-
|
|
33
|
-
#### Defined in
|
|
34
|
-
|
|
35
|
-
[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)
|
|
36
|
-
|
|
37
|
-
___
|
|
38
|
-
|
|
39
|
-
### \_validators
|
|
40
|
-
|
|
41
|
-
• `Optional` **\_validators**: [`Validator`](../API.md#validator)[]
|
|
42
|
-
|
|
43
|
-
#### Defined in
|
|
44
|
-
|
|
45
|
-
[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)
|
|
@@ -1,34 +0,0 @@
|
|
|
1
|
-
[@openmrs/esm-config](../API.md) / ConfigStore
|
|
2
|
-
|
|
3
|
-
# Interface: ConfigStore
|
|
4
|
-
|
|
5
|
-
Output configs
|
|
6
|
-
|
|
7
|
-
Each module has its own stores for its config and its extension slots' configs.
|
|
8
|
-
|
|
9
|
-
## Table of contents
|
|
10
|
-
|
|
11
|
-
### Properties
|
|
12
|
-
|
|
13
|
-
- [config](ConfigStore.md#config)
|
|
14
|
-
- [loaded](ConfigStore.md#loaded)
|
|
15
|
-
|
|
16
|
-
## Properties
|
|
17
|
-
|
|
18
|
-
### config
|
|
19
|
-
|
|
20
|
-
• **config**: ``null`` \| [`ConfigObject`](ConfigObject.md)
|
|
21
|
-
|
|
22
|
-
#### Defined in
|
|
23
|
-
|
|
24
|
-
[packages/framework/esm-config/src/module-config/state.ts:125](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/module-config/state.ts#L125)
|
|
25
|
-
|
|
26
|
-
___
|
|
27
|
-
|
|
28
|
-
### loaded
|
|
29
|
-
|
|
30
|
-
• **loaded**: `boolean`
|
|
31
|
-
|
|
32
|
-
#### Defined in
|
|
33
|
-
|
|
34
|
-
[packages/framework/esm-config/src/module-config/state.ts:126](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/module-config/state.ts#L126)
|
|
@@ -1,52 +0,0 @@
|
|
|
1
|
-
[@openmrs/esm-config](../API.md) / ExtensionSlotConfig
|
|
2
|
-
|
|
3
|
-
# Interface: ExtensionSlotConfig
|
|
4
|
-
|
|
5
|
-
## Table of contents
|
|
6
|
-
|
|
7
|
-
### Properties
|
|
8
|
-
|
|
9
|
-
- [add](ExtensionSlotConfig.md#add)
|
|
10
|
-
- [configure](ExtensionSlotConfig.md#configure)
|
|
11
|
-
- [order](ExtensionSlotConfig.md#order)
|
|
12
|
-
- [remove](ExtensionSlotConfig.md#remove)
|
|
13
|
-
|
|
14
|
-
## Properties
|
|
15
|
-
|
|
16
|
-
### add
|
|
17
|
-
|
|
18
|
-
• `Optional` **add**: `string`[]
|
|
19
|
-
|
|
20
|
-
#### Defined in
|
|
21
|
-
|
|
22
|
-
[packages/framework/esm-config/src/types.ts:39](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/types.ts#L39)
|
|
23
|
-
|
|
24
|
-
___
|
|
25
|
-
|
|
26
|
-
### configure
|
|
27
|
-
|
|
28
|
-
• `Optional` **configure**: [`ExtensionSlotConfigureValueObject`](ExtensionSlotConfigureValueObject.md)
|
|
29
|
-
|
|
30
|
-
#### Defined in
|
|
31
|
-
|
|
32
|
-
[packages/framework/esm-config/src/types.ts:42](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/types.ts#L42)
|
|
33
|
-
|
|
34
|
-
___
|
|
35
|
-
|
|
36
|
-
### order
|
|
37
|
-
|
|
38
|
-
• `Optional` **order**: `string`[]
|
|
39
|
-
|
|
40
|
-
#### Defined in
|
|
41
|
-
|
|
42
|
-
[packages/framework/esm-config/src/types.ts:41](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/types.ts#L41)
|
|
43
|
-
|
|
44
|
-
___
|
|
45
|
-
|
|
46
|
-
### remove
|
|
47
|
-
|
|
48
|
-
• `Optional` **remove**: `string`[]
|
|
49
|
-
|
|
50
|
-
#### Defined in
|
|
51
|
-
|
|
52
|
-
[packages/framework/esm-config/src/types.ts:40](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/types.ts#L40)
|
|
@@ -1,41 +0,0 @@
|
|
|
1
|
-
[@openmrs/esm-config](../API.md) / ExtensionSlotConfigObject
|
|
2
|
-
|
|
3
|
-
# Interface: ExtensionSlotConfigObject
|
|
4
|
-
|
|
5
|
-
## Table of contents
|
|
6
|
-
|
|
7
|
-
### Properties
|
|
8
|
-
|
|
9
|
-
- [add](ExtensionSlotConfigObject.md#add)
|
|
10
|
-
- [order](ExtensionSlotConfigObject.md#order)
|
|
11
|
-
- [remove](ExtensionSlotConfigObject.md#remove)
|
|
12
|
-
|
|
13
|
-
## Properties
|
|
14
|
-
|
|
15
|
-
### add
|
|
16
|
-
|
|
17
|
-
• `Optional` **add**: `string`[]
|
|
18
|
-
|
|
19
|
-
#### Defined in
|
|
20
|
-
|
|
21
|
-
[packages/framework/esm-config/src/types.ts:50](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/types.ts#L50)
|
|
22
|
-
|
|
23
|
-
___
|
|
24
|
-
|
|
25
|
-
### order
|
|
26
|
-
|
|
27
|
-
• `Optional` **order**: `string`[]
|
|
28
|
-
|
|
29
|
-
#### Defined in
|
|
30
|
-
|
|
31
|
-
[packages/framework/esm-config/src/types.ts:52](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/types.ts#L52)
|
|
32
|
-
|
|
33
|
-
___
|
|
34
|
-
|
|
35
|
-
### remove
|
|
36
|
-
|
|
37
|
-
• `Optional` **remove**: `string`[]
|
|
38
|
-
|
|
39
|
-
#### Defined in
|
|
40
|
-
|
|
41
|
-
[packages/framework/esm-config/src/types.ts:51](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/types.ts#L51)
|
|
@@ -1,32 +0,0 @@
|
|
|
1
|
-
[@openmrs/esm-config](../API.md) / ExtensionSlotConfigsStore
|
|
2
|
-
|
|
3
|
-
# Interface: ExtensionSlotConfigsStore
|
|
4
|
-
|
|
5
|
-
## Table of contents
|
|
6
|
-
|
|
7
|
-
### Properties
|
|
8
|
-
|
|
9
|
-
- [extensionSlotConfigs](ExtensionSlotConfigsStore.md#extensionslotconfigs)
|
|
10
|
-
- [loaded](ExtensionSlotConfigsStore.md#loaded)
|
|
11
|
-
|
|
12
|
-
## Properties
|
|
13
|
-
|
|
14
|
-
### extensionSlotConfigs
|
|
15
|
-
|
|
16
|
-
• **extensionSlotConfigs**: `Record`<`string`, [`ExtensionSlotConfigObject`](ExtensionSlotConfigObject.md)\>
|
|
17
|
-
|
|
18
|
-
Configs for each extension slot in the module, indexed by slot name
|
|
19
|
-
|
|
20
|
-
#### Defined in
|
|
21
|
-
|
|
22
|
-
[packages/framework/esm-config/src/module-config/state.ts:146](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/module-config/state.ts#L146)
|
|
23
|
-
|
|
24
|
-
___
|
|
25
|
-
|
|
26
|
-
### loaded
|
|
27
|
-
|
|
28
|
-
• **loaded**: `boolean`
|
|
29
|
-
|
|
30
|
-
#### Defined in
|
|
31
|
-
|
|
32
|
-
[packages/framework/esm-config/src/module-config/state.ts:147](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/module-config/state.ts#L147)
|
|
@@ -1,19 +0,0 @@
|
|
|
1
|
-
[@openmrs/esm-config](../API.md) / ImplementerToolsConfigStore
|
|
2
|
-
|
|
3
|
-
# Interface: ImplementerToolsConfigStore
|
|
4
|
-
|
|
5
|
-
## Table of contents
|
|
6
|
-
|
|
7
|
-
### Properties
|
|
8
|
-
|
|
9
|
-
- [config](ImplementerToolsConfigStore.md#config)
|
|
10
|
-
|
|
11
|
-
## Properties
|
|
12
|
-
|
|
13
|
-
### config
|
|
14
|
-
|
|
15
|
-
• **config**: [`Config`](Config.md)
|
|
16
|
-
|
|
17
|
-
#### Defined in
|
|
18
|
-
|
|
19
|
-
[packages/framework/esm-config/src/module-config/state.ts:179](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/module-config/state.ts#L179)
|
|
@@ -1,19 +0,0 @@
|
|
|
1
|
-
[@openmrs/esm-config](../API.md) / NavigateOptions
|
|
2
|
-
|
|
3
|
-
# Interface: NavigateOptions
|
|
4
|
-
|
|
5
|
-
## Table of contents
|
|
6
|
-
|
|
7
|
-
### Properties
|
|
8
|
-
|
|
9
|
-
- [to](NavigateOptions.md#to)
|
|
10
|
-
|
|
11
|
-
## Properties
|
|
12
|
-
|
|
13
|
-
### to
|
|
14
|
-
|
|
15
|
-
• **to**: `string`
|
|
16
|
-
|
|
17
|
-
#### Defined in
|
|
18
|
-
|
|
19
|
-
[packages/framework/esm-config/src/navigation/navigate.ts:10](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/navigation/navigate.ts#L10)
|