fanart.tv-api
v2.0.1
Published
A Fanart.tv API wrapper for NodeJS.
Downloads
41
Readme
fanart.tv-api
A Fanart.tv API wrapper for NodeJS. For more information on the responses you can check the Fanart.tv API documentation here.
Usage
Setup
npm install --save fanart.tv-api
Initialize
const FanartTvApi = require('fanart.tv-api')
// Create a new instance of the module.
const fanart = new FanartTvApi({
apiKey, // Your fanart.tv API key.
baseUrl // The base url of fanart.tv. Defaults to 'https://webservice.fanart.tv/v3/'.
})
Example usage
- fanart.getMovieImages(movieId)
- fanart.getLatestMoviesImages()
- fanart.getShowImages(tvId)
- fanart.getLatestShowsImages()
- fanart.getArtistImages(artistId)
- fanart.getAlbumImages(albumId)
- fanart.getLabelImages(labelId)
- fanart.getLatestArtistsImages()
Testing
You can run tests with the following npm command:
$ FANART_KEY=[YOUR API KEY HERE] npm test
License
MIT License
Copyright (c) 2017 - fanart.tv-api - Released under the MIT license.
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.