Code Monkey home page Code Monkey logo

node-themoviedb's Introduction

A Node.JS wrapper for The Movie DB API.

install size npm npm GitHub last commit

Highlights

Install

yarn add node-themoviedb

or

npm install node-themoviedb

Usage

const MovieDB = require('node-themoviedb');
// ES6 Style
// import MovieDB from 'node-themoviedb';
const mdb = new MovieDB(/* Your API Key */, options);

(async () => {
  try {
    const args = {
      pathParameters: {
        movie_id: 384018,
      },
    };
    const movie = await mdb.movie.getDetails(args);
    console.log(movie);
    /*
      {
        data: Object. Parsed json data of response
        headers: Object. Headers of response
      }
    */
  } catch (error) {
    console.error(error);
  }
})();

Common Usage of Methods

const args = {
  pathParameters: {
    // path parameters for query, i.e. tv_id
  },
  query: {
    // query string, i.e. session_id
    // NOTE: api_key and language will be added to query by default, don't need specify these values
  },
  body: {
    // data for request body
  },
};
const response = await mdb.tv.getVideos(args);
// Or nested methods
// const response = await mdb.tv.episode.rateTVEpisode(args);

API

constructor(apiKey[, options])

apiKey

Your API key. How to get API key

options

  • language - Optional. Default is 'en-US'

Additional options, which will be override the default settings

setApiKey(apiKey)

Sets API key

apiKey

Your API key

setLanguage(language)

Sets language for data of response

language

Language in ISO 639-1 format. I.e. 'en-US'

Methods

Errors

All errors extends Node's Error

BadRequest

Throws when server responses with http status code 400

  • code - Number. Usually to 0
  • errorCode - Number. Equals to 400

UnauthorizedError

Throws when set invalid api key

  • code - Number. Usually equals to 7
  • errorCode - Number. Equals to 401

NotFoundError

Throws when requested resource couldn't be found

  • code - Number. Usually equals to 34
  • errorCode - Number. Equals to 404

RequestTimeout

Throws when request timed out

  • code - Number. Usually equals to 0
  • errorCode - Number. Equals to 408

TooManyRequests (deprecated)

Throws when expired rate limit

  • code - Number. Usually equals to 0
  • errorCode - Number. Equals to 429

node-themoviedb's People

Contributors

andywampir avatar dnicolson avatar luckspt avatar rogerkerse avatar tserhii-gh avatar

Stargazers

avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.