FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

code2labgit/popcorn-sdk: SDK for Popcorn Time applications making it easier to retrieve movies / shows with metadata · GitHub

 
 

Latest commit

 

History

31 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Popcorn SDK

SDK for Popcorn Time applications making it easier to retrieve movies / shows with meta data

Installation

$ npm install --save popcorn-sdk

Examples

import SDK from 'popcorn-sdk'

const movies = await SDK.getMovies()
const movie = await SDK.getMovie({ ids: { imdb: '' } })

const shows = await SDK.getShows()
const show = await SDK.getShow({ ids: { imdb: '', tmdb: '' }}) // One of the two, imdb is preferred

// Or for slower internet connections you can partial load a show
const showBasic = await SDK.getBasicShow(imdbId)

// getShowMeta retrieves data from The Movie DB for better episode info and season / episode images
// Basically runs getShowIds and getShowSeasonsMeta
const showWithMeta = await SDK.getShowMeta(showBasic) 

// To only retrieve the ids for a show
const showWithIds = await SDK.getShowIds({ids: { imdb: '', tmdb: '' }})

// To only retrieve the seasons meta
const showWithSeasons = await SDK.getShowSeasonsMeta(showBasic)

// To retrieve recommendations for a certain show
const recommendations = await SDK.getShowRecommendations({ ids: { tmdb: '' } })

Adapters

You can add adapters handy for if you want to add attributes to movies / shows

import SDK from 'popcorn-sdk'
import DefaultAdapter from 'popcorn-sdk/Adapter'

class MyAdapter extends DefaultAdapter {

  /**
   * Get's called after the movies are fetched and before they are returned
   * 
   * @param movies
   * @returns {*}
   */
  checkMovies = movies => movies

  /**
   * Get's called after the movie is fetched and before they it is returned
   *
   * @param movie
   * @returns {*}
   */
  checkMovie = movie => movie

  /**
   * Get's called after the shows are fetched and before they are returned
   *
   * @param shows
   * @returns {*}
   */
  checkShows = shows => shows

  /**
   * Get's called after the show is fetched and before they it is returned
   *
   * @param show
   * @returns {*}
   */
  checkShow = show => show
}

SDK.addAdapter(new MyAdapter())

Movie output

// TODO

Show output

// TODO

This project is MIT licensed.

Collaboration

If you have questions or issues, please open an issue!

About

SDK for Popcorn Time applications making it easier to retrieve movies / shows with metadata

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages


Back | FazBrowse Home | New Git URL