@tixyel/streamelements 3.0.0 → 3.0.1
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 +40 -40
- package/dist/index.es.js.map +1 -1
- package/dist/index.umd.js.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,40 +1,40 @@
|
|
|
1
|
-
# @tixyel/streamelements
|
|
2
|
-
|
|
3
|
-
TypeScript/JavaScript helper library for building custom widgets for [StreamElements](https://streamelements.com/), focused on productivity, type safety, and local development. Designed for browser usage via CDN, with TypeScript types for IDE autocompletion.
|
|
4
|
-
|
|
5
|
-
## Features
|
|
6
|
-
|
|
7
|
-
- **Typed event helpers** for Twitch, YouTube, and Kick (in development)
|
|
8
|
-
- **Utility functions** for common widget tasks
|
|
9
|
-
- **TypeScript types** for all major StreamElements events
|
|
10
|
-
- **Local development support**: Test your widget locally without uploading to StreamElements
|
|
11
|
-
- **Easy integration**: Use directly in the browser via CDN
|
|
12
|
-
|
|
13
|
-
## Usage
|
|
14
|
-
|
|
15
|
-
Add the following to your HTML:
|
|
16
|
-
|
|
17
|
-
```html
|
|
18
|
-
<script src="https://cdn.jsdelivr.net/npm/@tixyel/streamelements"></script>
|
|
19
|
-
<script>
|
|
20
|
-
const { Client, Simulation, logger } = window.Tixyel;
|
|
21
|
-
|
|
22
|
-
new Client({ id: 'my-widget' }).on('load', (event) => {
|
|
23
|
-
logger.received('Widget loaded!', event);
|
|
24
|
-
});
|
|
25
|
-
</script>
|
|
26
|
-
```
|
|
27
|
-
|
|
28
|
-
> **Note:** This package is designed for browser usage via CDN only.
|
|
29
|
-
> TypeScript is used only to provide type definitions and autocompletion in your IDE when working with `window.Tixyel`.
|
|
30
|
-
|
|
31
|
-
## API Overview
|
|
32
|
-
|
|
33
|
-
- **Client**: Manages events and integration with StreamElements.
|
|
34
|
-
- **Simulation**: Simulates events for local testing.
|
|
35
|
-
- **Logger**: Utility for formatted logs.
|
|
36
|
-
- **Button/Command**: Helpers for custom actions.
|
|
37
|
-
|
|
38
|
-
## License
|
|
39
|
-
|
|
40
|
-
Apache-2.0
|
|
1
|
+
# @tixyel/streamelements
|
|
2
|
+
|
|
3
|
+
TypeScript/JavaScript helper library for building custom widgets for [StreamElements](https://streamelements.com/), focused on productivity, type safety, and local development. Designed for browser usage via CDN, with TypeScript types for IDE autocompletion.
|
|
4
|
+
|
|
5
|
+
## Features
|
|
6
|
+
|
|
7
|
+
- **Typed event helpers** for Twitch, YouTube, and Kick (in development)
|
|
8
|
+
- **Utility functions** for common widget tasks
|
|
9
|
+
- **TypeScript types** for all major StreamElements events
|
|
10
|
+
- **Local development support**: Test your widget locally without uploading to StreamElements
|
|
11
|
+
- **Easy integration**: Use directly in the browser via CDN
|
|
12
|
+
|
|
13
|
+
## Usage
|
|
14
|
+
|
|
15
|
+
Add the following to your HTML:
|
|
16
|
+
|
|
17
|
+
```html
|
|
18
|
+
<script src="https://cdn.jsdelivr.net/npm/@tixyel/streamelements"></script>
|
|
19
|
+
<script>
|
|
20
|
+
const { Client, Simulation, logger } = window.Tixyel;
|
|
21
|
+
|
|
22
|
+
new Client({ id: 'my-widget' }).on('load', (event) => {
|
|
23
|
+
logger.received('Widget loaded!', event);
|
|
24
|
+
});
|
|
25
|
+
</script>
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
> **Note:** This package is designed for browser usage via CDN only.
|
|
29
|
+
> TypeScript is used only to provide type definitions and autocompletion in your IDE when working with `window.Tixyel`.
|
|
30
|
+
|
|
31
|
+
## API Overview
|
|
32
|
+
|
|
33
|
+
- **Client**: Manages events and integration with StreamElements.
|
|
34
|
+
- **Simulation**: Simulates events for local testing.
|
|
35
|
+
- **Logger**: Utility for formatted logs.
|
|
36
|
+
- **Button/Command**: Helpers for custom actions.
|
|
37
|
+
|
|
38
|
+
## License
|
|
39
|
+
|
|
40
|
+
Apache-2.0
|