omdb
A simple Node.JS module to access and normalize data from the OMDb API by Bryan Fritz.
Installation
$ npm install rcb-omdb
Examples
var omdb = ; omdb; omdb;
API
omdb.search(terms, callback)
Run a search request on the API.
terms
can either be a string of search terms, or the following object:
terms: String // `s` can also be used year: Number // optional (`y` can also be used) type: 'series' || 'movie' || 'episode' // optional
callback
returns an array of movies. If no movies are found, the array
is empty. The array will contain objects of the following:
title: String // the title of the movie type: 'series' || 'movie' || 'episode' // If `type` is "series": year: from: Number to: Number || undefined // (if the series is still airing) // Otherwise, year: Number imdb: String
omdb.get(show, [options], callback)
Run a single movie request on the API.
show
is assumed to be one of the following, respectively:
-
An object with an
imdb
property.{ imdb: 'tt0387564' }
-
An object with a
title
property.{ title: 'Saw' }
-
An object with both a
title
and ayear
property.{ title: 'Saw', year: 2004 }
-
An IMDb ID string.
'tt0387564'
-
A title string.
'Saw'
Additionally, options
object can be passed with the following parameters:
fullPlot
is an optional argument that if set totrue
, will attempt to request the extended version of the movie's plot.tomatoes
is an optional argument that if set totrue
, will attempt to request the Rotten Tomatoes rating info.
Backwards compatibility is ensured so that if options
is not an object but is non-empty, assume fullPlot: true
.
callback
returns an object of the movie's information. If no movies are
found, it will return null
.
See the following for a list of possible properties: https://github.com/misterhat/omdb/blob/master/index.js#L154
omdb.poster(show)
Return a readable stream of the poster JPEG.
show
is the same as the show
argument used in .get()
.
License
MIT