@lumiastream/plugin 0.4.3 → 0.4.4

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 (2) hide show
  1. package/README.md +3 -1
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -104,7 +104,7 @@ Interact with Lumia Stream using the strongly typed `ILumiaAPI` helper on the pl
104
104
  await this.lumia.triggerAlert({
105
105
  alert: "follow",
106
106
  extraSettings: { username: "StreamerFan" },
107
- showInEventList: true,
107
+ showInEventList: false,
108
108
  });
109
109
  await this.lumia.playAudio({ path: "alert.mp3", volume: 0.7 });
110
110
  this.lumia.setVariable("follower_count", 1337);
@@ -114,6 +114,8 @@ this.lumia.displayChat({
114
114
  });
115
115
  ```
116
116
 
117
+ `showInEventList` should stay `false` for most plugins. Enable it only when users expect those plugin-triggered events in Event List (typically streaming platform/event-source plugins).
118
+
117
119
  See the [API reference](./docs/api-reference.md) for the full surface area.
118
120
 
119
121
  ### Shared Runtime Resources
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@lumiastream/plugin",
3
- "version": "0.4.3",
3
+ "version": "0.4.4",
4
4
  "description": "Official Lumia Stream Plugin SDK for building Lumia Stream plugins.",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",