Unleash awesomeness. Private packages, team management tools, and powerful integrations. Get started with npm Orgs »

movie-art

2.0.3 • Public • Published

movie-art npm version Build Status Try movie-art on RunKit

Get a movie (or TV-series) poster and backdrop image url: "Crash" ➔ http://path/to/crash.jpg

movie-art

Try it on RunKit (Output)

Features

  • Use anywhere, browser or Node - UMD (Browser Support)
  • Promise and Callback API
  • Fetch images for movies or television
  • Poster or backdrop photos

Install

Using NPM:

$ npm install -g movie-art

In the browser:

<!-- movieArt window global -->
<script type="text/javascript" src="https://unpkg.com/movie-art"></script>

(via Unpkg, or via JSDelivr)

Usage

const movieArt = require('movie-art')
 
movieArt('Oceans Eleven').then(console.log)
Callback
movieArt('Oceans Eleven', (error, response) => {
    console.log(response)
    //=> http://path/to/oceans_eleven.jpg
})
Usage with size and year options
movieArt('Oceans Eleven', {year: '1960', size: 'w92'})
  .then( response => console.log(response) )
 
//=> http://path/to/oceans_eleven_poster_1960_small.jpg
Usage with backdrop and poster (landscape and portrait)
movieArt('Oceans Eleven', {output: 'all'})
  .then( console.log )
 
//=> {
  poster: http://path/to/oceans_eleven_poster.jpg,
  backdrop: http://path/to/oceans_eleven_backdrop.jpg,
}
Query television art
movieArt('Star Trek: The Original Series', {type: 'tv', output: 'all'})
  .then( response => console.log(response.poster) )
 
//=> http://path/to/star_trek_the_original_series_poster.jpg

API

movieArt(search [, options] [, callback])

Accepts a movie or television show title (string) as input. Returns a Promise which resolves to a string URL.

search

Required
Type: string

Movie to search for.

callback(error, response)

Function to be called when complete or on error.

Options

A JavaScript object with the following properties:

year

Type: string

Optional movie year.

size

Type: string

Requested poster size. possible values: w92, w154, w185, w342, w500, w780, original

type

Type: string

The type of request: either tv or movie. Defaults to movie. possible values: tv, movie

output

Type: boolean

backdrop returns a wider, backdrop output backdrop. all returns an object like {poster:..., backdrop: ...} Default: poster possible values: poster, backdrop, all

CLI Usage

$ movie-art --help

Usage
  $ movie-art movie [year] [size] [type] [output]

Options
  --year,        -y  Release date year
  --size,        -s  Possible values: [w92, w154, w185, w342, w500, w780, original]
  --type,        -t  Possible values: [tv, movie] 
  --output, -o  Possible values: [poster, backdrop, all]

Example
  $ movie-art 'Oceans Eleven' --year 1960  --size w92
  //=> http://path/to/oceans_eleven_poster_1960_small.jpg

Related

License

This package uses data from TMDB. You may consult TMDB terms of service for usage rights.

MIT © Lacy Morrow

install

npm i movie-art

Downloadsweekly downloads

15

version

2.0.3

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability