Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface MovieRequest

An explicit request for a movie. Does not do searching, this is meant to specify one movie.

One of name or id MUST be requested. year can be used to ensure that the movie you're looking for is selected in the case that there exists more than one movie with the same name.

short_plot can be used to specify whether or not a short or a long plot description is returned with your movie. Default is to return a full plot.

Hierarchy

  • MovieRequest

Index

Properties

Properties

Optional id

id: undefined | string

imdb id of the movie

Optional name

name: undefined | string

Name of the movie

Unfortunately, only English names are supported by omdb at the moment.

Optional short_plot

short_plot: undefined | false | true

Whether or not to request a short plot. Default is full plot.

Optional year

year: undefined | number

Year that the movie was released

Generated using TypeDoc