omdb-wrapper

Spotify Wrapper

A wrapper to work with the OMDb Web API.

Browser Support

This library relies on Fetch API. And this API is supported in the following browsers.

39+ ✔	42+ ✔	29+ ✔	10.1+ ✔	Nope ✘

Dependencies

This library depends on fetch to make requests to the OMDb Web API. For environments that don't support fetch, you'll need to provide a polyfill to browser or polyfill to Node.

Installation

$ npm install omdb-wrapper --save

How to use

ES6

// to import a specific method
import OMDb from 'omdb-wrapper';


// using  method
OMDb.search.movies('harry+potter');

CommonJS

const omdbWrapper = require('omdb-wrapper').default;

const omdb = new omdbWrapper({
  apiKEY: 'YOUR_API_KEY_HERE'
});

UMD in Browser

<!-- to import non-minified version -->
<script src="omdb-wrapper.umd.js"></script>

<!-- to import minified version -->
<script src="omdb-wrapper.umd.min.js"></script>

After that the library will be available to the Global as OmdbWrapper. Follow an example:

const omdb = new omdbWrapper({
  apiKEY: 'YOUR_API_KEY_HERE'
});

const movies = omdb.search.movies('choosen movie');

Methods

Follow the methods that the library provides.

search.movies(query)

Search for informations about Movies with provided query. Test in OMDb Web.

Arguments

Argument	Type	Options
query	string	'Any search query'

Example

omdb.search.movies('harry+potter')
  .then(data => {
    // do what you want with the data
  })

movie.getMovie(id)

Search for informations about a specific Movie with provided id. Test in OMDb Web.

Arguments

Argument	Type	Options
id	string	'Specific id'

Example

omdb.movie.getMovie('tt1201607')
  .then(data => {
    // do what you want with the data
  })

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

Matheus Roversi

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details