@openmrs/esm-framework 8.0.1-pre.3638 → 8.0.1-pre.3646

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.
Files changed (5) hide show
  1. package/.turbo/turbo-build.log +1 -1
  2. package/dist/openmrs-esm-framework.js +1 -1
  3. package/dist/openmrs-esm-framework.js.map +1 -1
  4. package/docs/functions/subscribeOpenmrsEvent.md +33 -15
  5. package/package.json +20 -20
package/docs/functions/subscribeOpenmrsEvent.md CHANGED
@@ -2,36 +2,54 @@
2
2
 
3
3
  # Function: subscribeOpenmrsEvent()
4
4
 
5
- > **subscribeOpenmrsEvent**\<`T`\>(`event`, `handler`): () => `void`
5
+ ## Call Signature
6
6
 
7
- Defined in: [packages/framework/esm-emr-api/src/events/index.ts:24](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/events/index.ts#L24)
7
+ > **subscribeOpenmrsEvent**(`event`, `handler`): `any`
8
+
9
+ Defined in: [packages/framework/esm-emr-api/src/events/index.ts:30](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/events/index.ts#L30)
8
10
 
9
11
  Subscribes to a custom OpenMRS event
10
12
 
11
- ## Type Parameters
13
+ ### Parameters
12
14
 
13
- ### T
15
+ #### event
14
16
 
15
- `T` *extends* keyof [`OpenmrsEventTypes`](../interfaces/OpenmrsEventTypes.md)
17
+ `"started"`
16
18
 
17
- ## Parameters
19
+ The name of the event to listen to
18
20
 
19
- ### event
21
+ #### handler
20
22
 
21
- `T`
23
+ (`payload`) => `void`
22
24
 
23
- The name of the event to listen to
25
+ The callback to be called when the event fires
24
26
 
25
- ### handler
27
+ ### Returns
26
28
 
27
- (`payload?`) => `boolean` \| `void`
29
+ `any`
28
30
 
29
- The callback to be called when the event fires
31
+ ## Call Signature
32
+
33
+ > **subscribeOpenmrsEvent**(`event`, `handler`): `any`
30
34
 
31
- ## Returns
35
+ Defined in: [packages/framework/esm-emr-api/src/events/index.ts:31](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/events/index.ts#L31)
36
+
37
+ Subscribes to a custom OpenMRS event
32
38
 
33
- > (): `void`
39
+ ### Parameters
40
+
41
+ #### event
42
+
43
+ `"before-page-changed"`
44
+
45
+ The name of the event to listen to
46
+
47
+ #### handler
48
+
49
+ (`payload`) => `void`
50
+
51
+ The callback to be called when the event fires
34
52
 
35
53
  ### Returns
36
54
 
37
- `void`
55
+ `any`
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openmrs/esm-framework",
3
- "version": "8.0.1-pre.3638",
3
+ "version": "8.0.1-pre.3646",
4
4
  "license": "MPL-2.0",
5
5
  "type": "module",
6
6
  "module": "dist/openmrs-esm-framework.js",
@@ -60,24 +60,24 @@
60
60
  "access": "public"
61
61
  },
62
62
  "dependencies": {
63
- "@openmrs/esm-api": "8.0.1-pre.3638",
64
- "@openmrs/esm-config": "8.0.1-pre.3638",
65
- "@openmrs/esm-context": "8.0.1-pre.3638",
66
- "@openmrs/esm-dynamic-loading": "8.0.1-pre.3638",
67
- "@openmrs/esm-emr-api": "8.0.1-pre.3638",
68
- "@openmrs/esm-error-handling": "8.0.1-pre.3638",
69
- "@openmrs/esm-expression-evaluator": "8.0.1-pre.3638",
70
- "@openmrs/esm-extensions": "8.0.1-pre.3638",
71
- "@openmrs/esm-feature-flags": "8.0.1-pre.3638",
72
- "@openmrs/esm-globals": "8.0.1-pre.3638",
73
- "@openmrs/esm-navigation": "8.0.1-pre.3638",
74
- "@openmrs/esm-offline": "8.0.1-pre.3638",
75
- "@openmrs/esm-react-utils": "8.0.1-pre.3638",
76
- "@openmrs/esm-routes": "8.0.1-pre.3638",
77
- "@openmrs/esm-state": "8.0.1-pre.3638",
78
- "@openmrs/esm-styleguide": "8.0.1-pre.3638",
79
- "@openmrs/esm-translations": "8.0.1-pre.3638",
80
- "@openmrs/esm-utils": "8.0.1-pre.3638"
63
+ "@openmrs/esm-api": "8.0.1-pre.3646",
64
+ "@openmrs/esm-config": "8.0.1-pre.3646",
65
+ "@openmrs/esm-context": "8.0.1-pre.3646",
66
+ "@openmrs/esm-dynamic-loading": "8.0.1-pre.3646",
67
+ "@openmrs/esm-emr-api": "8.0.1-pre.3646",
68
+ "@openmrs/esm-error-handling": "8.0.1-pre.3646",
69
+ "@openmrs/esm-expression-evaluator": "8.0.1-pre.3646",
70
+ "@openmrs/esm-extensions": "8.0.1-pre.3646",
71
+ "@openmrs/esm-feature-flags": "8.0.1-pre.3646",
72
+ "@openmrs/esm-globals": "8.0.1-pre.3646",
73
+ "@openmrs/esm-navigation": "8.0.1-pre.3646",
74
+ "@openmrs/esm-offline": "8.0.1-pre.3646",
75
+ "@openmrs/esm-react-utils": "8.0.1-pre.3646",
76
+ "@openmrs/esm-routes": "8.0.1-pre.3646",
77
+ "@openmrs/esm-state": "8.0.1-pre.3646",
78
+ "@openmrs/esm-styleguide": "8.0.1-pre.3646",
79
+ "@openmrs/esm-translations": "8.0.1-pre.3646",
80
+ "@openmrs/esm-utils": "8.0.1-pre.3646"
81
81
  },
82
82
  "peerDependencies": {
83
83
  "dayjs": "1.x",
@@ -90,7 +90,7 @@
90
90
  "swr": "2.x"
91
91
  },
92
92
  "devDependencies": {
93
- "@openmrs/typedoc-plugin-file-categories": "8.0.1-pre.3638",
93
+ "@openmrs/typedoc-plugin-file-categories": "8.0.1-pre.3646",
94
94
  "@rspack/cli": "^1.3.11",
95
95
  "@rspack/core": "^1.3.11",
96
96
  "@vitest/coverage-v8": "^4.0.7",