Extends

• BaseClient

Methods

static getInstance(apiKey) → {OMDBAPIClient}

clients/omdb.client.js, line 22

Get omdb client instance.

Parameters:

Name	Type	Description
apiKey	string	The omdb api key

Returns:

OMDBAPIClient

get(options) → {Promise}

clients/omdb.client.js, line 54

Get a media(movie/series) by looking up using different params (e.g. title, imdb id, year etc.)

Parameters:

Name	Type	Description
options	object	The options based on which the movie will be fetched.

Returns:

Promise

Overrides:

• BaseClient#get

Examples

get({title: 'Saw', year: 2004, plot: 'short', format: 'xml', type: 'movie'})

get({imdbID: 'tt12444'})

getByIMDBId(imdbID) → {Promise}

clients/omdb.client.js, line 114

Get a media(movie/series) by IMDB ID

Parameters:

Name	Type	Description
imdbID	string	IMDB ID of the media

Returns:

Promise

getByTitleAndYear(title, year, typeopt) → {Promise}

clients/omdb.client.js, line 103

Get a media(movie/series) by title and year

Parameters:

Name	Type	Attributes	Default	Description
title	string			Title of the media (movie/series)
year	number			The year media type(movie/series) was released (Optional).
type	string	<optional>	'movie'	Type of the media; movie/series (Optional).

Returns:

Promise

search(options) → {Promise}

clients/omdb.client.js, line 80

Search for a movie/series.

Parameters:

Name	Type	Description
options	object	The options based on which the search will be conducted.

Returns:

Promise

Overrides:

• BaseClient#search

Example

search({query: 'Saw', year: 2004, format: 'xml', type: 'movie'})