Radio4000 JavaScript SDK
Helpers to fetch data via REST API from the Radio4000 Firebase database
- works in browsers and node
- less than 1kb minified
API methods
Here are the methods you can use. All return a promise.
// amount is optional
Note: the
findChannelImage(channelObject)
method was removed in 0.1.0
Tags methods
You can use these methods, which should help find the tags the way you need them.
const example1 = '#hello world #what-is-up'console// [ 'hello', 'what-is-up']const example2 =body: 'hello #world'body: '#miam iz #world'console// [ 'world', 'miam', 'world' ]const example3 =body: 'hello #world'body: '#miam iz #world #tour'console// {// tags: [ 'world', 'miam', 'tour' ],// sortedTags: [ [ 'world', 2 ], [ 'miam', 1 ], [ 'tour', 1 ] ]// }
import
or require
Usage if you can Install the module:
yarn add radio4000-sdk
Then, import the methods you need:
// ES Modules // Node.js/CommonJSconst findChannel findTracks =
<script>
Usage with For browsers you can do this. It will add a radio4000Sdk
global.
<!-- or with a CDN<script src="https://unpkg.com/radio4000-sdk"></script><script src="https://cdn.jsdelivr.net/npm/radio4000-sdk"></script>-->
Development
Clone the repo, yarn
and yarn test
. There is no start because this is a library.
To release a new version, run yarn release
. Run yarn release --help
for more information.