@golemio/core 1.2.9-dev.533136017 → 1.2.9-dev.534259948
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 +37 -10
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,11 +1,30 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
1
|
+
<div align="center">
|
|
2
|
+
<p>
|
|
3
|
+
<a href="https://operatorict.cz/">
|
|
4
|
+
<img src="./.assets/oict_logo.png" alt="oict" width="100px" height="100px" />
|
|
5
|
+
</a>
|
|
6
|
+
</p>
|
|
7
|
+
|
|
8
|
+
<h1>@golemio/core</h1>
|
|
9
|
+
|
|
10
|
+
<p>
|
|
11
|
+
<a href="https://gitlab.com/operator-ict/golemio/code/modules/core/commits/master">
|
|
12
|
+
<img src="https://gitlab.com/operator-ict/golemio/code/modules/core/badges/master/pipeline.svg" alt="pipeline">
|
|
13
|
+
</a>
|
|
14
|
+
<a href="https://gitlab.com/operator-ict/golemio/code/modules/core/commits/master">
|
|
15
|
+
<img src="https://gitlab.com/operator-ict/golemio/code/modules/core/badges/master/coverage.svg" alt="coverage">
|
|
16
|
+
</a>
|
|
17
|
+
<a href="./LICENSE">
|
|
18
|
+
<img src="https://img.shields.io/npm/l/@golemio/core" alt="license">
|
|
19
|
+
</a>
|
|
20
|
+
</p>
|
|
21
|
+
|
|
22
|
+
<p>
|
|
23
|
+
<a href="#installation">Installation</a> · <a href="./docs">Documentation</a> · <a href="https://operator-ict.gitlab.io/golemio/code/modules/core">TypeDoc</a>
|
|
24
|
+
</p>
|
|
25
|
+
</div>
|
|
26
|
+
|
|
27
|
+
This module is intended for use with Golemio services.
|
|
9
28
|
|
|
10
29
|
## Prerequisites
|
|
11
30
|
|
|
@@ -37,21 +56,25 @@ To compile typescript code into js one-time
|
|
|
37
56
|
```bash
|
|
38
57
|
yarn run build
|
|
39
58
|
```
|
|
59
|
+
|
|
40
60
|
or run this, to watch all changes
|
|
61
|
+
|
|
41
62
|
```bash
|
|
42
63
|
yarn run build-watch
|
|
43
64
|
```
|
|
44
|
-
from the application's root directory.
|
|
45
65
|
|
|
66
|
+
from the application's root directory.
|
|
46
67
|
|
|
47
68
|
## Usage
|
|
48
69
|
|
|
49
70
|
In your project's `package.json` set dependency to @golemio/core
|
|
71
|
+
|
|
50
72
|
```bash
|
|
51
73
|
yarn add @golemio/core --save
|
|
52
74
|
```
|
|
53
75
|
|
|
54
76
|
Then import module, e.g.
|
|
77
|
+
|
|
55
78
|
```ts
|
|
56
79
|
import * as core from "@golemio/core";
|
|
57
80
|
```
|
|
@@ -61,17 +84,22 @@ import * as core from "@golemio/core";
|
|
|
61
84
|
For the local development use the [yarn link]() to link the @golemio/core with other service e.g. `@golemio/integration-engine` or module e.g. `@golemio/pid`.
|
|
62
85
|
|
|
63
86
|
At the @golemio/core root directory:
|
|
87
|
+
|
|
64
88
|
```bash
|
|
65
89
|
yarn link
|
|
66
90
|
yarn build-watch
|
|
67
91
|
```
|
|
92
|
+
|
|
68
93
|
At the @golemio/pid root directory:
|
|
94
|
+
|
|
69
95
|
```bash
|
|
70
96
|
yarn link "@golemio/core"
|
|
71
97
|
yarn link
|
|
72
98
|
yarn build-watch
|
|
73
99
|
```
|
|
100
|
+
|
|
74
101
|
At the @golemio/integration-engine root directory:
|
|
102
|
+
|
|
75
103
|
```bash
|
|
76
104
|
yarn link "@golemio/core"
|
|
77
105
|
yarn link "@golemio/pid"
|
|
@@ -90,7 +118,6 @@ yarn test
|
|
|
90
118
|
|
|
91
119
|
from the application's root directory. All tests should pass.
|
|
92
120
|
|
|
93
|
-
|
|
94
121
|
## Rabbit MQ
|
|
95
122
|
|
|
96
123
|
Core module defines main exchange in rabbit mq and its name is dependent on .env setting. Also it contains definition of queue for dead messages. All other queues are defined in separate modules and loaded dynamically by `QueueProcessor.ts`.
|