@kemu-io/edge-runtime 0.1.11 → 0.1.13

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 (3) hide show
  1. package/package.json +1 -1
  2. package/runner.d.ts +11 -4
  3. package/runner.js +2 -2
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@kemu-io/edge-runtime",
3
3
  "type": "module",
4
- "version": "0.1.11",
4
+ "version": "0.1.13",
5
5
  "description": "Kemu Edge runtime for running Kemu recipes",
6
6
  "author": "Kemu Pty Ltd",
7
7
  "main": "runner.js",
package/runner.d.ts CHANGED
@@ -85,11 +85,18 @@ export declare const utils: {
85
85
  loadImageFile: (filePath: string | URL | Buffer | ArrayBufferLike | Uint8Array | Readable) => Promise<ImageData$1>;
86
86
  };
87
87
  declare const _default: {
88
- start: (config: {
89
- /** path to the recipe file or containing directory */
88
+ start: (config?: {
89
+ /**
90
+ * path to the recipe file or containing directory.
91
+ * If not provided, the system will attempt to read it from the command line arguments (`--recipePath`)
92
+ * or environment variables (`KEMU_EDGE_RECIPE_PATH`) or the current working directory.
93
+ **/
90
94
  recipePath?: string;
91
- /** API key to use when connecting to the hub */
92
- apiKey: string;
95
+ /**
96
+ * API key to use when connecting to the hub.
97
+ * If not provided, it will be read from the `KEMU_API_KEY` environment variable.
98
+ **/
99
+ apiKey?: string;
93
100
  }) => Promise<{
94
101
  /** use it to send data to input widgets */
95
102
  sendToInputWidget: (inputName: string, data: PartialData, thingId?: string | undefined) => Promise<void>;