A library to help track streamers and fires an event if they go online. 

megadrive

twitchonlinetracker

    "description": "A library to help track streamers and fires an event if they go online.",

        "url": "https://github.com/megadrive/TwitchOnlineTracker"

        "watch": "tsc --watch -p tsconfig.json",

        "test": "mocha -r ts-node/register src/**/*.test.ts"

  "description": "A library to help track streamers and fires an event if they go online.",

    "url": "https://github.com/megadrive/TwitchOnlineTracker"

    "watch": "tsc --watch -p tsconfig.json",

    "test": "mocha -r ts-node/register src/**/*.test.ts"

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.

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

  console.log(`${streamData.user_name} just went live!`)

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.

### 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

Starts polling the Twitch API for stream changes.

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.

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.

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.

		{
		"name": "twitchonlinetracker",
		"version": "1.1.1",
		"version": "1.1.2",
		"description": "A library to help track streamers and fires an event if they go online.",
		@@ -26,3 +26,4 @@ "main": "lib/",
		"dependencies": {
		"axios": "^0.18.0"
		"axios": "^0.18.0",
		"dotenv": "^6.2.0"
		},
		@@ -34,3 +35,2 @@ "devDependencies": {
		"chai": "^4.2.0",
		"dotenv": "^6.2.0",
		"mocha": "^5.2.0",
		@@ -37,0 +37,0 @@ "ts-node": "^7.0.1",

		{
		"name": "twitchonlinetracker",
		"version": "1.1.1",
		"version": "1.1.2",
		"description": "A library to help track streamers and fires an event if they go online.",
		@@ -26,3 +26,4 @@ "main": "lib/",
		"dependencies": {
		"axios": "^0.18.0"
		"axios": "^0.18.0",
		"dotenv": "^6.2.0"
		},
		@@ -34,3 +35,2 @@ "devDependencies": {
		"chai": "^4.2.0",
		"dotenv": "^6.2.0",
		"mocha": "^5.2.0",
		@@ -37,0 +37,0 @@ "ts-node": "^7.0.1",

Improved metrics

Worsened metrics

Dependency changes

		@@ -69,2 +69,13 @@ # Track when Twitch streams go online

		### 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) { })
		@@ -71,0 +82,0 @@