streamtip-listener
v1.3.3 streamtip twitch hitbox
streamtip-listener
A Node.JS wrapper for the Streamtip API.
Installation
npm install streamtip-listener
Usage
var Streamtip = require('streamtip-listener');
var opts = {
clientId: '12345', // Your Client ID, from the Streamtip account page
accessToken: '67890' // Account Token, again from the account page
};
var listener = new Streamtip(opts);
listener.on('connected', function() {
// Successfully connected to Streamtip, but not authenticated yet!
console.log('connected!');
});
listener.on('authenticated', function() {
// Now authenticated, we can expect tip alerts to come through
console.log('authenticated!');
});
listener.on('authenticationFailed', function() {
// ClientID or Access Token was rejected
console.log('authentication failed!');
});
listener.on('ratelimited', function () {
// Too many bad authentications = ratelimited
console.log('rate limited!');
});
listener.on('newTip', function(tip) {
// We got a new tip.
// 'tip' is an object which matches the description given on the Streamtip API page
console.log('new tip! %s has tipped %s%s!', tip.username, tip.currencySymbol, tip.amount);
});
listener.on('error', function(err) {
// An unexpected error occurred
console.log('error! %s', err.message);
});
Contributing
- Fork the project
- Create your feature/fix on a new branch
- Create a new pull request pointing to that branch
License
streamtip-listener is copyright (c) Matthew McNamara, and is provided under the MIT license, which is available to read in the [LICENSE][] file. [license]: LICENSE
Streamtip itself is copyright (c) NightDev, LLC.