Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/megadrive/twitchonlinetracker
A TypeScript Node.JS library to track when Twitch.TV streams goes up or down.
https://github.com/megadrive/twitchonlinetracker
stream-changes twitch twitch-api twitchtv
Last synced: about 1 month ago
JSON representation
A TypeScript Node.JS library to track when Twitch.TV streams goes up or down.
- Host: GitHub
- URL: https://github.com/megadrive/twitchonlinetracker
- Owner: megadrive
- Created: 2018-12-26T13:01:53.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2022-02-11T00:31:38.000Z (almost 3 years ago)
- Last Synced: 2024-11-10T06:43:33.595Z (about 2 months ago)
- Topics: stream-changes, twitch, twitch-api, twitchtv
- Language: TypeScript
- Homepage:
- Size: 43 KB
- Stars: 10
- Watchers: 0
- Forks: 7
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Track when Twitch streams go online
## Quickstart
Install: `npm install --save twitchonlinetracker`
Get a Client ID. See Step 1 of the [Twitch API Introduction](https://dev.twitch.tv/docs/api/#introduction) on how to do this.
```js
const { TwitchOnlineTracker } = require('twitchonlinetracker')
const tracker = new TwitchOnlineTracker({
client_id: "your twitch app client id", // used for api requests
track: ['channel1', 'channel2'], // all the channels you want to track
pollInterval: 30, // how often in between polls in seconds. default 30
debug: true, // whether to debug to console
start: true // whether to start immediately. if you don't use this, you must call .start() later
})
// Listen to live event, it returns StreamData
tracker.on('live', streamData => {
console.log(`${streamData.user_name} just went live!`)
})
// Make sure you listen for errors
tracker.on('error', error => console.error)
```
**NOTE:** If you don't pass `start: true` in the options, you must call `tracker.start()` to start polling.
## TwitchOnlineTracker API
### const tracker = new TwitchOnlineTracker(options: [TwitchOnlineTrackerOptions](https://github.com/megadrive/TwitchOnlineTracker/blob/949212b7834f0df11c0309dc85559836d57f364c/src/interfaces.ts#L66-L72))
Create a new `TwitchOnlineTracker` instance. It takes a TwitchOnlineTrackerOptions interface:
- `client_id` *string* **required** Your Twitch app's client id
- `track` *string[]* An array of the channels you wish to track on startup
- `pollInterval` *number* The amount of time in seconds between polls
- `debug` *boolean* If true, output debug information to console
- `start` *boolean* If true, start polling immediately
### tracker.start()
Starts polling the Twitch API for stream changes.
### tracker.stop()
Stops polling the Twitch API for stream changes.
### tracker.track(usernamesToTrack: string[])
Adds more streams to track. `usernamesToTrack` expects an array of strings.
### tracker.untrack(usernamesToUntrack: string[])
Stops tracking streams. `usernamesToTrack` expects an array of strings.
### tracker.on('live', function (streamData: [StreamData](https://github.com/megadrive/TwitchOnlineTracker/blob/12505f0bfe16129d4a125c93a021c41510db452c/src/interfaces.ts#L36-L48)) { })
When a stream is found to be live, fires this event. The callback function provides a StreamData parameter.
Example:
```javascript
tracker.on('live', function (streamData) {
console.log(`${streamData.user_name} has started streaming with the title ${streamData.title} at https://twitch.tv/${streamData.user_name} for ${streamData.viewer_count} viewers!`)
})
```
### tracker.on('offline', function (channelName: string) { })
When a stream is found to have gone offline, fires this event. The callback function provides a string.
Example:
```javascript
tracker.on('offline', function (channel) {
console.log(`${channel} has gone offline.`)
})
```
### tracker.on('error', function (error) { })
Fires this event on error. Make sure you capture this event.
Example:
```javascript
tracker.on('error', function (error) {
throw Error(error)
})
```