Module "imdb"

Index

Classes

Interfaces

Type aliases

RequestType

Functions

Type aliases

RequestType

RequestType: "movie" | "series" | "episode" | "game"

Type of media we're searching for

Functions

get

get(req: MovieRequest, opts: MovieOpts): Promise<Movie>

- Defined in imdb.ts:640
Fetches a single movie by arbitrary criteria

Parameters
- req: MovieRequest
  
  set of requirements to search for
- opts: MovieOpts
  
  options that modify a search
Returns Promise<Movie>

a promise yielding a movie

isRequestType

isRequestType(reqtype: string): reqtype is RequestType

- Defined in imdb.ts:90
Parameters
- reqtype: string
Returns reqtype is RequestType

search

search(req: SearchRequest, opts: MovieOpts, page?: undefined | number): Promise<SearchResults>

- Defined in imdb.ts:657
Searches for a movie by arbitrary criteria

Parameters
- req: SearchRequest
  
  set of requirements to search for
- opts: MovieOpts
  
  options that modify a search
- Optional page: undefined | number
  
  page number to return
Returns Promise<SearchResults>

a promise yielding search results

Generated using TypeDoc