NodeJS Module to browse, search and play streams from TuneIn Radio
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs
src
test
.esdoc.json
.eslintrc
.gitignore
.travis.yml
LICENSE
README.md
package-lock.json
package.json

README.md

TuneIn Radio API client

node-tunein-radio is a simple TuneIn Radio API javascript client, designed to be used in NodeJS.

Build Status Coverage Status Dependencies

Install

$ npm install node-tunein-radio

Use

var TuneIn = require('node-tunein-radio');

var tunein = new TuneIn({ ... });

tunein.browse().then(function(result) {
    console.log(result);
}).catch(function(err) {
    console.log(err);
});

Constructor options

When you instantiate a new TuneIn object, you can pass in an options object with the following fields:

var tunein = new TuneIn({
    protocol        : 'https',          // Protocol to use, either 'http' or 'https', default https
    cacheRequests   : false,            // Wheter or not to cache requests, default false
    cacheTTL        : 1000 * 60 * 5,    // TTL for cached results, default 5 mins
    partnerId       : 'no default'      // a partnerId string provided by TuneIn, default to undefined
});

Documentation

You can read the full documentation on GitHub Pages.

License

MIT

Contributing

Issues reports and PR are welcome.