Socket
Socket
Sign inDemoInstall

node-mdbapi

Package Overview
Dependencies
24
Maintainers
1
Versions
5
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    node-mdbapi

A Node.JS wrapper for The Movie DB API.


Version published
Weekly downloads
8
increased by60%
Maintainers
1
Install size
472 kB
Created
Weekly downloads
 

Readme

Source

A Node.JS wrapper for The Movie DB API.

install size npm npm GitHub last commit

Highlights

Install

yarn add node-mdbapi

or

npm install node-mdbapi

Usage

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

(async () => {
  try {
    const args = {
      pathParameters: {
        movie_id: 384018,
      },
    };
    const movie = await mdb.movies.getDetails(args);
    console.log(movie);
    /*
      {
        data: Object. Parsed json data of response
        header: Object. Headers of response
        rateLimit: {
          limit: Number. Total limit for requests
          remaining: Number. How much request remaining
          reset: Number. Time to refresh rate limit
        }
      }
    */
  } catch (error) {
    console.error(error);
  }
})();

Common Usage of Methods

const args = {
  pathParameters: {
    // path parameters for query, i.e. movie_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

Throws when expired rate limit

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

Keywords

FAQs

Last updated on 12 Aug 2019

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc