node-tunein-radio
Version:
NodeJS Module to browse, search and play streams from TuneIn Radio
80 lines (69 loc) • 4.27 kB
HTML
<html>
<head>
<meta charset="utf-8">
<base data-ice="baseUrl">
<title data-ice="title">Home | node-tunein-radio</title>
<link type="text/css" rel="stylesheet" href="css/style.css">
<link type="text/css" rel="stylesheet" href="css/prettify-tomorrow.css">
<script src="script/prettify/prettify.js"></script>
<script src="script/manual.js"></script>
<meta name="description" content="NodeJS Module to browse, search and play streams from TuneIn Radio"><meta property="twitter:card" content="summary"><meta property="twitter:title" content="node-tunein-radio"><meta property="twitter:description" content="NodeJS Module to browse, search and play streams from TuneIn Radio"></head>
<body class="layout-container" data-ice="rootContainer">
<header>
<a href="./">Home</a>
<a href="identifiers.html">Reference</a>
<a href="source.html">Source</a>
<div class="search-box">
<span>
<img src="./image/search.png">
<span class="search-input-edge"></span><input class="search-input"><span class="search-input-edge"></span>
</span>
<ul class="search-result"></ul>
</div>
<a style="position:relative; top:3px;" href="https://github.com/piffio/node-tunein-radio"><img width="20px" src="./image/github.png"></a></header>
<nav class="navigation" data-ice="nav"><div>
<ul>
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/index.js~TuneIn.html">TuneIn</a></span></span></li>
</ul>
</div>
</nav>
<div class="content" data-ice="content"><div data-ice="index" class="github-markdown"><h1 id="tunein-radio-api-client">TuneIn Radio API client</h1><p><code>node-tunein-radio</code> is a simple TuneIn Radio API javascript client, designed to be used in NodeJS.</p>
<p><a href="https://travis-ci.org/piffio/node-tunein-radio"><img src="https://travis-ci.org/piffio/node-tunein-radio.svg?branch=master" alt="Build Status"></a>
<a href="https://coveralls.io/github/piffio/node-tunein-radio?branch=master"><img src="https://coveralls.io/repos/github/piffio/node-tunein-radio/badge.svg?branch=master" alt="Coverage Status"></a>
<a href="https://david-dm.org/piffio/node-tunein-radio"><img src="https://david-dm.org/piffio/node-tunein-radio.svg" alt="Dependencies"></a></p>
<h1 id="install">Install</h1><pre><code class="lang-bash"><code class="source-code prettyprint">$ npm install node-tunein-radio</code>
</code></pre>
<h1 id="use">Use</h1><pre><code class="lang-javascript"><code class="source-code prettyprint">var TuneIn = require('node-tunein-radio');
var tunein = new TuneIn({ ... });
tunein.browse().then(function(result) {
console.log(result);
}).catch(function(err) {
console.log(err);
});</code>
</code></pre>
<h1 id="constructor-options">Constructor options</h1><p>When you instantiate a new TuneIn object, you can pass in an options object with the following fields:</p>
<pre><code class="lang-javascript"><code class="source-code prettyprint">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
});</code>
</code></pre>
<h1 id="documentation">Documentation</h1><p>You can read the full documentation on <a href="https://piffio.github.io/node-tunein-radio/">GitHub Pages</a>.</p>
<h1 id="license">License</h1><p>MIT</p>
<h1 id="contributing">Contributing</h1><p>Issues reports and PR are welcome.</p>
</div>
</div>
<footer class="footer">
Generated by <a href="https://esdoc.org">ESDoc<span data-ice="esdocVersion">(1.0.4)</span><img src="./image/esdoc-logo-mini-black.png"></a>
</footer>
<script src="script/search_index.js"></script>
<script src="script/search.js"></script>
<script src="script/pretty-print.js"></script>
<script src="script/inherited-summary.js"></script>
<script src="script/test-summary.js"></script>
<script src="script/inner-link.js"></script>
<script src="script/patch-for-local.js"></script>
</body>
</html>