@5minds/processcube_engine_sdk 5.0.0-develop-b2bcaa-locnd3wy → 5.0.0-develop-19dd69-locqypc8
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 +7 -9
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -24,17 +24,15 @@ function onEngineEvent(event: EngineEvent): Promise<void> {
|
|
|
24
24
|
}
|
|
25
25
|
```
|
|
26
26
|
|
|
27
|
-
Unter [./sample/extension](./sample/extension/README.md) ist eine vollständige Beispiel-Implementierung zu finden.
|
|
28
|
-
|
|
29
27
|
## Extensions in die Engine einbinden
|
|
30
28
|
|
|
31
|
-
Standardmäßig werden Extensions aus dem Ordner `${HOME}/.
|
|
29
|
+
Standardmäßig werden Extensions aus dem Ordner `${HOME}/.processcube/engine/extensions` geladen. Der Pfad lässt sich mit dem Startup-Parameter
|
|
32
30
|
`--extensionsDir` ändern.
|
|
33
31
|
|
|
34
32
|
Sowohl beim Start über die CLI:
|
|
35
33
|
|
|
36
34
|
```sh
|
|
37
|
-
|
|
35
|
+
processcube-engine --extensionsDir '/my/custom/extensions/dir'
|
|
38
36
|
```
|
|
39
37
|
|
|
40
38
|
Als auch beim Start als embedded Software:
|
|
@@ -51,7 +49,7 @@ Jede zu ladende Extension muss in einem eigenen Unterordner von `extensionsDir`
|
|
|
51
49
|
transpilierte Einstiegspunkt-Datei enthalten, die in der package.json als `main` angegeben ist.
|
|
52
50
|
|
|
53
51
|
```sh
|
|
54
|
-
tree -L 2 ${HOME}/.
|
|
52
|
+
tree -L 2 ${HOME}/.processcube/engine/extensions
|
|
55
53
|
├── extension01
|
|
56
54
|
│ ├── index.js
|
|
57
55
|
│ └── package.json
|
|
@@ -76,7 +74,7 @@ Jede Extension muss mindestens eine eigene package.json mit `name`, `version` un
|
|
|
76
74
|
`main` muss auf eine gültige JavaScript-Datei zeigen, in welcher die Extension gehostet wird.
|
|
77
75
|
|
|
78
76
|
In der `main`-Datei können Extensions eine onLoad-Funktion exportieren, die von der Engine beim Laden mit einem
|
|
79
|
-
[Engine-Objekt](#Interaktion-mit-der-
|
|
77
|
+
[Engine-Objekt](#Interaktion-mit-der-Engine) als Parameter aufgerufen wird. In diesem Objekt finden sich alle Engine Funktionen,
|
|
80
78
|
die von einer Extension genutzt werden können.
|
|
81
79
|
|
|
82
80
|
```ts
|
|
@@ -85,7 +83,7 @@ export const onLoad: OnLoad = (engine: Engine) => {
|
|
|
85
83
|
};
|
|
86
84
|
```
|
|
87
85
|
|
|
88
|
-
## Interaktion mit der
|
|
86
|
+
## Interaktion mit der Engine
|
|
89
87
|
|
|
90
88
|
Der `Engine` Typ stellt Schnittstellen zur Interaktion mit der Engine bereit.
|
|
91
89
|
|
|
@@ -166,5 +164,5 @@ Werden mehrere `ModifyTokenPayload` Actions zurückgegeben, überschreibt der le
|
|
|
166
164
|
|
|
167
165
|
## Weiterführende Links
|
|
168
166
|
|
|
169
|
-
- [Engine](https://github.com/
|
|
170
|
-
- [TS Client](https://github.com/
|
|
167
|
+
- [Engine](https://github.com//5minds/ProcessCube.Engine)
|
|
168
|
+
- [TS Client](https://github.com//5minds/ProcessCube.Engine.Client.ts)
|
package/package.json
CHANGED