1.0.2 • Published 5 years ago

node-mdbapi v1.0.2

Weekly downloads
4
License
MIT
Repository
github
Last release
5 years ago

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
tmdbtmdb apimoviedbthe moviedbthe movie database
got
@infinitebrahmanuniverse/nolb-node-m@everything-registry/sub-chunk-2306
1.0.2

5 years ago

1.0.1

5 years ago

1.0.0

5 years ago

0.1.1

5 years ago

0.1.0

5 years ago