Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

js-omdb-api

koenvg16ISC0.3.0TypeScript support: included

omdbapi library for javascript

omdbapi

readme

omdbapi for the browser

This is a small javascript library for the omdbapi.
It is ment to be used in the browser. It can be used in nodejs as well but then you will need to adjust the fetch package.

features

  • Typescript support
  • Promise api

Installation

npm install --save js-omdb-api

Usage

Find a show by imdb ID

import { findById } from "js-omdb-api";

findById("tt0944947", {
  contentType: '',                // "movie" | "series" | "episode"
  year: '',                       // string
  plot: '',                       // string
  includeTomatoesRating: true,    // boolean
}).then((result) => {
  console.log(result);
}).catch((error) => {
  console.log(error);
}));

Find a show by imdb ID and get all season information

import { findByIdWithSeasons } from "js-omdb-api";

findByIdWithSeasons("tt0944947")
  .then(result => {
    console.log(result.seasons[0].episodes);
  });

Find a show by title

import { findByTitle } from "js-omdb-api";

findByTitle("Game of Thrones", {
  contentType: '',                // "movie" | "series" | "episode"
  year: '',                       // string
  plot: '',                       // string
  includeTomatoesRating: true,    // boolean
}).then((result) => {
  console.log(result);
}).catch((error) => {
  console.log(error);
}));
import { search } from "js-omdb-api";

search("Thrones", {
  contentType: '',                // "movie" | "series" | "episode"
  year: '',                       // string
  page: 1                         // number
}).then((result) => {
  console.log(result);
}).catch((error) => {
  console.log(error);
}));