@openmrs/esm-state 3.1.15-pre.701 → 3.1.15-pre.707

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/README.md +0 -2
  2. package/package.json +2 -3
  3. package/docs/API.md +0 -153
  4. package/docs/interfaces/AppState.md +0 -3
  5. package/typedoc.json +0 -7
package/README.md CHANGED
@@ -5,7 +5,5 @@ openmrs-esm-state provides functions for managing OpenMRS state using
5
5
 
6
6
  It also provides a global Unistore store called `app`.
7
7
 
8
- [API Docs](docs/API.md)
9
-
10
8
  Please see the Developer Documentation page on
11
9
  [Managing State](https://openmrs.github.io/openmrs-esm-core/#/main/state).
package/package.json CHANGED
@@ -1,13 +1,12 @@
1
1
  {
2
2
  "name": "@openmrs/esm-state",
3
- "version": "3.1.15-pre.701",
3
+ "version": "3.1.15-pre.707",
4
4
  "license": "MPL-2.0",
5
5
  "description": "Frontend stores & state management for OpenMRS",
6
6
  "browser": "dist/openmrs-esm-state.js",
7
7
  "main": "src/index.ts",
8
8
  "source": true,
9
9
  "scripts": {
10
- "document": "../../../document.sh esm-state",
11
10
  "test": "jest --config jest.config.js --passWithNoTests",
12
11
  "build": "webpack --mode=production",
13
12
  "analyze": "webpack --mode=production --env analyze=true",
@@ -39,5 +38,5 @@
39
38
  "dependencies": {
40
39
  "unistore": "^3.5.2"
41
40
  },
42
- "gitHead": "e328688472e77d868191c0a37c4555fbedb9aafa"
41
+ "gitHead": "99cb20e45f6d6ff7c7b8dc451a0cccd9c885083e"
43
42
  }
package/docs/API.md DELETED
@@ -1,153 +0,0 @@
1
- [Back to README.md](../README.md)
2
-
3
- # @openmrs/esm-state
4
-
5
- ## Table of contents
6
-
7
- ### Interfaces
8
-
9
- - [AppState](interfaces/AppState.md)
10
-
11
- ### Functions
12
-
13
- - [createGlobalStore](API.md#createglobalstore)
14
- - [getAppState](API.md#getappstate)
15
- - [getGlobalStore](API.md#getglobalstore)
16
- - [subscribeTo](API.md#subscribeto)
17
- - [update](API.md#update)
18
-
19
- ## Functions
20
-
21
- ### createGlobalStore
22
-
23
- ▸ **createGlobalStore**<`TState`\>(`name`, `initialState`): `Store`<`TState`\>
24
-
25
- Creates a Unistore [store](https://github.com/developit/unistore#store).
26
-
27
- #### Type parameters
28
-
29
- | Name |
30
- | :------ |
31
- | `TState` |
32
-
33
- #### Parameters
34
-
35
- | Name | Type | Description |
36
- | :------ | :------ | :------ |
37
- | `name` | `string` | A name by which the store can be looked up later. Must be unique across the entire application. |
38
- | `initialState` | `TState` | An object which will be the initial state of the store. |
39
-
40
- #### Returns
41
-
42
- `Store`<`TState`\>
43
-
44
- The newly created store.
45
-
46
- #### Defined in
47
-
48
- [state.ts:18](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-state/src/state.ts#L18)
49
-
50
- ___
51
-
52
- ### getAppState
53
-
54
- ▸ **getAppState**(): `Store`<[`AppState`](interfaces/AppState.md)\>
55
-
56
- #### Returns
57
-
58
- `Store`<[`AppState`](interfaces/AppState.md)\>
59
-
60
- The [store](https://github.com/developit/unistore#store) named `app`.
61
-
62
- #### Defined in
63
-
64
- [state.ts:85](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-state/src/state.ts#L85)
65
-
66
- ___
67
-
68
- ### getGlobalStore
69
-
70
- ▸ **getGlobalStore**<`TState`\>(`name`, `fallbackState?`): `Store`<`TState`\>
71
-
72
- Returns the existing [store](https://github.com/developit/unistore#store) named `name`,
73
- or creates a new store named `name` if none exists.
74
-
75
- #### Type parameters
76
-
77
- | Name | Type |
78
- | :------ | :------ |
79
- | `TState` | `any` |
80
-
81
- #### Parameters
82
-
83
- | Name | Type | Description |
84
- | :------ | :------ | :------ |
85
- | `name` | `string` | The name of the store to look up. |
86
- | `fallbackState?` | `TState` | The initial value of the new store if no store named `name` exists. |
87
-
88
- #### Returns
89
-
90
- `Store`<`TState`\>
91
-
92
- The found or newly created store.
93
-
94
- #### Defined in
95
-
96
- [state.ts:55](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-state/src/state.ts#L55)
97
-
98
- ___
99
-
100
- ### subscribeTo
101
-
102
- ▸ **subscribeTo**<`T`, `U`\>(`store`, `select`, `handle`): `Unsubscribe`
103
-
104
- #### Type parameters
105
-
106
- | Name |
107
- | :------ |
108
- | `T` |
109
- | `U` |
110
-
111
- #### Parameters
112
-
113
- | Name | Type |
114
- | :------ | :------ |
115
- | `store` | `Store`<`T`\> |
116
- | `select` | (`state`: `T`) => `U` |
117
- | `handle` | (`subState`: `U`) => `void` |
118
-
119
- #### Returns
120
-
121
- `Unsubscribe`
122
-
123
- #### Defined in
124
-
125
- [state.ts:89](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-state/src/state.ts#L89)
126
-
127
- ___
128
-
129
- ### update
130
-
131
- ▸ **update**<`T`\>(`obj`, `__namedParameters`, `value`): `T`
132
-
133
- #### Type parameters
134
-
135
- | Name | Type |
136
- | :------ | :------ |
137
- | `T` | extends `Record`<`string`, `any`\> |
138
-
139
- #### Parameters
140
-
141
- | Name | Type |
142
- | :------ | :------ |
143
- | `obj` | `T` |
144
- | `__namedParameters` | `string`[] |
145
- | `value` | `any` |
146
-
147
- #### Returns
148
-
149
- `T`
150
-
151
- #### Defined in
152
-
153
- [update.ts:1](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-state/src/update.ts#L1)
package/docs/interfaces/AppState.md DELETED
@@ -1,3 +0,0 @@
1
- [@openmrs/esm-state](../API.md) / AppState
2
-
3
- # Interface: AppState
package/typedoc.json DELETED
@@ -1,7 +0,0 @@
1
- {
2
- "out": "docs",
3
- "readme": "none",
4
- "excludeInternal": true,
5
- "gitRevision": "master",
6
- "entryDocument": "API.md"
7
- }