node-twitchtv

TwitchTV client for Node applications

npm install node-twitchtv
11 downloads in the last week
23 downloads in the last month

node-twitchtv

TwitchTV client for NodeJS applications.

Build Status

NPM version

Getting started

npm install node-twitchtv

Then integrate!


var TwitchClient = require("node-twitchtv");

// { client_id: "generatedClientId", scope: "user_read, channel_read_"}

var account = require("../secrets/user.json");

var client = new TwitchClient(account);

client.games({ limit: 20, offset: 21 }, function(err, response) {
  console.log(games);
});

Retrieving a list of games

client.games({ channel: "nl_kripp" }, function(err, response) {
  console.log(channel.info); // channel info/description
});

Retrieving a channel's information

client.channels({ channel: "nl_kripp" }, function(err, response) {
  console.log(channel.info); // channel info/description
});

Retrieving a stream's information

client.streams({ channel: "nl_kripp" }, function(err, response) {

});

Retrieving a user's information

client.users({ user: "nl_kripp" }, function(err, response) {
  console.log(user.name); // user info!
});

Contributing

100% open -- let's make this better! Accepting pull requests at any time.

Running the tests

npm test

TODO

  • OAuth2 authentication
  • Video Streaming
  • Being able to update channel information
  • Listing videos
  • Searching
  • Analytics?

License

(The MIT License)

Copyright (c) 2012 Jaime Bueza <jbueza@gmail.com>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

npm loves you