https://github.com/soratabaka/trakteer-websocket-wrapper
Simple trakteer websocket wrapper to emit events on donations
https://github.com/soratabaka/trakteer-websocket-wrapper
api javascript nodejs trakteer websocket wrapper
Last synced: about 1 month ago
JSON representation
Simple trakteer websocket wrapper to emit events on donations
- Host: GitHub
- URL: https://github.com/soratabaka/trakteer-websocket-wrapper
- Owner: SorataBaka
- License: apache-2.0
- Created: 2021-12-18T19:40:51.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-12-22T00:00:53.000Z (over 4 years ago)
- Last Synced: 2024-04-28T07:06:29.137Z (about 2 years ago)
- Topics: api, javascript, nodejs, trakteer, websocket, wrapper
- Language: JavaScript
- Homepage: https://npmjs.com/package/trakteer-websocket-wrapper
- Size: 68.4 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.MD
- License: LICENSE
Awesome Lists containing this project
README
# Trakteer Websocket Wrapper
Simple websocket wrappper for trakteer. This module requires both creator-stream channels id to be provided in order to be able to connect to the servers and receive data.
```Javascript
const { TrakteerSocket } = require("trakteer-websocket-wrapper")
const client = new TrakteerSocket({
mainChannelID: "creator-stream.a6z7asdfadn4mlqy.trstream-asdfadfasdfasfqT",
testChannelID: "creator-stream-test.a6sadfeafzn4mlqy.trstream-asdfadfasdfasfqT"
})
//Emitted when client receive donations in trakteer
client.on("donation", (data)=>{
console.log(data)
})
//Emitted when the client successfully connected to Trakteer Websocket
client.on("connected", (data)=>{
console.log(data)
})
//Emitted when the client successfully subscribed to the channels
client.on("subscribed", (data)=>{
console.log(data)
})
//Emitted when server responded to the client ping
client.on("pong", (data)=>{
console.log(data)
})
//Emitted when client failed to subscribe to the channels
client.on("subscription_error", (data)=>{
console.log(data)
})
//Emitted on websocket error
client.on("error", (data)=>{
console.log(data)
})
//Emitted on websocket connection close
client.on("close", (data)=>{
console.log(data)
})
```
Installation
`npm install trakteer-websocket-wrapper`
Usage
1. Go to the trakteer dashboard
2. Click on "Stream Overlay"
3. Click on "Open URL"
4. Go to Inspect Elements
5. Click on Network
6. Click On "WS"
7. Click On "Messages"
8. Refresh the page
9. Find
```
{"event":"pusher:subscribe","data":{"auth":"","channel":"creator-stream-test.asadfasdfalqy.trstream-asdfadfasdfasfa"}}
```
for both creator-stream and creator-test-stream on Messages tab