@genesislcap/foundation-comms 14.187.1-alpha-3406925.0 → 14.187.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (156) hide show
  1. package/dist/dts/connect/connect.d.ts +6 -11
  2. package/dist/dts/connect/connect.d.ts.map +1 -1
  3. package/dist/dts/connect/http.connect.d.ts +2 -2
  4. package/dist/dts/connect/http.connect.d.ts.map +1 -1
  5. package/dist/dts/connect/message.d.ts +0 -11
  6. package/dist/dts/connect/message.d.ts.map +1 -1
  7. package/dist/dts/connect/socket.d.ts +2 -6
  8. package/dist/dts/connect/socket.d.ts.map +1 -1
  9. package/dist/dts/datasource/datasource.d.ts +19 -49
  10. package/dist/dts/datasource/datasource.d.ts.map +1 -1
  11. package/dist/dts/datasource/datasource.types.d.ts +22 -14
  12. package/dist/dts/datasource/datasource.types.d.ts.map +1 -1
  13. package/dist/dts/datasource/entityDatasource.d.ts +8 -5
  14. package/dist/dts/datasource/entityDatasource.d.ts.map +1 -1
  15. package/dist/dts/datasource/index.d.ts +0 -2
  16. package/dist/dts/datasource/index.d.ts.map +1 -1
  17. package/dist/dts/index.d.ts +0 -1
  18. package/dist/dts/index.d.ts.map +1 -1
  19. package/dist/dts/testing/mocks/auth/auth.d.ts +0 -3
  20. package/dist/dts/testing/mocks/auth/auth.d.ts.map +1 -1
  21. package/dist/dts/testing/mocks/connect/connect.d.ts +2 -3
  22. package/dist/dts/testing/mocks/connect/connect.d.ts.map +1 -1
  23. package/dist/dts/testing/mocks/connect/socket.d.ts +0 -1
  24. package/dist/dts/testing/mocks/connect/socket.d.ts.map +1 -1
  25. package/dist/dts/testing/mocks/datasource/datasource.d.ts +4 -22
  26. package/dist/dts/testing/mocks/datasource/datasource.d.ts.map +1 -1
  27. package/dist/dts/testing/mocks/index.d.ts +0 -1
  28. package/dist/dts/testing/mocks/index.d.ts.map +1 -1
  29. package/dist/esm/connect/connect.js +15 -12
  30. package/dist/esm/connect/http.connect.js +3 -5
  31. package/dist/esm/connect/message.js +0 -2
  32. package/dist/esm/connect/socket.js +6 -19
  33. package/dist/esm/datasource/datasource.js +58 -133
  34. package/dist/esm/datasource/datasource.types.js +18 -2
  35. package/dist/esm/datasource/entityDatasource.js +0 -6
  36. package/dist/esm/datasource/index.js +0 -2
  37. package/dist/esm/index.js +0 -1
  38. package/dist/esm/testing/mocks/auth/auth.js +0 -10
  39. package/dist/esm/testing/mocks/connect/connect.js +2 -9
  40. package/dist/esm/testing/mocks/connect/socket.js +0 -2
  41. package/dist/esm/testing/mocks/datasource/datasource.js +0 -59
  42. package/dist/esm/testing/mocks/index.js +0 -1
  43. package/dist/foundation-comms.api.json +6042 -10797
  44. package/dist/foundation-comms.d.ts +37 -696
  45. package/docs/api/foundation-comms.connect.connect.md +2 -2
  46. package/docs/api/foundation-comms.connect.getavailableresources.md +2 -2
  47. package/docs/api/foundation-comms.connect.md +0 -1
  48. package/docs/api/{foundation-comms.datasource.status.md → foundation-comms.datasource.fieldmetadata.md} +4 -3
  49. package/docs/api/foundation-comms.datasource.init.md +2 -2
  50. package/docs/api/foundation-comms.datasource.md +2 -3
  51. package/docs/api/foundation-comms.datasourceconfig.md +1 -2
  52. package/docs/api/foundation-comms.defaultconnect.connect.md +2 -2
  53. package/docs/api/foundation-comms.defaultconnect.getavailableresources.md +2 -2
  54. package/docs/api/foundation-comms.defaultconnect.md +0 -1
  55. package/docs/api/foundation-comms.defaultdatasource._constructor_.md +2 -3
  56. package/docs/api/{foundation-comms.defaultdatasource.fetchmetadatarequired.md → foundation-comms.defaultdatasource._stream.md} +3 -4
  57. package/docs/api/foundation-comms.defaultdatasource.availableindexes.md +1 -2
  58. package/docs/api/foundation-comms.defaultdatasource.fieldmetadata.md +0 -1
  59. package/docs/api/foundation-comms.defaultdatasource.initialized.md +1 -3
  60. package/docs/api/foundation-comms.defaultdatasource.md +7 -10
  61. package/docs/api/foundation-comms.defaultdatasource.originalfielddef.md +1 -2
  62. package/docs/api/foundation-comms.defaultdatasource.requestfields.md +1 -2
  63. package/docs/api/foundation-comms.defaultdatasource.stream.md +1 -1
  64. package/docs/api/foundation-comms.defaultdatasource.validresourcename.md +0 -5
  65. package/docs/api/foundation-comms.defaultdatasourceconfig.md +1 -1
  66. package/docs/api/foundation-comms.defaulthttpconnect.getavailableresources.md +2 -2
  67. package/docs/api/foundation-comms.defaultsocket._constructor_.md +1 -2
  68. package/docs/api/foundation-comms.defaultsocket.connect.md +2 -2
  69. package/docs/api/foundation-comms.defaultsocket.md +1 -3
  70. package/docs/api/foundation-comms.eventmessagetype.md +0 -2
  71. package/docs/api/foundation-comms.md +2 -19
  72. package/docs/api/foundation-comms.socket.md +0 -6
  73. package/docs/api-report.md +25 -550
  74. package/package.json +12 -13
  75. package/dist/dts/datasource/datasource.config.d.ts +0 -44
  76. package/dist/dts/datasource/datasource.config.d.ts.map +0 -1
  77. package/dist/dts/datasource/datasource.mixins.d.ts +0 -367
  78. package/dist/dts/datasource/datasource.mixins.d.ts.map +0 -1
  79. package/dist/dts/resources/genesis/config.d.ts +0 -81
  80. package/dist/dts/resources/genesis/config.d.ts.map +0 -1
  81. package/dist/dts/resources/genesis/genesis.d.ts +0 -69
  82. package/dist/dts/resources/genesis/genesis.d.ts.map +0 -1
  83. package/dist/dts/resources/genesis/index.d.ts +0 -4
  84. package/dist/dts/resources/genesis/index.d.ts.map +0 -1
  85. package/dist/dts/resources/genesis/types.d.ts +0 -19
  86. package/dist/dts/resources/genesis/types.d.ts.map +0 -1
  87. package/dist/dts/resources/index.d.ts +0 -2
  88. package/dist/dts/resources/index.d.ts.map +0 -1
  89. package/dist/dts/testing/mocks/resources/genesis/genesis.d.ts +0 -16
  90. package/dist/dts/testing/mocks/resources/genesis/genesis.d.ts.map +0 -1
  91. package/dist/dts/testing/mocks/resources/genesis/index.d.ts +0 -2
  92. package/dist/dts/testing/mocks/resources/genesis/index.d.ts.map +0 -1
  93. package/dist/dts/testing/mocks/resources/index.d.ts +0 -2
  94. package/dist/dts/testing/mocks/resources/index.d.ts.map +0 -1
  95. package/dist/esm/datasource/datasource.config.js +0 -41
  96. package/dist/esm/datasource/datasource.mixins.js +0 -86
  97. package/dist/esm/resources/genesis/config.js +0 -51
  98. package/dist/esm/resources/genesis/genesis.js +0 -114
  99. package/dist/esm/resources/genesis/index.js +0 -3
  100. package/dist/esm/resources/genesis/types.js +0 -4
  101. package/dist/esm/resources/index.js +0 -1
  102. package/dist/esm/testing/mocks/resources/genesis/genesis.js +0 -25
  103. package/dist/esm/testing/mocks/resources/genesis/index.js +0 -1
  104. package/dist/esm/testing/mocks/resources/index.js +0 -1
  105. package/docs/api/foundation-comms.connect.host.md +0 -11
  106. package/docs/api/foundation-comms.datasourceconfig.eventemitter.md +0 -18
  107. package/docs/api/foundation-comms.datasourceeventhandler.md +0 -353
  108. package/docs/api/foundation-comms.datasourcemetadata.availableindexes.md +0 -11
  109. package/docs/api/foundation-comms.datasourcemetadata.fetchmetadatarequired.md +0 -11
  110. package/docs/api/foundation-comms.datasourcemetadata.fieldmetadata.md +0 -11
  111. package/docs/api/foundation-comms.datasourcemetadata.md +0 -24
  112. package/docs/api/foundation-comms.datasourcemetadata.originalfielddef.md +0 -11
  113. package/docs/api/foundation-comms.datasourcemetadata.requestfields.md +0 -11
  114. package/docs/api/foundation-comms.datasourcestatus.md +0 -21
  115. package/docs/api/foundation-comms.datasourcestatuschanged.md +0 -13
  116. package/docs/api/foundation-comms.datasourcestatuschangedevent.md +0 -15
  117. package/docs/api/foundation-comms.defaultconnect.host.md +0 -11
  118. package/docs/api/foundation-comms.defaultdatasource.fetchandapplymetadata.md +0 -22
  119. package/docs/api/foundation-comms.defaultdatasource.resources.md +0 -11
  120. package/docs/api/foundation-comms.defaultdatasource.status.md +0 -12
  121. package/docs/api/foundation-comms.defaultgenesisresources._constructor_.md +0 -21
  122. package/docs/api/foundation-comms.defaultgenesisresources.config.md +0 -11
  123. package/docs/api/foundation-comms.defaultgenesisresources.connect.md +0 -11
  124. package/docs/api/foundation-comms.defaultgenesisresources.destroy.md +0 -17
  125. package/docs/api/foundation-comms.defaultgenesisresources.getresources.md +0 -15
  126. package/docs/api/foundation-comms.defaultgenesisresources.getresourcetypefor.md +0 -24
  127. package/docs/api/foundation-comms.defaultgenesisresources.isvalidresource.md +0 -24
  128. package/docs/api/foundation-comms.defaultgenesisresources.md +0 -40
  129. package/docs/api/foundation-comms.defaultgenesisresources.postloadedmessage.md +0 -15
  130. package/docs/api/foundation-comms.defaultgenesisresources.resources.md +0 -11
  131. package/docs/api/foundation-comms.defaultgenesisresources.resourcespromise.md +0 -11
  132. package/docs/api/foundation-comms.defaultgenesisresourcesconfig.md +0 -13
  133. package/docs/api/foundation-comms.defaultsocket.config.md +0 -11
  134. package/docs/api/foundation-comms.defaultsocket.host.md +0 -11
  135. package/docs/api/foundation-comms.genesisresources.destroy.md +0 -13
  136. package/docs/api/foundation-comms.genesisresources.getresourcetypefor.md +0 -13
  137. package/docs/api/foundation-comms.genesisresources.isvalidresource.md +0 -13
  138. package/docs/api/foundation-comms.genesisresources.md +0 -26
  139. package/docs/api/foundation-comms.genesisresourceschannel.md +0 -33
  140. package/docs/api/foundation-comms.genesisresourceschannelid.md +0 -12
  141. package/docs/api/foundation-comms.genesisresourcesconfig.md +0 -21
  142. package/docs/api/foundation-comms.genesisresourcesconfig.throwwhenunavailable.md +0 -13
  143. package/docs/api/foundation-comms.genesisresourcesconfig.throwwhenunknown.md +0 -13
  144. package/docs/api/foundation-comms.genesisresourcesevents.md +0 -17
  145. package/docs/api/foundation-comms.genesisresourcesmock.destroy.md +0 -15
  146. package/docs/api/foundation-comms.genesisresourcesmock.getresourcetypefor.md +0 -24
  147. package/docs/api/foundation-comms.genesisresourcesmock.isvalidresource.md +0 -24
  148. package/docs/api/foundation-comms.genesisresourcesmock.md +0 -30
  149. package/docs/api/foundation-comms.genesisresourcesmock.nextisvalidresourceresponse.md +0 -11
  150. package/docs/api/foundation-comms.genesisresourcesmock.nextresourcetypeforresponse.md +0 -11
  151. package/docs/api/foundation-comms.genesisresourcesmock.resources.md +0 -11
  152. package/docs/api/foundation-comms.getgenesisresources.md +0 -30
  153. package/docs/api/foundation-comms.getgenesisresourceschannel.md +0 -39
  154. package/docs/api/foundation-comms.resourceitem.md +0 -15
  155. package/docs/api/foundation-comms.resourcesmessage.md +0 -18
  156. package/docs/api/foundation-comms.socket.host.md +0 -11
@@ -1,24 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DefaultGenesisResources](./foundation-comms.defaultgenesisresources.md) &gt; [getResourceTypeFor](./foundation-comms.defaultgenesisresources.getresourcetypefor.md)
4
-
5
- ## DefaultGenesisResources.getResourceTypeFor() method
6
-
7
- Gets the type of resource
8
-
9
- **Signature:**
10
-
11
- ```typescript
12
- getResourceTypeFor(resourceName: string): Promise<ResourceType>;
13
- ```
14
-
15
- ## Parameters
16
-
17
- | Parameter | Type | Description |
18
- | --- | --- | --- |
19
- | resourceName | string | The name of the resource to get the type for. |
20
-
21
- **Returns:**
22
-
23
- Promise&lt;[ResourceType](./foundation-comms.resourcetype.md)<!-- -->&gt;
24
-
@@ -1,24 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DefaultGenesisResources](./foundation-comms.defaultgenesisresources.md) &gt; [isValidResource](./foundation-comms.defaultgenesisresources.isvalidresource.md)
4
-
5
- ## DefaultGenesisResources.isValidResource() method
6
-
7
- Checks if the resource exists
8
-
9
- **Signature:**
10
-
11
- ```typescript
12
- isValidResource(resourceName: string): Promise<boolean>;
13
- ```
14
-
15
- ## Parameters
16
-
17
- | Parameter | Type | Description |
18
- | --- | --- | --- |
19
- | resourceName | string | The name of the resource to check. |
20
-
21
- **Returns:**
22
-
23
- Promise&lt;boolean&gt;
24
-
@@ -1,40 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DefaultGenesisResources](./foundation-comms.defaultgenesisresources.md)
4
-
5
- ## DefaultGenesisResources class
6
-
7
- Default GenesisResources implementation.
8
-
9
- **Signature:**
10
-
11
- ```typescript
12
- export declare class DefaultGenesisResources implements GenesisResources
13
- ```
14
- **Implements:** [GenesisResources](./foundation-comms.genesisresources.md)
15
-
16
- ## Constructors
17
-
18
- | Constructor | Modifiers | Description |
19
- | --- | --- | --- |
20
- | [(constructor)(connect, config)](./foundation-comms.defaultgenesisresources._constructor_.md) | | Constructs a new instance of the <code>DefaultGenesisResources</code> class |
21
-
22
- ## Properties
23
-
24
- | Property | Modifiers | Type | Description |
25
- | --- | --- | --- | --- |
26
- | [config](./foundation-comms.defaultgenesisresources.config.md) | <code>protected</code> | [GenesisResourcesConfig](./foundation-comms.genesisresourcesconfig.md) | |
27
- | [connect](./foundation-comms.defaultgenesisresources.connect.md) | <code>protected</code> | [Connect](./foundation-comms.connect.md) | |
28
- | [resources](./foundation-comms.defaultgenesisresources.resources.md) | <code>protected</code> | [ResourceItem](./foundation-comms.resourceitem.md)<!-- -->\[\] | |
29
- | [resourcesPromise](./foundation-comms.defaultgenesisresources.resourcespromise.md) | <code>protected</code> | Promise&lt;[ResourcesMessage](./foundation-comms.resourcesmessage.md)<!-- -->&gt; | |
30
-
31
- ## Methods
32
-
33
- | Method | Modifiers | Description |
34
- | --- | --- | --- |
35
- | [destroy()](./foundation-comms.defaultgenesisresources.destroy.md) | | Destroy and garbage collect |
36
- | [getResources()](./foundation-comms.defaultgenesisresources.getresources.md) | <code>protected</code> | |
37
- | [getResourceTypeFor(resourceName)](./foundation-comms.defaultgenesisresources.getresourcetypefor.md) | | Gets the type of resource |
38
- | [isValidResource(resourceName)](./foundation-comms.defaultgenesisresources.isvalidresource.md) | | Checks if the resource exists |
39
- | [postLoadedMessage()](./foundation-comms.defaultgenesisresources.postloadedmessage.md) | <code>protected</code> | |
40
-
@@ -1,15 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DefaultGenesisResources](./foundation-comms.defaultgenesisresources.md) &gt; [postLoadedMessage](./foundation-comms.defaultgenesisresources.postloadedmessage.md)
4
-
5
- ## DefaultGenesisResources.postLoadedMessage() method
6
-
7
- **Signature:**
8
-
9
- ```typescript
10
- protected postLoadedMessage(): void;
11
- ```
12
- **Returns:**
13
-
14
- void
15
-
@@ -1,11 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DefaultGenesisResources](./foundation-comms.defaultgenesisresources.md) &gt; [resources](./foundation-comms.defaultgenesisresources.resources.md)
4
-
5
- ## DefaultGenesisResources.resources property
6
-
7
- **Signature:**
8
-
9
- ```typescript
10
- protected resources: ResourceItem[];
11
- ```
@@ -1,11 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DefaultGenesisResources](./foundation-comms.defaultgenesisresources.md) &gt; [resourcesPromise](./foundation-comms.defaultgenesisresources.resourcespromise.md)
4
-
5
- ## DefaultGenesisResources.resourcesPromise property
6
-
7
- **Signature:**
8
-
9
- ```typescript
10
- protected resourcesPromise: Promise<ResourcesMessage>;
11
- ```
@@ -1,13 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [defaultGenesisResourcesConfig](./foundation-comms.defaultgenesisresourcesconfig.md)
4
-
5
- ## defaultGenesisResourcesConfig variable
6
-
7
- Default GenesisResourcesConfig implementation.
8
-
9
- **Signature:**
10
-
11
- ```typescript
12
- defaultGenesisResourcesConfig: GenesisResourcesConfig
13
- ```
@@ -1,11 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DefaultSocket](./foundation-comms.defaultsocket.md) &gt; [config](./foundation-comms.defaultsocket.config.md)
4
-
5
- ## DefaultSocket.config property
6
-
7
- **Signature:**
8
-
9
- ```typescript
10
- protected config: ConnectConfig;
11
- ```
@@ -1,11 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DefaultSocket](./foundation-comms.defaultsocket.md) &gt; [host](./foundation-comms.defaultsocket.host.md)
4
-
5
- ## DefaultSocket.host property
6
-
7
- **Signature:**
8
-
9
- ```typescript
10
- get host(): string;
11
- ```
@@ -1,13 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [GenesisResources](./foundation-comms.genesisresources.md) &gt; [destroy](./foundation-comms.genesisresources.destroy.md)
4
-
5
- ## GenesisResources.destroy property
6
-
7
- Destroy and garbage collect
8
-
9
- **Signature:**
10
-
11
- ```typescript
12
- destroy: () => void;
13
- ```
@@ -1,13 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [GenesisResources](./foundation-comms.genesisresources.md) &gt; [getResourceTypeFor](./foundation-comms.genesisresources.getresourcetypefor.md)
4
-
5
- ## GenesisResources.getResourceTypeFor property
6
-
7
- Gets the type of resource
8
-
9
- **Signature:**
10
-
11
- ```typescript
12
- getResourceTypeFor: (resourceName: string) => Promise<ResourceType>;
13
- ```
@@ -1,13 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [GenesisResources](./foundation-comms.genesisresources.md) &gt; [isValidResource](./foundation-comms.genesisresources.isvalidresource.md)
4
-
5
- ## GenesisResources.isValidResource property
6
-
7
- Checks if the resource exists
8
-
9
- **Signature:**
10
-
11
- ```typescript
12
- isValidResource: (resourceName: string) => Promise<boolean>;
13
- ```
@@ -1,26 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [GenesisResources](./foundation-comms.genesisresources.md)
4
-
5
- ## GenesisResources interface
6
-
7
- GenesisResources DI interface.
8
-
9
- **Signature:**
10
-
11
- ```typescript
12
- export interface GenesisResources
13
- ```
14
-
15
- ## Remarks
16
-
17
- A lazy shared Genesis Resources lookup system. N number of callers can request information in succession, but only the first will invoke the server request, and each caller will receive their results when that returns.
18
-
19
- ## Properties
20
-
21
- | Property | Modifiers | Type | Description |
22
- | --- | --- | --- | --- |
23
- | [destroy](./foundation-comms.genesisresources.destroy.md) | | () =&gt; void | Destroy and garbage collect |
24
- | [getResourceTypeFor](./foundation-comms.genesisresources.getresourcetypefor.md) | | (resourceName: string) =&gt; Promise&lt;[ResourceType](./foundation-comms.resourcetype.md)<!-- -->&gt; | Gets the type of resource |
25
- | [isValidResource](./foundation-comms.genesisresources.isvalidresource.md) | | (resourceName: string) =&gt; Promise&lt;boolean&gt; | Checks if the resource exists |
26
-
@@ -1,33 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [GenesisResourcesChannel](./foundation-comms.genesisresourceschannel.md)
4
-
5
- ## GenesisResourcesChannel interface
6
-
7
- GenesisResourcesChannel DI interface.
8
-
9
- **Signature:**
10
-
11
- ```typescript
12
- export interface GenesisResourcesChannel extends TypedBroadcastChannel<GenesisResourcesEvents>
13
- ```
14
- **Extends:** TypedBroadcastChannel&lt;[GenesisResourcesEvents](./foundation-comms.genesisresourcesevents.md)<!-- -->&gt;
15
-
16
- ## Example
17
-
18
-
19
- ```ts
20
- import { GenesisResourcesChannel } from '@genesislcap/foundation-comms';
21
- ...
22
- @GenesisResourcesChannel protected channel: GenesisResourcesChannel;
23
- ...
24
- this.channel.onmessage = (e) => {
25
- if (this.channel.isMessageType('resources-loaded', e)) {
26
- logger.debug('resources-loaded', e.data.detail);
27
- return;
28
- }
29
- }
30
- ...
31
- this.channel.close();
32
- ```
33
-
@@ -1,12 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [GenesisResourcesChannelId](./foundation-comms.genesisresourceschannelid.md)
4
-
5
- ## GenesisResourcesChannelId variable
6
-
7
-
8
- **Signature:**
9
-
10
- ```typescript
11
- GenesisResourcesChannelId = "genesis-resources"
12
- ```
@@ -1,21 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [GenesisResourcesConfig](./foundation-comms.genesisresourcesconfig.md)
4
-
5
- ## GenesisResourcesConfig interface
6
-
7
- GenesisResourcesConfig DI interface.
8
-
9
- **Signature:**
10
-
11
- ```typescript
12
- export interface GenesisResourcesConfig
13
- ```
14
-
15
- ## Properties
16
-
17
- | Property | Modifiers | Type | Description |
18
- | --- | --- | --- | --- |
19
- | [throwWhenUnavailable?](./foundation-comms.genesisresourcesconfig.throwwhenunavailable.md) | | boolean | _(Optional)_ Treat unavailable/empty genesis resource sets as fatal errors. |
20
- | [throwWhenUnknown?](./foundation-comms.genesisresourcesconfig.throwwhenunknown.md) | | boolean | _(Optional)_ Treat unknown resources as fatal errors. |
21
-
@@ -1,13 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [GenesisResourcesConfig](./foundation-comms.genesisresourcesconfig.md) &gt; [throwWhenUnavailable](./foundation-comms.genesisresourcesconfig.throwwhenunavailable.md)
4
-
5
- ## GenesisResourcesConfig.throwWhenUnavailable property
6
-
7
- Treat unavailable/empty genesis resource sets as fatal errors.
8
-
9
- **Signature:**
10
-
11
- ```typescript
12
- throwWhenUnavailable?: boolean;
13
- ```
@@ -1,13 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [GenesisResourcesConfig](./foundation-comms.genesisresourcesconfig.md) &gt; [throwWhenUnknown](./foundation-comms.genesisresourcesconfig.throwwhenunknown.md)
4
-
5
- ## GenesisResourcesConfig.throwWhenUnknown property
6
-
7
- Treat unknown resources as fatal errors.
8
-
9
- **Signature:**
10
-
11
- ```typescript
12
- throwWhenUnknown?: boolean;
13
- ```
@@ -1,17 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [GenesisResourcesEvents](./foundation-comms.genesisresourcesevents.md)
4
-
5
- ## GenesisResourcesEvents type
6
-
7
-
8
- **Signature:**
9
-
10
- ```typescript
11
- export type GenesisResourcesEvents = {
12
- 'resources-loaded': ResourceItem[];
13
- 'resources-unloaded': void;
14
- };
15
- ```
16
- **References:** [ResourceItem](./foundation-comms.resourceitem.md)
17
-
@@ -1,15 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [GenesisResourcesMock](./foundation-comms.genesisresourcesmock.md) &gt; [destroy](./foundation-comms.genesisresourcesmock.destroy.md)
4
-
5
- ## GenesisResourcesMock.destroy() method
6
-
7
- **Signature:**
8
-
9
- ```typescript
10
- destroy(): void;
11
- ```
12
- **Returns:**
13
-
14
- void
15
-
@@ -1,24 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [GenesisResourcesMock](./foundation-comms.genesisresourcesmock.md) &gt; [getResourceTypeFor](./foundation-comms.genesisresourcesmock.getresourcetypefor.md)
4
-
5
- ## GenesisResourcesMock.getResourceTypeFor() method
6
-
7
- Gets the type of resource
8
-
9
- **Signature:**
10
-
11
- ```typescript
12
- getResourceTypeFor(resourceName: string): Promise<ResourceType>;
13
- ```
14
-
15
- ## Parameters
16
-
17
- | Parameter | Type | Description |
18
- | --- | --- | --- |
19
- | resourceName | string | The name of the resource to get the type for. |
20
-
21
- **Returns:**
22
-
23
- Promise&lt;[ResourceType](./foundation-comms.resourcetype.md)<!-- -->&gt;
24
-
@@ -1,24 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [GenesisResourcesMock](./foundation-comms.genesisresourcesmock.md) &gt; [isValidResource](./foundation-comms.genesisresourcesmock.isvalidresource.md)
4
-
5
- ## GenesisResourcesMock.isValidResource() method
6
-
7
- Checks if the resource exists
8
-
9
- **Signature:**
10
-
11
- ```typescript
12
- isValidResource(resourceName: string): Promise<boolean>;
13
- ```
14
-
15
- ## Parameters
16
-
17
- | Parameter | Type | Description |
18
- | --- | --- | --- |
19
- | resourceName | string | The name of the resource to check. |
20
-
21
- **Returns:**
22
-
23
- Promise&lt;boolean&gt;
24
-
@@ -1,30 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [GenesisResourcesMock](./foundation-comms.genesisresourcesmock.md)
4
-
5
- ## GenesisResourcesMock class
6
-
7
-
8
- **Signature:**
9
-
10
- ```typescript
11
- export declare class GenesisResourcesMock implements GenesisResources
12
- ```
13
- **Implements:** [GenesisResources](./foundation-comms.genesisresources.md)
14
-
15
- ## Properties
16
-
17
- | Property | Modifiers | Type | Description |
18
- | --- | --- | --- | --- |
19
- | [nextIsValidResourceResponse](./foundation-comms.genesisresourcesmock.nextisvalidresourceresponse.md) | | boolean | |
20
- | [nextResourceTypeForResponse](./foundation-comms.genesisresourcesmock.nextresourcetypeforresponse.md) | | [ResourceType](./foundation-comms.resourcetype.md) | |
21
- | [resources](./foundation-comms.genesisresourcesmock.resources.md) | | [ResourceItem](./foundation-comms.resourceitem.md)<!-- -->\[\] | |
22
-
23
- ## Methods
24
-
25
- | Method | Modifiers | Description |
26
- | --- | --- | --- |
27
- | [destroy()](./foundation-comms.genesisresourcesmock.destroy.md) | | |
28
- | [getResourceTypeFor(resourceName)](./foundation-comms.genesisresourcesmock.getresourcetypefor.md) | | Gets the type of resource |
29
- | [isValidResource(resourceName)](./foundation-comms.genesisresourcesmock.isvalidresource.md) | | Checks if the resource exists |
30
-
@@ -1,11 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [GenesisResourcesMock](./foundation-comms.genesisresourcesmock.md) &gt; [nextIsValidResourceResponse](./foundation-comms.genesisresourcesmock.nextisvalidresourceresponse.md)
4
-
5
- ## GenesisResourcesMock.nextIsValidResourceResponse property
6
-
7
- **Signature:**
8
-
9
- ```typescript
10
- nextIsValidResourceResponse: boolean;
11
- ```
@@ -1,11 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [GenesisResourcesMock](./foundation-comms.genesisresourcesmock.md) &gt; [nextResourceTypeForResponse](./foundation-comms.genesisresourcesmock.nextresourcetypeforresponse.md)
4
-
5
- ## GenesisResourcesMock.nextResourceTypeForResponse property
6
-
7
- **Signature:**
8
-
9
- ```typescript
10
- nextResourceTypeForResponse: ResourceType;
11
- ```
@@ -1,11 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [GenesisResourcesMock](./foundation-comms.genesisresourcesmock.md) &gt; [resources](./foundation-comms.genesisresourcesmock.resources.md)
4
-
5
- ## GenesisResourcesMock.resources property
6
-
7
- **Signature:**
8
-
9
- ```typescript
10
- resources: ResourceItem[];
11
- ```
@@ -1,30 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [getGenesisResources](./foundation-comms.getgenesisresources.md)
4
-
5
- ## getGenesisResources() function
6
-
7
- Gets GenesisResources from the DI container.
8
-
9
- **Signature:**
10
-
11
- ```typescript
12
- export declare function getGenesisResources(): GenesisResources;
13
- ```
14
- **Returns:**
15
-
16
- [GenesisResources](./foundation-comms.genesisresources.md)
17
-
18
- ## Remarks
19
-
20
- A utility method for host applications that are not using decorators or the DI container.
21
-
22
- ## Example
23
-
24
-
25
- ```ts
26
- import { getGenesisResources } from '@genesislcap/foundation-comms';
27
- ...
28
- const genesisResources = getGenesisResources();
29
- ```
30
-
@@ -1,39 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [getGenesisResourcesChannel](./foundation-comms.getgenesisresourceschannel.md)
4
-
5
- ## getGenesisResourcesChannel() function
6
-
7
- Gets GenesisResourcesChannel from the DI container.
8
-
9
- **Signature:**
10
-
11
- ```typescript
12
- export declare function getGenesisResourcesChannel(): GenesisResourcesChannel;
13
- ```
14
- **Returns:**
15
-
16
- [GenesisResourcesChannel](./foundation-comms.genesisresourceschannel.md)
17
-
18
- ## Remarks
19
-
20
- A utility method for host applications that are not using decorators or the DI container.
21
-
22
- ## Example
23
-
24
-
25
- ```ts
26
- import { getGenesisResourcesChannel } from '@genesislcap/foundation-comms';
27
- ...
28
- const channel = getGenesisResourcesChannel();
29
- ...
30
- channel.onmessage = (e) => {
31
- if (channel.isMessageType('resources-loaded', e)) {
32
- logger.debug('resources-loaded', e.data.detail);
33
- return;
34
- }
35
- }
36
- ...
37
- channel.close();
38
- ```
39
-
@@ -1,15 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [ResourceItem](./foundation-comms.resourceitem.md)
4
-
5
- ## ResourceItem type
6
-
7
-
8
- **Signature:**
9
-
10
- ```typescript
11
- export type ResourceItem = {
12
- RESOURCE_NAME: string;
13
- RESOURCE_TYPE: string;
14
- };
15
- ```
@@ -1,18 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [ResourcesMessage](./foundation-comms.resourcesmessage.md)
4
-
5
- ## ResourcesMessage type
6
-
7
-
8
- **Signature:**
9
-
10
- ```typescript
11
- export type ResourcesMessage = {
12
- MESSAGE_TYPE: EventMessageType.RESOURCES_REQUEST_ACK | EventMessageType.RESOURCES_REQUEST_NACK | MessageType.MSG_NACK;
13
- SOURCE_REF: string;
14
- RESOURCES: ResourceItem[];
15
- };
16
- ```
17
- **References:** [EventMessageType.RESOURCES\_REQUEST\_ACK](./foundation-comms.eventmessagetype.md)<!-- -->, [EventMessageType.RESOURCES\_REQUEST\_NACK](./foundation-comms.eventmessagetype.md)<!-- -->, [MessageType.MSG\_NACK](./foundation-comms.messagetype.md)<!-- -->, [ResourceItem](./foundation-comms.resourceitem.md)
18
-
@@ -1,11 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [Socket](./foundation-comms.socket.md) &gt; [host](./foundation-comms.socket.host.md)
4
-
5
- ## Socket.host property
6
-
7
- **Signature:**
8
-
9
- ```typescript
10
- host: string;
11
- ```